Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-ReferralRequest-for-ServiceRequest | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_ReferralRequest_R4B_ServiceRequest | ||
This cross-version profile allows STU3 ReferralRequest content to be represented via FHIR R4B ServiceRequest resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequest(4.3.0) | A request for a service to be performed Constraints: prr-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:definition |
0..* | Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.definition Constraints: ext-1 | |
| extension:specialty |
0..1 | CodeableConcept | STU3: The clinical specialty (discipline) that the referral is requested for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.specialty Binding: R3PractitionerSpecialtyForR4B (0.1.0) (example): Codes indicating the types of capability the referred to service provider must have. Constraints: ext-1 | |
 extension:description |
0..1 | string | STU3: A textual description of the referral (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.description Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
  subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:subject |
0..1 | Reference(Resource) | STU3: Patient referred to care or transfer additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | 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()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ServiceRequest.implicitRules, ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.doNotPerform, ServiceRequest.subject, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.3.0) | A request for a service to be performed Constraints: prr-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
 tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:definition |
0..* | Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.definition Constraints: ext-1 | |||||
| extension:specialty |
0..1 | CodeableConcept | STU3: The clinical specialty (discipline) that the referral is requested for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.specialty Binding: R3PractitionerSpecialtyForR4B (0.1.0) (example): Codes indicating the types of capability the referred to service provider must have. Constraints: ext-1 | |||||
| extension:description |
0..1 | string | STU3: A textual description of the referral (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.description Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: Business identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..1 | Reference(Resource) | STU3: Request fulfilled by this request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:replaces |
0..1 | Reference(Resource) | STU3: Request(s) replaced by this request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:groupIdentifier |
0..1 | Identifier | STU3: Composite request this is part of additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.groupIdentifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available. | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
 quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: Patient referred to care or transfer additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:context |
0..1 | Reference(Resource) | STU3: Originating encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 service should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:agent |
1..1 | Reference(Resource) | STU3: Individual making the request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| extension:onBehalfOf |
0..1 | Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B(0.1.0) | Organization) | STU3: Organization agent is acting for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.requester.onBehalfOf Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ActionParticipantRole (2.0.0) (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:recipient |
0..1 | Reference(Resource) | STU3: Receiver of referral / transfer of care request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reasonReference |
0..1 | Reference(Resource) | STU3: Why is service needed? additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:supportingInfo |
0..1 | Reference(Resource) | STU3: Additonal information to support referral or transfer of care request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| note |
0..* | Annotation | Comments | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: Comments made about referral request additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:relevantHistory |
0..1 | Reference(Resource) | STU3: Key events in history of request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 |
| ServiceRequest.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ServiceRequest.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ServiceRequest.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ServiceRequest.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ServiceRequest.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.basedOn.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.replaces.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.requisition.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ServiceRequest.requisition.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.3.0 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.priority | Base | required | RequestPriority | 📍4.3.0 | FHIR Std. |
| ServiceRequest.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.3.0 | FHIR Std. |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.requester.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Action Participant Role | 📍2.0.0 | THO v7.1 |
| ServiceRequest.performer.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v7.1 |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.reasonReference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.supportingInfo.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| ServiceRequest.relevantHistory.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | 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()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | ServiceRequest.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | ServiceRequest.meta, ServiceRequest.meta.extension, ServiceRequest.meta.extension:meta, ServiceRequest.meta.versionId, ServiceRequest.meta.lastUpdated, ServiceRequest.meta.source, ServiceRequest.meta.profile, ServiceRequest.meta.security, ServiceRequest.meta.tag, ServiceRequest.implicitRules, ServiceRequest.language, ServiceRequest.text, ServiceRequest.text.extension, ServiceRequest.text.extension:text, ServiceRequest.text.status, ServiceRequest.text.div, ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.identifier, ServiceRequest.identifier.extension, ServiceRequest.identifier.extension:identifier, ServiceRequest.identifier.use, ServiceRequest.identifier.type, ServiceRequest.identifier.system, ServiceRequest.identifier.value, ServiceRequest.identifier.period, ServiceRequest.identifier.assigner, ServiceRequest.instantiatesCanonical, ServiceRequest.instantiatesUri, ServiceRequest.basedOn, ServiceRequest.basedOn.extension, ServiceRequest.basedOn.extension:basedOn, ServiceRequest.basedOn.reference, ServiceRequest.basedOn.type, ServiceRequest.basedOn.identifier, ServiceRequest.basedOn.display, ServiceRequest.replaces, ServiceRequest.replaces.extension, ServiceRequest.replaces.extension:replaces, ServiceRequest.replaces.reference, ServiceRequest.replaces.type, ServiceRequest.replaces.identifier, ServiceRequest.replaces.display, ServiceRequest.requisition, ServiceRequest.requisition.extension, ServiceRequest.requisition.extension:groupIdentifier, ServiceRequest.requisition.use, ServiceRequest.requisition.type, ServiceRequest.requisition.system, ServiceRequest.requisition.value, ServiceRequest.requisition.period, ServiceRequest.requisition.assigner, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.category, ServiceRequest.priority, ServiceRequest.doNotPerform, ServiceRequest.code, ServiceRequest.orderDetail, ServiceRequest.quantity[x], ServiceRequest.subject, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject, ServiceRequest.subject.reference, ServiceRequest.subject.type, ServiceRequest.subject.identifier, ServiceRequest.subject.display, ServiceRequest.encounter, ServiceRequest.encounter.extension, ServiceRequest.encounter.extension:context, ServiceRequest.encounter.reference, ServiceRequest.encounter.type, ServiceRequest.encounter.identifier, ServiceRequest.encounter.display, ServiceRequest.occurrence[x], ServiceRequest.asNeeded[x], ServiceRequest.authoredOn, ServiceRequest.requester, ServiceRequest.requester.extension, ServiceRequest.requester.extension:agent, ServiceRequest.requester.extension:onBehalfOf, ServiceRequest.requester.reference, ServiceRequest.requester.type, ServiceRequest.requester.identifier, ServiceRequest.requester.display, ServiceRequest.performerType, ServiceRequest.performer, ServiceRequest.performer.extension, ServiceRequest.performer.extension:recipient, ServiceRequest.performer.reference, ServiceRequest.performer.type, ServiceRequest.performer.identifier, ServiceRequest.performer.display, ServiceRequest.locationCode, ServiceRequest.locationReference, ServiceRequest.reasonCode, ServiceRequest.reasonReference, ServiceRequest.reasonReference.extension, ServiceRequest.reasonReference.extension:reasonReference, ServiceRequest.reasonReference.reference, ServiceRequest.reasonReference.type, ServiceRequest.reasonReference.identifier, ServiceRequest.reasonReference.display, ServiceRequest.insurance, ServiceRequest.supportingInfo, ServiceRequest.supportingInfo.extension, ServiceRequest.supportingInfo.extension:supportingInfo, ServiceRequest.supportingInfo.reference, ServiceRequest.supportingInfo.type, ServiceRequest.supportingInfo.identifier, ServiceRequest.supportingInfo.display, ServiceRequest.specimen, ServiceRequest.bodySite, ServiceRequest.note, ServiceRequest.note.extension, ServiceRequest.note.extension:note, ServiceRequest.note.author[x], ServiceRequest.note.time, ServiceRequest.note.text, ServiceRequest.patientInstruction, ServiceRequest.relevantHistory, ServiceRequest.relevantHistory.extension, ServiceRequest.relevantHistory.extension:relevantHistory, ServiceRequest.relevantHistory.reference, ServiceRequest.relevantHistory.type, ServiceRequest.relevantHistory.identifier, ServiceRequest.relevantHistory.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ServiceRequest.meta.extension, ServiceRequest.meta.extension:meta, ServiceRequest.text.extension, ServiceRequest.text.extension:text, ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.identifier.extension, ServiceRequest.identifier.extension:identifier, ServiceRequest.basedOn.extension, ServiceRequest.basedOn.extension:basedOn, ServiceRequest.replaces.extension, ServiceRequest.replaces.extension:replaces, ServiceRequest.requisition.extension, ServiceRequest.requisition.extension:groupIdentifier, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject, ServiceRequest.encounter.extension, ServiceRequest.encounter.extension:context, ServiceRequest.requester.extension, ServiceRequest.requester.extension:agent, ServiceRequest.requester.extension:onBehalfOf, ServiceRequest.performer.extension, ServiceRequest.performer.extension:recipient, ServiceRequest.reasonReference.extension, ServiceRequest.reasonReference.extension:reasonReference, ServiceRequest.supportingInfo.extension, ServiceRequest.supportingInfo.extension:supportingInfo, ServiceRequest.note.extension, ServiceRequest.note.extension:note, ServiceRequest.relevantHistory.extension, ServiceRequest.relevantHistory.extension:relevantHistory | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| txt-1 | error | ServiceRequest.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ServiceRequest.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ServiceRequest
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.3.0) | A request for a service to be performed Constraints: prr-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:definition |
0..* | Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.definition Constraints: ext-1 | |
| extension:specialty |
0..1 | CodeableConcept | STU3: The clinical specialty (discipline) that the referral is requested for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.specialty Binding: R3PractitionerSpecialtyForR4B (0.1.0) (example): Codes indicating the types of capability the referred to service provider must have. Constraints: ext-1 | |
| extension:description |
0..1 | string | STU3: A textual description of the referral (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.description Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:subject |
0..1 | Reference(Resource) | STU3: Patient referred to care or transfer additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | 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()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | ServiceRequest.implicitRules, ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.doNotPerform, ServiceRequest.subject, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
Differential View
This structure is derived from ServiceRequest
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest(4.3.0) | A request for a service to be performed Constraints: prr-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:definition |
0..* | Reference(Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4B(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition) | STU3: Instantiates protocol or definition (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.definition Constraints: ext-1 | |||||
| extension:specialty |
0..1 | CodeableConcept | STU3: The clinical specialty (discipline) that the referral is requested for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.specialty Binding: R3PractitionerSpecialtyForR4B (0.1.0) (example): Codes indicating the types of capability the referred to service provider must have. Constraints: ext-1 | |||||
| extension:description |
0..1 | string | STU3: A textual description of the referral (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.description Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Identifiers assigned to this order | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: Business identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..1 | Reference(Resource) | STU3: Request fulfilled by this request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:replaces |
0..1 | Reference(Resource) | STU3: Request(s) replaced by this request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:groupIdentifier |
0..1 | Identifier | STU3: Composite request this is part of additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.groupIdentifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available. | ||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: Patient referred to care or transfer additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:context |
0..1 | Reference(Resource) | STU3: Originating encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 service should occur | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
Σ | 0..1 | dateTime | Date request signed | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:agent |
1..1 | Reference(Resource) | STU3: Individual making the request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| extension:onBehalfOf |
0..1 | Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B(0.1.0) | Organization) | STU3: Organization agent is acting for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.requester.onBehalfOf Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ActionParticipantRole (2.0.0) (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:recipient |
0..1 | Reference(Resource) | STU3: Receiver of referral / transfer of care request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reasonReference |
0..1 | Reference(Resource) | STU3: Why is service needed? additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:supportingInfo |
0..1 | Reference(Resource) | STU3: Additonal information to support referral or transfer of care request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| note |
0..* | Annotation | Comments | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: Comments made about referral request additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-ReferralRequest.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:relevantHistory |
0..1 | Reference(Resource) | STU3: Key events in history of request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| 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 |
| ServiceRequest.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| ServiceRequest.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ServiceRequest.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| ServiceRequest.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ServiceRequest.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.basedOn.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.replaces.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.requisition.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| ServiceRequest.requisition.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.3.0 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.priority | Base | required | RequestPriority | 📍4.3.0 | FHIR Std. |
| ServiceRequest.code | Base | example | Procedure Codes (SNOMED CT) | 📍4.3.0 | FHIR Std. |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.requester.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Action Participant Role | 📍2.0.0 | THO v7.1 |
| ServiceRequest.performer.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v7.1 |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.3.0 | FHIR Std. |
| ServiceRequest.reasonReference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.supportingInfo.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.3.0 | FHIR Std. |
| ServiceRequest.relevantHistory.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | 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()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | ServiceRequest.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | ServiceRequest.meta, ServiceRequest.meta.extension, ServiceRequest.meta.extension:meta, ServiceRequest.meta.versionId, ServiceRequest.meta.lastUpdated, ServiceRequest.meta.source, ServiceRequest.meta.profile, ServiceRequest.meta.security, ServiceRequest.meta.tag, ServiceRequest.implicitRules, ServiceRequest.language, ServiceRequest.text, ServiceRequest.text.extension, ServiceRequest.text.extension:text, ServiceRequest.text.status, ServiceRequest.text.div, ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.identifier, ServiceRequest.identifier.extension, ServiceRequest.identifier.extension:identifier, ServiceRequest.identifier.use, ServiceRequest.identifier.type, ServiceRequest.identifier.system, ServiceRequest.identifier.value, ServiceRequest.identifier.period, ServiceRequest.identifier.assigner, ServiceRequest.instantiatesCanonical, ServiceRequest.instantiatesUri, ServiceRequest.basedOn, ServiceRequest.basedOn.extension, ServiceRequest.basedOn.extension:basedOn, ServiceRequest.basedOn.reference, ServiceRequest.basedOn.type, ServiceRequest.basedOn.identifier, ServiceRequest.basedOn.display, ServiceRequest.replaces, ServiceRequest.replaces.extension, ServiceRequest.replaces.extension:replaces, ServiceRequest.replaces.reference, ServiceRequest.replaces.type, ServiceRequest.replaces.identifier, ServiceRequest.replaces.display, ServiceRequest.requisition, ServiceRequest.requisition.extension, ServiceRequest.requisition.extension:groupIdentifier, ServiceRequest.requisition.use, ServiceRequest.requisition.type, ServiceRequest.requisition.system, ServiceRequest.requisition.value, ServiceRequest.requisition.period, ServiceRequest.requisition.assigner, ServiceRequest.status, ServiceRequest.intent, ServiceRequest.category, ServiceRequest.priority, ServiceRequest.doNotPerform, ServiceRequest.code, ServiceRequest.orderDetail, ServiceRequest.quantity[x], ServiceRequest.subject, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject, ServiceRequest.subject.reference, ServiceRequest.subject.type, ServiceRequest.subject.identifier, ServiceRequest.subject.display, ServiceRequest.encounter, ServiceRequest.encounter.extension, ServiceRequest.encounter.extension:context, ServiceRequest.encounter.reference, ServiceRequest.encounter.type, ServiceRequest.encounter.identifier, ServiceRequest.encounter.display, ServiceRequest.occurrence[x], ServiceRequest.asNeeded[x], ServiceRequest.authoredOn, ServiceRequest.requester, ServiceRequest.requester.extension, ServiceRequest.requester.extension:agent, ServiceRequest.requester.extension:onBehalfOf, ServiceRequest.requester.reference, ServiceRequest.requester.type, ServiceRequest.requester.identifier, ServiceRequest.requester.display, ServiceRequest.performerType, ServiceRequest.performer, ServiceRequest.performer.extension, ServiceRequest.performer.extension:recipient, ServiceRequest.performer.reference, ServiceRequest.performer.type, ServiceRequest.performer.identifier, ServiceRequest.performer.display, ServiceRequest.locationCode, ServiceRequest.locationReference, ServiceRequest.reasonCode, ServiceRequest.reasonReference, ServiceRequest.reasonReference.extension, ServiceRequest.reasonReference.extension:reasonReference, ServiceRequest.reasonReference.reference, ServiceRequest.reasonReference.type, ServiceRequest.reasonReference.identifier, ServiceRequest.reasonReference.display, ServiceRequest.insurance, ServiceRequest.supportingInfo, ServiceRequest.supportingInfo.extension, ServiceRequest.supportingInfo.extension:supportingInfo, ServiceRequest.supportingInfo.reference, ServiceRequest.supportingInfo.type, ServiceRequest.supportingInfo.identifier, ServiceRequest.supportingInfo.display, ServiceRequest.specimen, ServiceRequest.bodySite, ServiceRequest.note, ServiceRequest.note.extension, ServiceRequest.note.extension:note, ServiceRequest.note.author[x], ServiceRequest.note.time, ServiceRequest.note.text, ServiceRequest.patientInstruction, ServiceRequest.relevantHistory, ServiceRequest.relevantHistory.extension, ServiceRequest.relevantHistory.extension:relevantHistory, ServiceRequest.relevantHistory.reference, ServiceRequest.relevantHistory.type, ServiceRequest.relevantHistory.identifier, ServiceRequest.relevantHistory.display | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | ServiceRequest.meta.extension, ServiceRequest.meta.extension:meta, ServiceRequest.text.extension, ServiceRequest.text.extension:text, ServiceRequest.extension, ServiceRequest.extension:definition, ServiceRequest.extension:specialty, ServiceRequest.extension:description, ServiceRequest.modifierExtension, ServiceRequest.identifier.extension, ServiceRequest.identifier.extension:identifier, ServiceRequest.basedOn.extension, ServiceRequest.basedOn.extension:basedOn, ServiceRequest.replaces.extension, ServiceRequest.replaces.extension:replaces, ServiceRequest.requisition.extension, ServiceRequest.requisition.extension:groupIdentifier, ServiceRequest.subject.extension, ServiceRequest.subject.extension:subject, ServiceRequest.encounter.extension, ServiceRequest.encounter.extension:context, ServiceRequest.requester.extension, ServiceRequest.requester.extension:agent, ServiceRequest.requester.extension:onBehalfOf, ServiceRequest.performer.extension, ServiceRequest.performer.extension:recipient, ServiceRequest.reasonReference.extension, ServiceRequest.reasonReference.extension:reasonReference, ServiceRequest.supportingInfo.extension, ServiceRequest.supportingInfo.extension:supportingInfo, ServiceRequest.note.extension, ServiceRequest.note.extension:note, ServiceRequest.relevantHistory.extension, ServiceRequest.relevantHistory.extension:relevantHistory | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| txt-1 | error | ServiceRequest.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | ServiceRequest.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from ServiceRequest
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-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
