ZD ReferralRequest
Resources conforming to this profile are sent by ZorgDomein as part of a Bundle that is sent to deliver a FHIR document to the information system of the referrer or care provider.
The canonical URL for this profile is:
http://zorgdomein.nl/fhir/StructureDefinition/zd-referralrequest
This profile builds on ReferralRequest.
ReferralRequest | S | 0..* | ReferralRequest |
There are no (further) constraints on this element Element Id
ReferralRequest A request for referral or transfer of care Alternate namesReferralRequest TransferOfCare Request DefinitionUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
|
extension | 0..* | Extension | Element Id
ReferralRequest.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
|
preferredspecialist | 0..1 | Extension(string) | Element Id
ReferralRequest.extension:preferredspecialist The preferred specialist that was specified in the request Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://zorgdomein.nl/fhir/StructureDefinition/zd-preferredspecialist Constraints
|
|
supplyelement | 1..* | Extension(CodeableConcept) | Element Id
ReferralRequest.extension:supplyelement ZorgDomein supply element belonging to the healthcare product Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://zorgdomein.nl/fhir/StructureDefinition/zd-supplyelement Constraints
|
|
cluster | 1..1 | Extension(CodeableConcept) | Element Id
ReferralRequest.extension:cluster ZorgDomein cluster to which the healthcare product belongs Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. http://zorgdomein.nl/fhir/StructureDefinition/zd-cluster Constraints
|
|
identifier | S Σ | 1..* | Identifier |
There are no (further) constraints on this element Element Id
ReferralRequest.identifier Business identifier DefinitionBusiness identifier that uniquely identifies the referral/care transfer request instance.
|
use | Σ ?! | 0..1 | codeBinding |
There are no (further) constraints on this element Element Id
ReferralRequest.identifier.use usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
|
type | Σ | 0..1 | CodeableConceptBinding |
There are no (further) constraints on this element Element Id
ReferralRequest.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Identifier Type Codes (extensible) Constraints
|
system | Σ | 1..1 | uriFixed Value | Element Id
ReferralRequest.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier
http://zorgdomein.nl/zdnumber/
|
value | Σ | 1..1 | string | Element Id
ReferralRequest.identifier.value The ZD Number corresponding to this document DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
General
123456 Mappings
|
period | Σ | 0..1 | Period |
There are no (further) constraints on this element Element Id
ReferralRequest.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.
|
assigner | Σ | 0..1 | Reference(Organization) |
There are no (further) constraints on this element Element Id
ReferralRequest.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) |
There are no (further) constraints on this element Element Id
ReferralRequest.definition Instantiates protocol or definition DefinitionA protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ActivityDefinition | PlanDefinition) Constraints
|
basedOn | Σ | 0..* | Reference(ReferralRequest | CarePlan | ProcedureRequest) |
There are no (further) constraints on this element Element Id
ReferralRequest.basedOn Request fulfilled by this request Alternate namesfulfills DefinitionIndicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(ReferralRequest | CarePlan | ProcedureRequest) Constraints
|
replaces | Σ | 0..* | Reference(ReferralRequest) |
There are no (further) constraints on this element Element Id
ReferralRequest.replaces Request(s) replaced by this request Alternate namessupersedes, prior, renewed order DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
|
groupIdentifier | Σ | 0..1 | Identifier |
There are no (further) constraints on this element Element Id
ReferralRequest.groupIdentifier Composite request this is part of Alternate namesgrouperId, requisition DefinitionThe business identifier of the logical "grouping" request/order that this referral is a part of. Allows multiple orders to be collected as part of a single requisition.
|
status | S Σ ?! | 1..1 | codeBinding | Element Id
ReferralRequest.status draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe workflow status of the referral or transfer of care request. Only requested and cancelled will be sent by ZorgDomein Workflow status is handled by the Task resource. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
|
intent | Σ ?! | 1..1 | codeBindingFixed Value | Element Id
ReferralRequest.intent proposal | plan | order Alternate namescategory DefinitionDistinguishes the "level" of authorization/demand implicit in this request. The same resource structure is used when capturing proposals/recommendations, plans and actual requests. Note that FHIR strings may not exceed 1MB in size
plan
|
type | S Σ | 1..1 | CodeableConcept | Element Id
ReferralRequest.type Code and name of healthcareproduct type DefinitionAn indication of the type of referral (or where applicable the type of transfer of care) request. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. SNOMED CT Patient Referral (example) Constraints
|
coding | Σ | 1..1 | Coding | Element Id
ReferralRequest.type.coding Code of healthcareproduct type DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | Σ | 0..1 | uri |
There are no (further) constraints on this element Element Id
ReferralRequest.type.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
version | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.type.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code |
There are no (further) constraints on this element Element Id
ReferralRequest.type.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
display | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.type.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean |
There are no (further) constraints on this element Element Id
ReferralRequest.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | Element Id
ReferralRequest.type.text Name of healthcareproduct type DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
priority | Σ | 1..1 | codeBinding |
There are no (further) constraints on this element Element Id
ReferralRequest.priority Urgency of referral / transfer of care request DefinitionAn indication of the urgency of referral (or where applicable the type of transfer of care) request. Note that FHIR strings may not exceed 1MB in size
|
serviceRequested | S Σ | 1..1 | CodeableConcept | Element Id
ReferralRequest.serviceRequested Code and name of the healthcare product DefinitionThe service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Practice Setting Code Value Set (example) Constraints
|
coding | Σ | 1..1 | Coding |
There are no (further) constraints on this element Element Id
ReferralRequest.serviceRequested.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | Σ | 0..1 | uri |
There are no (further) constraints on this element Element Id
ReferralRequest.serviceRequested.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
version | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.serviceRequested.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code |
There are no (further) constraints on this element Element Id
ReferralRequest.serviceRequested.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
display | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.serviceRequested.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean |
There are no (further) constraints on this element Element Id
ReferralRequest.serviceRequested.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | Element Id
ReferralRequest.serviceRequested.text Plain text representation of the actions requested as part of the referral DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
subject | S Σ | 1..1 | Reference(ZD Patient) | Element Id
ReferralRequest.subject Patient referred to care or transfer DefinitionThe patient who is the subject of a referral or transfer of care request. Referral of family, group or community is to be catered for by profiles.
|
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) |
There are no (further) constraints on this element Element Id
ReferralRequest.context Originating encounter Alternate namesencounter DefinitionThe encounter at which the request for referral or transfer of care is initiated. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Encounter | EpisodeOfCare) Constraints
|
occurrencePeriod | Σ | 0..1 | Period | Element Id
ReferralRequest.occurrence[x]:occurrencePeriod When the service(s) requested in the referral should occur Alternate namestiming DefinitionThe period of time within which the services identified in the referral/transfer of care is specified or required to occur. Use cases: (1) to indicate that the requested service is not to happen before a specified date, and saving the start date in Period.start; (2) to indicate that the requested service must happen before a specified date, and saving the end date in Period.end; (3) to indicate that the requested service must happen during the specified dates ("start" and "end" values). When the occurrenceDateTime is used, then it is indicating that the requested service must happen before the specified date.
|
start | Σ | 0..1 | dateTime | Element Id
ReferralRequest.occurrence[x]:occurrencePeriod.start Transaction date plus access time in days DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known.
|
end | Σ | 0..1 | dateTime |
There are no (further) constraints on this element Element Id
ReferralRequest.occurrence[x]:occurrencePeriod.end End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.
|
authoredOn | S Σ | 1..1 | dateTime |
There are no (further) constraints on this element Element Id
ReferralRequest.authoredOn Date of creation/activation Alternate namescreatedOn DefinitionDate/DateTime of creation for draft requests and date of activation for active requests.
|
requester | S Σ | 1..1 | BackboneElement |
There are no (further) constraints on this element Element Id
ReferralRequest.requester Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation.
|
agent | S Σ | 1..1 | Reference(ZD Practitioner) | Element Id
ReferralRequest.requester.agent Responsible practitioner DefinitionThe device, practitioner, etc. who initiated the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
onBehalfOf | S Σ | 1..1 | Reference(ZD Organization) | Element Id
ReferralRequest.requester.onBehalfOf Organization agent is acting for DefinitionThe organization the device or practitioner was acting on behalf of. Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
specialty | 0..1 | CodeableConcept |
There are no (further) constraints on this element Element Id
ReferralRequest.specialty The clinical specialty (discipline) that the referral is requested for DefinitionIndication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. PractitionerSpecialty (example) Constraints
|
|
recipient | S Σ | 0..* | Reference(ZD Organization) | Element Id
ReferralRequest.recipient Receiver of referral / transfer of care request DefinitionThe healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request. There will be a primary receiver. But the request can be received by any number of "copied to" providers or organizations.
|
reasonCode | S Σ | 0..* | CodeableConcept | Element Id
ReferralRequest.reasonCode Code and full path of the healthcare request menu item DefinitionDescription of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. SNOMED CT Clinical Findings (example) Constraints
|
coding | Σ | 0..* | Coding | Element Id
ReferralRequest.reasonCode.coding Reason code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | Σ | 0..1 | uri |
There are no (further) constraints on this element Element Id
ReferralRequest.reasonCode.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
|
version | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.reasonCode.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 1..1 | code |
There are no (further) constraints on this element Element Id
ReferralRequest.reasonCode.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size
|
display | Σ | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.reasonCode.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean |
There are no (further) constraints on this element Element Id
ReferralRequest.reasonCode.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | Element Id
ReferralRequest.reasonCode.text Plain text representation of the reason code DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
reasonReference | Σ | 0..* | Reference(Condition | Observation) |
There are no (further) constraints on this element Element Id
ReferralRequest.reasonReference Why is service needed? DefinitionIndicates another resource whose existence justifies this request. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation) Constraints
|
description | 0..1 | string |
There are no (further) constraints on this element Element Id
ReferralRequest.description A textual description of the referral DefinitionThe reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary. Note that FHIR strings may not exceed 1MB in size
|
|
supportingInfo | 0..* | Reference(Resource) |
There are no (further) constraints on this element Element Id
ReferralRequest.supportingInfo Additonal information to support referral or transfer of care request DefinitionAny additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
|
note | 0..* | Annotation |
There are no (further) constraints on this element Element Id
ReferralRequest.note Comments made about referral request DefinitionComments made about the referral request by any of the participants. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
|
relevantHistory | 0..* | Reference(Provenance) |
There are no (further) constraints on this element Element Id
ReferralRequest.relevantHistory Key events in history of request Alternate nameseventHistory DefinitionLinks to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource. This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
|
See the profile on simplifier.net for additional details.
Resource example
Below you find an example of a ReferralRequest resource that conforms to the ZD ReferralRequest profile.
{
"resourceType": "ReferralRequest",
"id": "zd-referralrequest-1",
"meta": {
"profile": [
"http://zorgdomein.nl/fhir/StructureDefinition/zd-referralrequest"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">ZD23456789</div>"
},
"extension": [
{
"url": "http://zorgdomein.nl/fhir/StructureDefinition/zd-supplyelement",
"valueCodeableConcept": {
"coding": [
{
"display": "Consult Fysiotherapeut"
}
]
}
},
{
"url": "http://zorgdomein.nl/fhir/StructureDefinition/zd-preferredspecialist",
"valueString": "specialist Jansen"
},
{
"url": "http://zorgdomein.nl/fhir/StructureDefinition/zd-cluster",
"valueCodeableConcept": {
"coding": [
{
"code": "FYS",
"display": "Fysiotherapie"
}
]
}
}
],
"identifier": [
{
"system": "http://zorgdomein.nl/zdnumber/",
"value": "ZD23456789"
}
],
"status": "active",
"intent": "plan",
"type": {
"coding": [
{
"code": "REG",
"display": "Regulier"
}
]
},
"priority": "routine",
"serviceRequested": [
{
"coding": [
{
"code": "FYSREG300",
"display": "Consult Fysiotherapeut"
}
]
}
],
"subject": {
"reference": "Patient/zd-patient-1",
"display": "K. Aelbrinck-de Jager"
},
"occurrencePeriod": {
"start": "2017-04-26T00:00:00+02:00"
},
"authoredOn": "2017-04-12T16:13:03+02:00",
"requester": {
"agent": {
"reference": "Practitioner/zd-practitioner-1",
"display": "H. de Vries"
},
"onBehalfOf": {
"reference": "Organization/zd-organization-1",
"display": "Testpraktijk-1"
}
},
"recipient": [
{
"reference": "Organization/zd-organization-2",
"display": "Voorbeeldziekenhuis ZorgDomein"
}
],
"reasonCode": [
{
"coding": [
{
"code": "PAZFOT",
"display": "Paramedische zorg > Fysio- en oefentherapie"
}
]
}
]
}
<ReferralRequest xmlns='http://hl7.org/fhir'>
<id value='zd-referralrequest-1'/>
<meta>
<profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-referralrequest'/>
</meta>
<text>
<status value='generated'/>
<div xmlns='http://www.w3.org/1999/xhtml'>ZD23456789</div>
</text>
<extension url='http://zorgdomein.nl/fhir/StructureDefinition/zd-supplyelement'>
<valueCodeableConcept>
<coding>
<display value='Consult Fysiotherapeut'/>
</coding>
</valueCodeableConcept>
</extension>
<extension url='http://zorgdomein.nl/fhir/StructureDefinition/zd-preferredspecialist'>
<valueString value='specialist Jansen'/>
</extension>
<extension url='http://zorgdomein.nl/fhir/StructureDefinition/zd-cluster'>
<valueCodeableConcept>
<coding>
<code value='FYS'/>
<display value='Fysiotherapie'/>
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system value='http://zorgdomein.nl/zdnumber/'/>
<value value='ZD23456789'/>
</identifier>
<status value='active'/>
<intent value='plan'/>
<type>
<coding>
<code value='REG'/>
<display value='Regulier'/>
</coding>
</type>
<priority value='routine'/>
<serviceRequested>
<coding>
<code value='FYSREG300'/>
<display value='Consult Fysiotherapeut'/>
</coding>
</serviceRequested>
<subject>
<reference value='Patient/zd-patient-1'/>
<display value='K. Aelbrinck-de Jager'/>
</subject>
<occurrencePeriod>
<start value='2017-04-26T00:00:00+02:00'/>
</occurrencePeriod>
<authoredOn value='2017-04-12T16:13:03+02:00'/>
<requester>
<agent>
<reference value='Practitioner/zd-practitioner-1'/>
<display value='H. de Vries'/>
</agent>
<onBehalfOf>
<reference value='Organization/zd-organization-1'/>
<display value='Testpraktijk-1'/>
</onBehalfOf>
</requester>
<recipient>
<reference value='Organization/zd-organization-2'/>
<display value='Voorbeeldziekenhuis ZorgDomein'/>
</recipient>
<reasonCode>
<coding>
<code value='PAZFOT'/>
<display value='Paramedische zorg > Fysio- en oefentherapie'/>
</coding>
</reasonCode>
</ReferralRequest>