Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2
Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2
Bidirectional Services eReferral (BSeR), published by HL7 Public Health Working Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bser/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/referral-servicerequest | Version: 2.0.0-ballot | |||
| Active as of 2025-04-08 | Computable Name: ReferralServiceRequest | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.33.42.16 | ||||
This ServiceRequest profile represents a request for a referral.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:pertainsToGoal |
S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 Slices for identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
 identifier:referralInitiatorServiceRequestIdentifier |
SΣ | 1..1 | Identifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children |
  use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
  type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
   coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
  assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
 identifier:referralRecipientServiceRequestIdentifier |
SΣ | 0..1 | Identifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| basedOn |
SΣ | 0..* | Reference(Referral Service Request) | What request fulfills ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Fixed Value: order |
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children |
| category:us-core |
SΣ | 0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required) ele-1: All FHIR elements must have a @value or children |
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. ele-1: All FHIR elements must have a @value or children |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | CodeableConcept | Referral or specific type of referral Binding: US Core Procedure Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children |
 occurrence[x] |
SΣ | 0..1 | When service should occur ele-1: All FHIR elements must have a @value or children | |
| occurrencePeriod |
Period | |||
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children |
| requester |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Referral Initiator ele-1: All FHIR elements must have a @value or children |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Referral Recipient ele-1: All FHIR elements must have a @value or children |
| reasonCode |
SΣ | 0..* | CodeableConcept | Reason for referral Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. ele-1: All FHIR elements must have a @value or children |
| text |
SΣ | 1..1 | string | set to the reason if there is no code otherwise set this field to the description of the code ele-1: All FHIR elements must have a @value or children |
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service ele-1: All FHIR elements must have a @value or children |
| Slices for insurance |
S | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children |
| insurance:insuranceCoverage |
S | 0..* | Reference(BSeR Coverage) | Associated insurance coverage ele-1: All FHIR elements must have a @value or children |
| Slices for supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children |
 supportingInfo:consentSupportingInfo |
S | 0..* | Reference(Consent) | Additional clinical information ele-1: All FHIR elements must have a @value or children |
| supportingInfo:bundleSupportingInfo |
S | 0..* | Reference(Bundle) | Additional clinical information ele-1: All FHIR elements must have a @value or children |
| note |
S | 0..* | Annotation | Comments ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard |
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
USCoreServiceRequestProfile | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:pertainsToGoal |
S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| Slices for identifier |
S | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type |
| identifier:referralInitiatorServiceRequestIdentifier |
S | 1..1 | Identifier | Identifiers assigned to this order |
 type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
| identifier:referralRecipientServiceRequestIdentifier |
S | 0..1 | Identifier | Identifiers assigned to this order |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
| basedOn |
S | 0..* | Reference(Referral Service Request) | What request fulfills |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order | |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| code |
1..1 | CodeableConcept | Referral or specific type of referral | |
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | Device) | Referral Initiator | |
| performer |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Referral Recipient |
| reasonCode |
S | 0..* | CodeableConcept | Reason for referral |
| text |
S | 1..1 | string | set to the reason if there is no code otherwise set this field to the description of the code |
| reasonReference |
S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
| Slices for insurance |
S | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage Slice: Unordered, Open by profile:resolve() |
| insurance:insuranceCoverage |
S | 0..* | Reference(BSeR Coverage) | Associated insurance coverage |
| Slices for supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() |
| supportingInfo:consentSupportingInfo |
S | 0..* | Reference(Consent) | Additional clinical information |
| supportingInfo:bundleSupportingInfo |
S | 0..* | Reference(Bundle) | Additional clinical information |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:pertainsToGoal |
S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type | ||||
| identifier:referralInitiatorServiceRequestIdentifier |
SΣ | 1..1 | Identifier | Identifiers assigned to this order | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) | ||||
| identifier:referralRecipientServiceRequestIdentifier |
SΣ | 0..1 | Identifier | Identifiers assigned to this order | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | 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 |
SΣ | 0..* | Reference(Referral Service Request) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:us-core |
SΣ | 0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required) | ||||
| priority |
SΣ | 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 |
SΣ | 1..1 | CodeableConcept | Referral or specific type of referral Binding: US Core Procedure Codes (extensible) | ||||
| 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 |
SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | When service should occur | |||||
| occurrencePeriod |
Period S | |||||||
| occurrenceDateTime |
dateTime | |||||||
| 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 |
SΣ | 0..1 | dateTime | Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | Device) | Referral Initiator | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Referral Recipient | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Reason for referral Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 1..1 | string | set to the reason if there is no code otherwise set this field to the description of the code | ||||
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| Slices for insurance |
S | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage Slice: Unordered, Open by profile:resolve() | ||||
| insurance:insuranceCoverage |
S | 0..* | Reference(BSeR Coverage) | Associated insurance coverage | ||||
| Slices for supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | ||||
| supportingInfo:consentSupportingInfo |
S | 0..* | Reference(Consent) | Additional clinical information | ||||
| supportingInfo:bundleSupportingInfo |
S | 0..* | Reference(Bundle) | Additional clinical information | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
S | 0..* | Annotation | Comments | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 5 elements(3 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:pertainsToGoal |
S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| Slices for identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children |
| identifier:referralInitiatorServiceRequestIdentifier |
SΣ | 1..1 | Identifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier:referralRecipientServiceRequestIdentifier |
SΣ | 0..1 | Identifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| basedOn |
SΣ | 0..* | Reference(Referral Service Request) | What request fulfills ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Fixed Value: order |
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children |
| category:us-core |
SΣ | 0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required) ele-1: All FHIR elements must have a @value or children |
| priority |
SΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. ele-1: All FHIR elements must have a @value or children |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | CodeableConcept | Referral or specific type of referral Binding: US Core Procedure Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children |
| occurrence[x] |
SΣ | 0..1 | When service should occur ele-1: All FHIR elements must have a @value or children | |
| occurrencePeriod |
Period | |||
| authoredOn |
SΣ | 0..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children |
| requester |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Referral Initiator ele-1: All FHIR elements must have a @value or children |
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Referral Recipient ele-1: All FHIR elements must have a @value or children |
| reasonCode |
SΣ | 0..* | CodeableConcept | Reason for referral Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. ele-1: All FHIR elements must have a @value or children |
| text |
SΣ | 1..1 | string | set to the reason if there is no code otherwise set this field to the description of the code ele-1: All FHIR elements must have a @value or children |
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service ele-1: All FHIR elements must have a @value or children |
| Slices for insurance |
S | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children |
| insurance:insuranceCoverage |
S | 0..* | Reference(BSeR Coverage) | Associated insurance coverage ele-1: All FHIR elements must have a @value or children |
| Slices for supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() ele-1: All FHIR elements must have a @value or children |
| supportingInfo:consentSupportingInfo |
S | 0..* | Reference(Consent) | Additional clinical information ele-1: All FHIR elements must have a @value or children |
| supportingInfo:bundleSupportingInfo |
S | 0..* | Reference(Bundle) | Additional clinical information ele-1: All FHIR elements must have a @value or children |
| note |
S | 0..* | Annotation | Comments ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard |
Differential View
This structure is derived from USCoreServiceRequestProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
USCoreServiceRequestProfile | |||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:pertainsToGoal |
S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal |
| Slices for identifier |
S | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type |
| identifier:referralInitiatorServiceRequestIdentifier |
S | 1..1 | Identifier | Identifiers assigned to this order |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
| identifier:referralRecipientServiceRequestIdentifier |
S | 0..1 | Identifier | Identifiers assigned to this order |
| type |
S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
| value |
S | 1..1 | string | The value that is unique |
| assigner |
S | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
| basedOn |
S | 0..* | Reference(Referral Service Request) | What request fulfills |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order | |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| code |
1..1 | CodeableConcept | Referral or specific type of referral | |
| requester |
1..1 | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | Device) | Referral Initiator | |
| performer |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Referral Recipient |
| reasonCode |
S | 0..* | CodeableConcept | Reason for referral |
| text |
S | 1..1 | string | set to the reason if there is no code otherwise set this field to the description of the code |
| reasonReference |
S | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service |
| Slices for insurance |
S | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage Slice: Unordered, Open by profile:resolve() |
| insurance:insuranceCoverage |
S | 0..* | Reference(BSeR Coverage) | Associated insurance coverage |
| Slices for supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() |
| supportingInfo:consentSupportingInfo |
S | 0..* | Reference(Consent) | Additional clinical information |
| supportingInfo:bundleSupportingInfo |
S | 0..* | Reference(Bundle) | Additional clinical information |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | USCoreServiceRequestProfile | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:pertainsToGoal |
S | 0..* | Reference(Goal) | Pertains to SDOH goal URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:type | ||||
| identifier:referralInitiatorServiceRequestIdentifier |
SΣ | 1..1 | Identifier | Identifiers assigned to this order | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) | ||||
| identifier:referralRecipientServiceRequestIdentifier |
SΣ | 0..1 | Identifier | Identifiers assigned to this order | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
SΣ | 0..1 | Reference(US Core Organization Profile) | 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 |
SΣ | 0..* | Reference(Referral Service Request) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
| Slices for category |
SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:us-core |
SΣ | 0..* | CodeableConcept | Classification of service Binding: US Core ServiceRequest Category Codes (required) | ||||
| priority |
SΣ | 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 |
SΣ | 1..1 | CodeableConcept | Referral or specific type of referral Binding: US Core Procedure Codes (extensible) | ||||
| 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 |
SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] |
SΣ | 0..1 | When service should occur | |||||
| occurrencePeriod |
Period S | |||||||
| occurrenceDateTime |
dateTime | |||||||
| 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 |
SΣ | 0..1 | dateTime | Date request signed | ||||
| requester |
SΣ | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile | US Core Patient Profile | PractitionerRole | US Core RelatedPerson Profile | Device) | Referral Initiator | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Referral Recipient | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 0..* | CodeableConcept | Reason for referral Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 1..1 | string | set to the reason if there is no code otherwise set this field to the description of the code | ||||
| reasonReference |
SΣ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| Slices for insurance |
S | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage Slice: Unordered, Open by profile:resolve() | ||||
| insurance:insuranceCoverage |
S | 0..* | Reference(BSeR Coverage) | Associated insurance coverage | ||||
| Slices for supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:resolve() | ||||
| supportingInfo:consentSupportingInfo |
S | 0..* | Reference(Consent) | Additional clinical information | ||||
| supportingInfo:bundleSupportingInfo |
S | 0..* | Reference(Bundle) | Additional clinical information | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
S | 0..* | Annotation | Comments | ||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.category:us-core | required | USCoreServiceRequestCategoryCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-servicerequest-category | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | extensible | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
This structure is derived from USCoreServiceRequestProfile
Summary
Mandatory: 5 elements(3 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 Public Health Working Group. Package hl7.fhir.us.bser#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-04-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change