BSeR: Bidirectional Services_eReferral
2.0.0-connectathon - CI Build United States of America flag

BSeR: Bidirectional Services_eReferral - Local Development build (v2.0.0-connectathon). 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-connectathon
Active as of 2023-04-13 Computable Name: BSeR_ReferralServiceRequest

The referral service request is a profile of the FHIR ServiceRequest resource, a record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Usage:

Formal Views of Profile Content

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

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... Slices for identifier 1..2IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier 1..1IdentifierIdentifiers assigned to this order
..... type 1..1CodeableConceptDescription of identifier
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 1..1stringThe value that is unique
..... assigner 0..1Reference(BSeR Organization)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier 0..1IdentifierIdentifiers assigned to this order
..... type 1..1CodeableConceptDescription of identifier
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 1..1stringThe value that is unique
..... assigner 1..1Reference(BSeR Organization)Organization that issued id (may be just text)
... status 1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent 1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... subject 1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x] 1..1dateTimeWhen service should occur
... requester 1..1Reference(BSeR Referral Initiator Practitioner Role)Who/what is requesting service
... performer 1..1Reference(BSeR Referral Recipient Practitioner Role)Requested performer
... reasonCode S0..1CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:sliceInsuranceBSeRCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... supportingInfo S1..1Reference(BSeR Referral Request Document Bundle)Additional clinical information
... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ServiceRequest.codeextensibleBidirectional Services eReferral Type
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..2IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(BSeR Organization)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ1..1Reference(BSeR Organization)Organization that issued id (may be just text)
... intent ?!Σ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
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ1..1CodeableConceptReferral or specific type of referral
Binding: Bidirectional Services eReferral Type (extensible)
... subject Σ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x] Σ1..1dateTimeWhen service should occur
... requester Σ1..1Reference(BSeR Referral Initiator Practitioner Role)Who/what is requesting service
... performer Σ1..1Reference(BSeR Referral Recipient Practitioner Role)Requested performer
... reasonCode SΣ0..1CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:sliceInsuranceBSeRCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... supportingInfo S1..1Reference(BSeR Referral Request Document Bundle)Additional clinical information
... note 0..*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.codeextensibleBidirectional Services eReferral Type
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..2IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(BSeR Organization)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(BSeR Organization)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 Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ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
... category Σ0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


... priority Σ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 Σ1..1CodeableConceptReferral or specific type of referral
Binding: Bidirectional Services eReferral Type (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 Σ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] Σ1..1dateTimeWhen service should occur
... 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 Σ0..1dateTimeDate request signed
... requester Σ1..1Reference(BSeR Referral Initiator Practitioner Role)Who/what is requesting service
... 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 Σ1..1Reference(BSeR Referral Recipient Practitioner Role)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..1CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:sliceInsuranceBSeRCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... supportingInfo S1..1Reference(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 0..*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.priorityrequiredRequestPriority
ServiceRequest.codeextensibleBidirectional Services eReferral Type
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... Slices for identifier 1..2IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier 1..1IdentifierIdentifiers assigned to this order
..... type 1..1CodeableConceptDescription of identifier
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 1..1stringThe value that is unique
..... assigner 0..1Reference(BSeR Organization)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier 0..1IdentifierIdentifiers assigned to this order
..... type 1..1CodeableConceptDescription of identifier
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 1..1stringThe value that is unique
..... assigner 1..1Reference(BSeR Organization)Organization that issued id (may be just text)
... status 1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent 1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... subject 1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x] 1..1dateTimeWhen service should occur
... requester 1..1Reference(BSeR Referral Initiator Practitioner Role)Who/what is requesting service
... performer 1..1Reference(BSeR Referral Recipient Practitioner Role)Requested performer
... reasonCode S0..1CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:sliceInsuranceBSeRCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... supportingInfo S1..1Reference(BSeR Referral Request Document Bundle)Additional clinical information
... note 0..*AnnotationComments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ServiceRequest.codeextensibleBidirectional Services eReferral Type
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..2IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(BSeR Organization)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ1..1Reference(BSeR Organization)Organization that issued id (may be just text)
... intent ?!Σ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
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code Σ1..1CodeableConceptReferral or specific type of referral
Binding: Bidirectional Services eReferral Type (extensible)
... subject Σ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x] Σ1..1dateTimeWhen service should occur
... requester Σ1..1Reference(BSeR Referral Initiator Practitioner Role)Who/what is requesting service
... performer Σ1..1Reference(BSeR Referral Recipient Practitioner Role)Requested performer
... reasonCode SΣ0..1CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:sliceInsuranceBSeRCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... supportingInfo S1..1Reference(BSeR Referral Request Document Bundle)Additional clinical information
... note 0..*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.codeextensibleBidirectional Services eReferral Type
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA 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
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..2IdentifierIdentifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(BSeR Organization)Organization that issued id (may be just text)
.... identifier:referralRecipientServiceRequestIdentifier Σ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 Σ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 Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ1..1Reference(BSeR Organization)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 Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ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
... category Σ0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


... priority Σ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 Σ1..1CodeableConceptReferral or specific type of referral
Binding: Bidirectional Services eReferral Type (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 Σ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] Σ1..1dateTimeWhen service should occur
... 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 Σ0..1dateTimeDate request signed
... requester Σ1..1Reference(BSeR Referral Initiator Practitioner Role)Who/what is requesting service
... 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 Σ1..1Reference(BSeR Referral Recipient Practitioner Role)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..1CodeableConceptReason for referral
Binding: Bidirectional Services eReferral Reason (extensible)
... reasonReference Σ0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... Slices for insurance S0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
Slice: Unordered, Open by profile:resolve()
.... insurance:sliceInsuranceBSeRCoverage S0..*Reference(BSeR Coverage)Associated insurance coverage
... supportingInfo S1..1Reference(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 0..*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.priorityrequiredRequestPriority
ServiceRequest.codeextensibleBidirectional Services eReferral Type
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleBidirectional Services eReferral Reason
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron