Referral Prescription
1.0.0 - STU Belgium flag

Referral Prescription, published by . This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/referral/ and changes regularly. See the Directory of published versions

Resource Profile: BeReferralServiceRequest

Official URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referral-servicerequest Version: 1.0.0
Draft as of 2021-07-15 Computable Name: BeReferralServiceRequest

The common structure for referral prescription.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, be-inv-body-site
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:feedback S 0..1 boolean Give feedback to the prescriber
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 BeYearMonthDay Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date
.... extension:performerType S 0..* CodeableConcept Discipline of provider. Replaces .performerType because of wrong cardinality
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type
Binding: BeVSCdHcParty (extensible)
.... extension:statusReason S 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (extensible)
.... extension:device S 0..* (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(DeviceDefinition) Value of extension
...... extension:concept 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "concept"
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:UHMEP SΣ 0..1 Identifier Reference ID of the UHMEP once available there
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:SHORT SΣC 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short
..... value Σ 1..1 string The value that is unique
Example General: 123456
... basedOn SΣ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... 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: BeVSRequestIntent (required)
... category SΣ 1..1 CodeableConcept Classification of service
Binding: BeReferralCategory (extensible)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service.
... orderDetail SΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... subject SΣ 1..1 BeNoContainedReference(BePatient) Individual or Entity the service is ordered for
... occurrence[x] SΣ 0..1 When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 BeNoContainedReference(BePractitionerRole) Prescriber of the requested service
... reasonCode SΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
... supportingInfo S 0..* Reference(Resource) Additional clinical information
... bodySite SΣ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... Slices for extension Content/Rules for all slices
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... note S 0..* BeCodedAnnotation Comments
.... Slices for extension Content/Rules for all slices
..... extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
...... extension 0..0
...... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
...... value[x] 0..1 CodeableConcept Value of extension
Binding: BeVSRequestNoteType (required)
.... text Σ 1..1 markdown The annotation - plain text without markdown is strongly recommended

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]extensibleBeVSPrescriptionStatusReason(a valid code from BePrescriptionStatusReason)
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reason
From this IG
ServiceRequest.identifier:UHMEP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.identifier:SHORT.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
ServiceRequest.intentrequiredBeVSRequestIntent
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent
From this IG
ServiceRequest.categoryextensibleBeReferralCategory
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category
From this IG
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ServiceRequest.note.extension:code.value[x]requiredBeVSRequestNoteType
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
be-inv-body-siteerrorServiceRequestif the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing
: bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue()
be-inv-long-dateerrorServiceRequest.authoredOndate SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz)
: empty() or toString().length()=25
be-inv-uhmep-shorterrorServiceRequest.identifier:SHORTThe format of UHMEP-SHORT is 6 capital alphanumerics, without O
: Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
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()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: be-inv-body-site
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:feedback S 0..1 boolean Give feedback to the prescriber
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 BeYearMonthDay Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date
.... extension:performerType S 0..* CodeableConcept Discipline of provider. Replaces .performerType because of wrong cardinality
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type
Binding: BeVSCdHcParty (extensible)
.... extension:statusReason S 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (extensible)
.... extension:device S 0..* (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... value[x] 0..1 Reference(DeviceDefinition) Value of extension
... Slices for identifier S 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:UHMEP S 0..1 Identifier Reference ID of the UHMEP once available there
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
..... value 1..1 string The value that is unique
.... identifier:SHORT SC 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short
..... value 1..1 string The value that is unique
... basedOn S 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: BeVSRequestIntent (required)
... category S 1..1 CodeableConcept Classification of service
Binding: BeReferralCategory (extensible)
... code S 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service.
... orderDetail S 0..* CodeableConcept Additional order information
... subject S 1..1 BeNoContainedReference(BePatient) Individual or Entity the service is ordered for
... occurrence[x] S 0..1 dateTime, Period, Timing When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
... authoredOn SC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester S 1..1 BeNoContainedReference(BePractitionerRole) Prescriber of the requested service
... performerType S 0..0
... performer S 0..0
... reasonCode S 0..* CodeableConcept Explanation/Justification for procedure or service
... supportingInfo S 0..* Reference(Resource) Additional clinical information
... bodySite S 0..* CodeableConcept Location on Body
.... Slices for extension Content/Rules for all slices
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... note S 0..* BeCodedAnnotation Comments
.... Slices for extension Content/Rules for all slices
..... extension:code 0..1 BeExtCodeableConcept Code
...... value[x] 0..1 CodeableConcept Value of extension
Binding: BeVSRequestNoteType (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]extensibleBeVSPrescriptionStatusReason(a valid code from BePrescriptionStatusReason)
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reason
From this IG
ServiceRequest.intentrequiredBeVSRequestIntent
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent
From this IG
ServiceRequest.categoryextensibleBeReferralCategory
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category
From this IG
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ServiceRequest.note.extension:code.value[x]requiredBeVSRequestNoteType
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
be-inv-body-siteerrorServiceRequestif the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing
: bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue()
be-inv-long-dateerrorServiceRequest.authoredOndate SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz)
: empty() or toString().length()=25
be-inv-uhmep-shorterrorServiceRequest.identifier:SHORTThe format of UHMEP-SHORT is 6 capital alphanumerics, without O
: Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, be-inv-body-site
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:feedback S 0..1 boolean Give feedback to the prescriber
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 BeYearMonthDay Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date
.... extension:performerType S 0..* CodeableConcept Discipline of provider. Replaces .performerType because of wrong cardinality
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type
Binding: BeVSCdHcParty (extensible)
.... extension:statusReason S 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (extensible)
.... extension:device S 0..* (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:reference 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(DeviceDefinition) Value of extension
...... extension:concept 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "concept"
....... value[x] 0..1 CodeableConcept Value of extension
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:UHMEP SΣ 0..1 Identifier Reference ID of the UHMEP once available there
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
..... value Σ 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:SHORT SΣC 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short
..... value Σ 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) 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: BeVSRequestIntent (required)
... category SΣ 1..1 CodeableConcept Classification of service
Binding: BeReferralCategory (extensible)
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service.
... orderDetail SΣ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 BeNoContainedReference(BePatient) 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 shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 BeNoContainedReference(BePractitionerRole) Prescriber of the requested service
... 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 Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo S 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite SΣ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... note S 0..* BeCodedAnnotation Comments
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
...... value[x] 0..1 CodeableConcept Value of extension
Binding: BeVSRequestNoteType (required)
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - plain text without markdown is strongly recommended
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.extension:statusReason.value[x]extensibleBeVSPrescriptionStatusReason(a valid code from BePrescriptionStatusReason)
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reason
From this IG
ServiceRequest.identifier:UHMEP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.identifier:UHMEP.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ServiceRequest.identifier:SHORT.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.identifier:SHORT.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
ServiceRequest.intentrequiredBeVSRequestIntent
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent
From this IG
ServiceRequest.categoryextensibleBeReferralCategory
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category
From this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
From the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ServiceRequest.note.extension:code.value[x]requiredBeVSRequestNoteType
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
be-inv-body-siteerrorServiceRequestif the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing
: bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue()
be-inv-long-dateerrorServiceRequest.authoredOndate SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz)
: empty() or toString().length()=25
be-inv-uhmep-shorterrorServiceRequest.identifier:SHORTThe format of UHMEP-SHORT is 6 capital alphanumerics, without O
: Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, be-inv-body-site
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:feedback S 0..1 boolean Give feedback to the prescriber
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 BeYearMonthDay Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date
.... extension:performerType S 0..* CodeableConcept Discipline of provider. Replaces .performerType because of wrong cardinality
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type
Binding: BeVSCdHcParty (extensible)
.... extension:statusReason S 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (extensible)
.... extension:device S 0..* (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(DeviceDefinition) Value of extension
...... extension:concept 0..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "concept"
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:UHMEP SΣ 0..1 Identifier Reference ID of the UHMEP once available there
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:SHORT SΣC 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short
..... value Σ 1..1 string The value that is unique
Example General: 123456
... basedOn SΣ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... 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: BeVSRequestIntent (required)
... category SΣ 1..1 CodeableConcept Classification of service
Binding: BeReferralCategory (extensible)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service.
... orderDetail SΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... subject SΣ 1..1 BeNoContainedReference(BePatient) Individual or Entity the service is ordered for
... occurrence[x] SΣ 0..1 When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 BeNoContainedReference(BePractitionerRole) Prescriber of the requested service
... reasonCode SΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
... supportingInfo S 0..* Reference(Resource) Additional clinical information
... bodySite SΣ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... Slices for extension Content/Rules for all slices
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... note S 0..* BeCodedAnnotation Comments
.... Slices for extension Content/Rules for all slices
..... extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
...... extension 0..0
...... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
...... value[x] 0..1 CodeableConcept Value of extension
Binding: BeVSRequestNoteType (required)
.... text Σ 1..1 markdown The annotation - plain text without markdown is strongly recommended

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]extensibleBeVSPrescriptionStatusReason(a valid code from BePrescriptionStatusReason)
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reason
From this IG
ServiceRequest.identifier:UHMEP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.identifier:SHORT.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
ServiceRequest.intentrequiredBeVSRequestIntent
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent
From this IG
ServiceRequest.categoryextensibleBeReferralCategory
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category
From this IG
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ServiceRequest.note.extension:code.value[x]requiredBeVSRequestNoteType
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
be-inv-body-siteerrorServiceRequestif the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing
: bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue()
be-inv-long-dateerrorServiceRequest.authoredOndate SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz)
: empty() or toString().length()=25
be-inv-uhmep-shorterrorServiceRequest.identifier:SHORTThe format of UHMEP-SHORT is 6 capital alphanumerics, without O
: Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
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()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: be-inv-body-site
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:feedback S 0..1 boolean Give feedback to the prescriber
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 BeYearMonthDay Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date
.... extension:performerType S 0..* CodeableConcept Discipline of provider. Replaces .performerType because of wrong cardinality
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type
Binding: BeVSCdHcParty (extensible)
.... extension:statusReason S 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (extensible)
.... extension:device S 0..* (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... value[x] 0..1 Reference(DeviceDefinition) Value of extension
... Slices for identifier S 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:UHMEP S 0..1 Identifier Reference ID of the UHMEP once available there
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
..... value 1..1 string The value that is unique
.... identifier:SHORT SC 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
..... system 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short
..... value 1..1 string The value that is unique
... basedOn S 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What request fulfills
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: BeVSRequestIntent (required)
... category S 1..1 CodeableConcept Classification of service
Binding: BeReferralCategory (extensible)
... code S 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service.
... orderDetail S 0..* CodeableConcept Additional order information
... subject S 1..1 BeNoContainedReference(BePatient) Individual or Entity the service is ordered for
... occurrence[x] S 0..1 dateTime, Period, Timing When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
... authoredOn SC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester S 1..1 BeNoContainedReference(BePractitionerRole) Prescriber of the requested service
... performerType S 0..0
... performer S 0..0
... reasonCode S 0..* CodeableConcept Explanation/Justification for procedure or service
... supportingInfo S 0..* Reference(Resource) Additional clinical information
... bodySite S 0..* CodeableConcept Location on Body
.... Slices for extension Content/Rules for all slices
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... note S 0..* BeCodedAnnotation Comments
.... Slices for extension Content/Rules for all slices
..... extension:code 0..1 BeExtCodeableConcept Code
...... value[x] 0..1 CodeableConcept Value of extension
Binding: BeVSRequestNoteType (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.extension:statusReason.value[x]extensibleBeVSPrescriptionStatusReason(a valid code from BePrescriptionStatusReason)
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reason
From this IG
ServiceRequest.intentrequiredBeVSRequestIntent
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent
From this IG
ServiceRequest.categoryextensibleBeReferralCategory
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category
From this IG
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ServiceRequest.note.extension:code.value[x]requiredBeVSRequestNoteType
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
be-inv-body-siteerrorServiceRequestif the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing
: bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue()
be-inv-long-dateerrorServiceRequest.authoredOndate SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz)
: empty() or toString().length()=25
be-inv-uhmep-shorterrorServiceRequest.identifier:SHORTThe format of UHMEP-SHORT is 6 capital alphanumerics, without O
: Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1, be-inv-body-site
... 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:feedback S 0..1 boolean Give feedback to the prescriber
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 BeYearMonthDay Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date
.... extension:performerType S 0..* CodeableConcept Discipline of provider. Replaces .performerType because of wrong cardinality
URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type
Binding: BeVSCdHcParty (extensible)
.... extension:statusReason S 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (extensible)
.... extension:device S 0..* (Complex) BeExtCodeableReference
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:reference 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(DeviceDefinition) Value of extension
...... extension:concept 0..1 Extension Extension
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "concept"
....... value[x] 0..1 CodeableConcept Value of extension
..... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... identifier:UHMEP SΣ 0..1 Identifier Reference ID of the UHMEP once available there
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
..... value Σ 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:SHORT SΣC 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
..... 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 Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short
..... value Σ 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 Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) 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: BeVSRequestIntent (required)
... category SΣ 1..1 CodeableConcept Classification of service
Binding: BeReferralCategory (extensible)
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service.
... orderDetail SΣ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 BeNoContainedReference(BePatient) 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 shall occur - once this is past, this prescription is no longer valid and the status shall reflect this.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 BeNoContainedReference(BePractitionerRole) Prescriber of the requested service
... 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 Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo S 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite SΣ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... note S 0..* BeCodedAnnotation Comments
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
...... value[x] 0..1 CodeableConcept Value of extension
Binding: BeVSRequestNoteType (required)
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - plain text without markdown is strongly recommended
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.extension:statusReason.value[x]extensibleBeVSPrescriptionStatusReason(a valid code from BePrescriptionStatusReason)
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reason
From this IG
ServiceRequest.identifier:UHMEP.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.identifier:UHMEP.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ServiceRequest.identifier:SHORT.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
ServiceRequest.identifier:SHORT.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
ServiceRequest.intentrequiredBeVSRequestIntent
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent
From this IG
ServiceRequest.categoryextensibleBeReferralCategory
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category
From this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
ServiceRequest.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
From the FHIR Standard
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
From the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ServiceRequest.note.extension:code.value[x]requiredBeVSRequestNoteType
https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
be-inv-body-siteerrorServiceRequestif the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing
: bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue()
be-inv-long-dateerrorServiceRequest.authoredOndate SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz)
: empty() or toString().length()=25
be-inv-uhmep-shorterrorServiceRequest.identifier:SHORTThe format of UHMEP-SHORT is 6 capital alphanumerics, without O
: Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
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()

 

Other representations of profile: CSV, Excel, Schematron