Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-ServiceRequest-for-ReferralRequest | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_ServiceRequest_R3_ReferralRequest | ||
This cross-version profile allows R5 ServiceRequest content to be represented via FHIR STU3 ReferralRequest resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| ReferralRequest.status | Base | required | RequestStatus | 📍3.0.2 | FHIR Std. |
| ReferralRequest.intent | Base | required | RequestIntent | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ReferralRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ReferralRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ReferralRequest
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ReferralRequest |
0..* | ReferralRequest | A request for referral or transfer of care | |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:instantiatesUri |
0..* | uri | R5: Instantiates external protocol or definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesUri | |
| extension:code |
0..1 | Reference(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3(0.1.0) | ActivityDefinition | Cross-version Profile for R5.PlanDefinition for use in FHIR STU3(0.1.0) | PlanDefinition) | R5: What is being requested/ordered additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.code | |
| extension:quantity |
0..1 | Quantity, Ratio, Range | R5: Service amount (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.quantity | |
| extension:focus |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) | R5: What the service request is about, when it is not about the subject of record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.focus | |
| extension:location |
0..* | (Complex) | R5: Requested location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.location | |
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason | |
| extension:insurance |
0..* | Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3(0.1.0) | Coverage | Cross-version Profile for R5.ClaimResponse for use in FHIR STU3(0.1.0) | ClaimResponse) | R5: Associated insurance coverage (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.insurance | |
| extension:bodyStructure |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure]] | R5: BodyStructure-based location on the body (new) URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |
 extension:patientInstruction |
0..* | (Complex) | R5: Patient or consumer-oriented instructions (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction | |
 definition |
||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:instantiatesCanonical |
0..* | uri | R5: Instantiates FHIR protocol or definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesCanonical | |
| basedOn |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:basedOn |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request fulfills URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| replaces |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:replaces |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| intent |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:intent |
0..1 | code | R5: proposal | plan | directive | order + URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.intent Binding: RequestIntent (required): The kind of service request. | |
| serviceRequested |
||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:parameterFocus |
0..1 | (Complex) | R5: The context of the order details by reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameterFocus | |
| extension:parameter |
1..* | (Complex) | R5: The parameter details for the service being requested (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameter | |
| subject |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Individual or Entity the service is ordered for URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| context |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:encounter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Encounter in which the request was created additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| recipient |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:performer |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Requested performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| supportingInfo |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:supportingInfo |
0..* | CodeableConcept | R5: Additional clinical information additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |
| relevantHistory |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:relevantHistory |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Request provenance additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ReferralRequest |
0..* | ReferralRequest | A request for referral or transfer of care | |||||
  id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages  (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesUri |
0..* | uri | R5: Instantiates external protocol or definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesUri | |||||
| extension:code |
0..1 | Reference(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3(0.1.0) | ActivityDefinition | Cross-version Profile for R5.PlanDefinition for use in FHIR STU3(0.1.0) | PlanDefinition) | R5: What is being requested/ordered additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.code | |||||
| extension:quantity |
0..1 | Quantity, Ratio, Range | R5: Service amount (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.quantity | |||||
| extension:focus |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) | R5: What the service request is about, when it is not about the subject of record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.focus | |||||
| extension:location |
0..* | (Complex) | R5: Requested location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.location | |||||
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason | |||||
| extension:insurance |
0..* | Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3(0.1.0) | Coverage | Cross-version Profile for R5.ClaimResponse for use in FHIR STU3(0.1.0) | ClaimResponse) | R5: Associated insurance coverage (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.insurance | |||||
| extension:bodyStructure |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure]] | R5: BodyStructure-based location on the body (new) URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||
| extension:patientInstruction |
0..* | (Complex) | R5: Patient or consumer-oriented instructions (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
 definition |
Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | Instantiates protocol or definition | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesCanonical |
0..* | uri | R5: Instantiates FHIR protocol or definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesCanonical | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
 display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| basedOn |
Σ | 0..* | Reference(ReferralRequest | CarePlan | ProcedureRequest) | Request fulfilled by this request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:basedOn |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request fulfills URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(ReferralRequest) | Request(s) replaced by this request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:replaces |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
| status |
?!Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the referral. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:intent |
0..1 | code | R5: proposal | plan | directive | order + URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.intent Binding: RequestIntent (required): The kind of service request. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| type |
Σ | 0..1 | CodeableConcept | Referral/Transition of care request type Binding: SNOMED CT Patient Referral (example): Codes for types of referral; e.g. consult, transfer, temporary transfer. | ||||
| priority |
Σ | 0..1 | code | Urgency of referral / transfer of care request Binding: RequestPriority (required): Codes indicating the relative priority of the referral. | ||||
| serviceRequested |
Σ | 0..* | CodeableConcept | Actions requested as part of the referral Binding: Practice Setting Code Value Set (example): Codes indicating the types of services that might be requested as part of a referral. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:parameterFocus |
0..1 | (Complex) | R5: The context of the order details by reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameterFocus | |||||
| extension:parameter |
1..* | (Complex) | R5: The parameter details for the service being requested (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameter | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Patient referred to care or transfer | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Individual or Entity the service is ordered for URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| context |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Originating encounter | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:encounter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Encounter in which the request was created additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
 occurrence[x] |
Σ | 0..1 | When the service(s) requested in the referral should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date of creation/activation | ||||
| requester |
ΣC | 0..1 | BackboneElement | Who/what is requesting service Constraints: rfr-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| agent |
Σ | 1..1 | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) | Individual making the request | ||||
| onBehalfOf |
ΣC | 0..1 | Reference(Organization) | Organization agent is acting for | ||||
| specialty |
0..1 | CodeableConcept | The clinical specialty (discipline) that the referral is requested for Binding: PractitionerSpecialty (example): Codes indicating the types of capability the referred to service provider must have. | |||||
| recipient |
Σ | 0..* | Reference(Practitioner | Organization | HealthcareService) | Receiver of referral / transfer of care request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:performer |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Requested performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Reason for referral / transfer of care request Binding: SNOMED CT Clinical Findings (example): Codes indicating why the referral is being requested. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation) | Why is service needed? | ||||
| description |
0..1 | string | A textual description of the referral | |||||
| supportingInfo |
0..* | Reference(Resource) | Additonal information to support referral or transfer of care request | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:supportingInfo |
0..* | CodeableConcept | R5: Additional clinical information additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Comments made about referral request | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of request | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:relevantHistory |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Request provenance additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ReferralRequest.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| ReferralRequest.status | Base | required | RequestStatus | 📍3.0.2 | FHIR Std. |
| ReferralRequest.intent | Base | required | RequestIntent | 📍3.0.2 | FHIR Std. |
| ReferralRequest.type | Base | example | SNOMED CT Patient Referral | 📍3.0.2 | FHIR Std. |
| ReferralRequest.priority | Base | required | RequestPriority | 📍3.0.2 | FHIR Std. |
| ReferralRequest.serviceRequested | Base | example | Practice Setting Code Value Set | 📍20091109 | FHIR Std. |
| ReferralRequest.specialty | Base | example | PractitionerSpecialty | 📍3.0.2 | FHIR Std. |
| ReferralRequest.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ReferralRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ReferralRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| rfr-1 | error | ReferralRequest.requester | onBehalfOf can only be specified if agent is practitioner or device |
(agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()
|
This structure is derived from ReferralRequest
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| ReferralRequest.status | Base | required | RequestStatus | 📍3.0.2 | FHIR Std. |
| ReferralRequest.intent | Base | required | RequestIntent | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ReferralRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ReferralRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ReferralRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ReferralRequest |
0..* | ReferralRequest | A request for referral or transfer of care | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:instantiatesUri |
0..* | uri | R5: Instantiates external protocol or definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesUri | |
| extension:code |
0..1 | Reference(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3(0.1.0) | ActivityDefinition | Cross-version Profile for R5.PlanDefinition for use in FHIR STU3(0.1.0) | PlanDefinition) | R5: What is being requested/ordered additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.code | |
| extension:quantity |
0..1 | Quantity, Ratio, Range | R5: Service amount (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.quantity | |
| extension:focus |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) | R5: What the service request is about, when it is not about the subject of record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.focus | |
| extension:location |
0..* | (Complex) | R5: Requested location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.location | |
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason | |
| extension:insurance |
0..* | Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3(0.1.0) | Coverage | Cross-version Profile for R5.ClaimResponse for use in FHIR STU3(0.1.0) | ClaimResponse) | R5: Associated insurance coverage (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.insurance | |
| extension:bodyStructure |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure]] | R5: BodyStructure-based location on the body (new) URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |
| extension:patientInstruction |
0..* | (Complex) | R5: Patient or consumer-oriented instructions (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction | |
| definition |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:instantiatesCanonical |
0..* | uri | R5: Instantiates FHIR protocol or definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesCanonical | |
| basedOn |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:basedOn |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request fulfills URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| replaces |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:replaces |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| intent |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:intent |
0..1 | code | R5: proposal | plan | directive | order + URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.intent Binding: RequestIntent (required): The kind of service request. | |
| serviceRequested |
||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:parameterFocus |
0..1 | (Complex) | R5: The context of the order details by reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameterFocus | |
| extension:parameter |
1..* | (Complex) | R5: The parameter details for the service being requested (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameter | |
| subject |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Individual or Entity the service is ordered for URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| context |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:encounter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Encounter in which the request was created additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| recipient |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:performer |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Requested performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| supportingInfo |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:supportingInfo |
0..* | CodeableConcept | R5: Additional clinical information additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |
| relevantHistory |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:relevantHistory |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Request provenance additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ReferralRequest |
0..* | ReferralRequest | A request for referral or transfer of care | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesUri |
0..* | uri | R5: Instantiates external protocol or definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesUri | |||||
| extension:code |
0..1 | Reference(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3(0.1.0) | ActivityDefinition | Cross-version Profile for R5.PlanDefinition for use in FHIR STU3(0.1.0) | PlanDefinition) | R5: What is being requested/ordered additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.code | |||||
| extension:quantity |
0..1 | Quantity, Ratio, Range | R5: Service amount (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.quantity | |||||
| extension:focus |
0..* | Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) | R5: What the service request is about, when it is not about the subject of record (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.focus | |||||
| extension:location |
0..* | (Complex) | R5: Requested location (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.location | |||||
| extension:reason |
0..* | (Complex) | R5: Explanation/Justification for procedure or service additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.reason | |||||
| extension:insurance |
0..* | Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3(0.1.0) | Coverage | Cross-version Profile for R5.ClaimResponse for use in FHIR STU3(0.1.0) | ClaimResponse) | R5: Associated insurance coverage (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.insurance | |||||
| extension:bodyStructure |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure]] | R5: BodyStructure-based location on the body (new) URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||
| extension:patientInstruction |
0..* | (Complex) | R5: Patient or consumer-oriented instructions (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| definition |
Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | Instantiates protocol or definition | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:instantiatesCanonical |
0..* | uri | R5: Instantiates FHIR protocol or definition additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.instantiatesCanonical | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| basedOn |
Σ | 0..* | Reference(ReferralRequest | CarePlan | ProcedureRequest) | Request fulfilled by this request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:basedOn |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request fulfills URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(ReferralRequest) | Request(s) replaced by this request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:replaces |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: What request replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
| status |
?!Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the referral. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required): Codes identifying the stage lifecycle stage of a request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:intent |
0..1 | code | R5: proposal | plan | directive | order + URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.intent Binding: RequestIntent (required): The kind of service request. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| type |
Σ | 0..1 | CodeableConcept | Referral/Transition of care request type Binding: SNOMED CT Patient Referral (example): Codes for types of referral; e.g. consult, transfer, temporary transfer. | ||||
| priority |
Σ | 0..1 | code | Urgency of referral / transfer of care request Binding: RequestPriority (required): Codes indicating the relative priority of the referral. | ||||
| serviceRequested |
Σ | 0..* | CodeableConcept | Actions requested as part of the referral Binding: Practice Setting Code Value Set (example): Codes indicating the types of services that might be requested as part of a referral. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:parameterFocus |
0..1 | (Complex) | R5: The context of the order details by reference (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameterFocus | |||||
| extension:parameter |
1..* | (Complex) | R5: The parameter details for the service being requested (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.orderDetail.parameter | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
Σ | 1..1 | Reference(Patient | Group) | Patient referred to care or transfer | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:subject |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Individual or Entity the service is ordered for URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| context |
Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Originating encounter | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:encounter |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Encounter in which the request was created additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| occurrence[x] |
Σ | 0..1 | When the service(s) requested in the referral should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date of creation/activation | ||||
| requester |
ΣC | 0..1 | BackboneElement | Who/what is requesting service Constraints: rfr-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| agent |
Σ | 1..1 | Reference(Practitioner | Organization | Patient | RelatedPerson | Device) | Individual making the request | ||||
| onBehalfOf |
ΣC | 0..1 | Reference(Organization) | Organization agent is acting for | ||||
| specialty |
0..1 | CodeableConcept | The clinical specialty (discipline) that the referral is requested for Binding: PractitionerSpecialty (example): Codes indicating the types of capability the referred to service provider must have. | |||||
| recipient |
Σ | 0..* | Reference(Practitioner | Organization | HealthcareService) | Receiver of referral / transfer of care request | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:performer |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Requested performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Reason for referral / transfer of care request Binding: SNOMED CT Clinical Findings (example): Codes indicating why the referral is being requested. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation) | Why is service needed? | ||||
| description |
0..1 | string | A textual description of the referral | |||||
| supportingInfo |
0..* | Reference(Resource) | Additonal information to support referral or transfer of care request | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:supportingInfo |
0..* | CodeableConcept | R5: Additional clinical information additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.supportingInfo | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Comments made about referral request | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of request | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:relevantHistory |
0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Request provenance additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ReferralRequest.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| ReferralRequest.status | Base | required | RequestStatus | 📍3.0.2 | FHIR Std. |
| ReferralRequest.intent | Base | required | RequestIntent | 📍3.0.2 | FHIR Std. |
| ReferralRequest.type | Base | example | SNOMED CT Patient Referral | 📍3.0.2 | FHIR Std. |
| ReferralRequest.priority | Base | required | RequestPriority | 📍3.0.2 | FHIR Std. |
| ReferralRequest.serviceRequested | Base | example | Practice Setting Code Value Set | 📍20091109 | FHIR Std. |
| ReferralRequest.specialty | Base | example | PractitionerSpecialty | 📍3.0.2 | FHIR Std. |
| ReferralRequest.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| dom-2 | error | ReferralRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ReferralRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
|
| dom-4 | error | ReferralRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| rfr-1 | error | ReferralRequest.requester | onBehalfOf can only be specified if agent is practitioner or device |
(agent.resolve() is Device) or (agent.resolve() is Practitioner) or onBehalfOf.exists().not()
|
This structure is derived from ReferralRequest
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change