Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2 United States of America flag

This page is part of the Bidirectional Services eReferrals (BSeR) (v2.0.0-ballot: STU 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: BSeR Referral Service Request

Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-ReferralServiceRequest Version: 2.0.0-ballot
Active as of 2023-07-31 Computable Name: BSeRReferralServiceRequest

This ServiceRequest profile represents a BSeR request for a referral.

It is based on the ReferralServiceRequest profile and further constrains it as follows:

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ReferralServiceRequestA request for a service to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... pertainsToGoal S0..*Reference(Goal)Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier:referralInitiatorServiceRequestIdentifier SΣ1..1IdentifierIdentifiers assigned to this order
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier SΣ0..1IdentifierIdentifiers assigned to this order
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... basedOn SΣ0..*Reference(Referral Service Request)What request fulfills
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ1..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConceptClassification of service
Binding: US Core ServiceRequest Category Codes (required)
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptReferral or specific type of referral
Binding: US Core Procedure Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x] SΣ1..1When service should occur
.... occurrencePeriodPeriod
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(US Core PractitionerRole Profile)Referral Initiator
... performer SΣ0..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Referral Recipient
... reasonCode SΣ0..*CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... reasonReference SΣ0..*Reference(US Core Condition Problems and Health Concerns Profile | Observation)Explanation/Justification for service or service
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:insuranceCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... Slices for supportingInfo S0..*Reference(Resource)Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:consentSupportingInfo S0..*Reference(BSeR Patient Consent)Additional clinical information
.... supportingInfo:bundleSupportingInfo S0..*Reference(BSeR Referral Request Document Bundle)Additional clinical information
... note S0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.typeextensiblePattern: PLAC
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.typeextensiblePattern: FILL
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredPattern: order
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeextensibleUSCoreProcedureCodes
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ReferralServiceRequestA request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pertainsToGoal S0..*Reference(Goal)Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier SΣ1..1IdentifierIdentifiers assigned to this order
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier SΣ0..1IdentifierIdentifiers assigned to this order
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ0..*Reference(Referral Service Request)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ1..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConceptClassification of service
Binding: US Core ServiceRequest Category Codes (required)
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptReferral or specific type of referral
Binding: US Core Procedure Codes (extensible)
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] SΣ1..1When service should occur
.... occurrencePeriodPeriod S
.... occurrenceDateTimedateTime
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(US Core PractitionerRole Profile)Referral Initiator
... performerType Σ0..1CodeableConceptPerformer 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..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Referral Recipient
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... reasonReference SΣ0..*Reference(US Core Condition Problems and Health Concerns Profile | Observation)Explanation/Justification for service or service
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:insuranceCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... Slices for supportingInfo S0..*Reference(Resource)Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:consentSupportingInfo S0..*Reference(BSeR Patient Consent)Additional clinical information
.... supportingInfo:bundleSupportingInfo S0..*Reference(BSeR Referral Request Document Bundle)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note S0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.typeextensiblePattern: PLAC
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.typeextensiblePattern: FILL
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredPattern: order
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeextensibleUSCoreProcedureCodes
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ReferralServiceRequestA request for a service to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... pertainsToGoal S0..*Reference(Goal)Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier:referralInitiatorServiceRequestIdentifier SΣ1..1IdentifierIdentifiers assigned to this order
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier SΣ0..1IdentifierIdentifiers assigned to this order
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... basedOn SΣ0..*Reference(Referral Service Request)What request fulfills
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ1..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConceptClassification of service
Binding: US Core ServiceRequest Category Codes (required)
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptReferral or specific type of referral
Binding: US Core Procedure Codes (extensible)
... subject SΣ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x] SΣ1..1When service should occur
.... occurrencePeriodPeriod
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(US Core PractitionerRole Profile)Referral Initiator
... performer SΣ0..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Referral Recipient
... reasonCode SΣ0..*CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... reasonReference SΣ0..*Reference(US Core Condition Problems and Health Concerns Profile | Observation)Explanation/Justification for service or service
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:insuranceCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... Slices for supportingInfo S0..*Reference(Resource)Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:consentSupportingInfo S0..*Reference(BSeR Patient Consent)Additional clinical information
.... supportingInfo:bundleSupportingInfo S0..*Reference(BSeR Referral Request Document Bundle)Additional clinical information
... note S0..*AnnotationComments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.typeextensiblePattern: PLAC
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.typeextensiblePattern: FILL
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredPattern: order
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeextensibleUSCoreProcedureCodes
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ReferralServiceRequestA request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... pertainsToGoal S0..*Reference(Goal)Pertains to SDOH goal
URL: http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier SΣ1..1IdentifierIdentifiers assigned to this order
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier SΣ0..1IdentifierIdentifiers assigned to this order
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ0..*Reference(Referral Service Request)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
... Slices for category SΣ1..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:us-core SΣ0..*CodeableConceptClassification of service
Binding: US Core ServiceRequest Category Codes (required)
... priority SΣ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptReferral or specific type of referral
Binding: US Core Procedure Codes (extensible)
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] SΣ1..1When service should occur
.... occurrencePeriodPeriod S
.... occurrenceDateTimedateTime
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(US Core PractitionerRole Profile)Referral Initiator
... performerType Σ0..1CodeableConceptPerformer 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..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Referral Recipient
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... reasonReference SΣ0..*Reference(US Core Condition Problems and Health Concerns Profile | Observation)Explanation/Justification for service or service
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:insuranceCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... Slices for supportingInfo S0..*Reference(Resource)Additional clinical information
Slice: Unordered, Open by profile:resolve()
.... supportingInfo:consentSupportingInfo S0..*Reference(BSeR Patient Consent)Additional clinical information
.... supportingInfo:bundleSupportingInfo S0..*Reference(BSeR Referral Request Document Bundle)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note S0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralInitiatorServiceRequestIdentifier.typeextensiblePattern: PLAC
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.userequiredIdentifierUse
ServiceRequest.identifier:referralRecipientServiceRequestIdentifier.typeextensiblePattern: FILL
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredPattern: order
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.category:us-corerequiredUSCoreServiceRequestCategoryCodes
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeextensibleUSCoreProcedureCodes
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

 

Other representations of profile: CSV, Excel, Schematron