Digital Referral Prescription Implementation Guide
1.0.0 - STU Belgium flag

Digital Referral Prescription Implementation Guide, published by eHealth Platform. 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: BeAnnex81

Official URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-annex-81 Version: 1.0.0
Active as of 2025-10-10 Computable Name: BeAnnex81

Annex81 proposal and approval

Usages:

You can also check for usages in the FHIR IG Statistics

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-annex-81-based-on
... 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:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
.... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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/drp/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/drp/NamingSystem/uhmep-short
..... value Σ 1..1 string The value that is unique
Example General: 123456
... basedOn SΣ 0..* Reference(BeAnnex81) 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: RequestIntent (required): The kind of service request.
... category SΣ 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... 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. For laboratory, LOINC is preferred.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/CodeSystem/be-cs-temp-requested-service
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tmp-prep-x081-2
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 Reference(BePractitionerRole(2.1.2)) Who/what is requesting service
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: BeVSAnnex81ReasonCode (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
.... text Σ 1..1 markdown The annotation - plain text without markdown is strongly recommended

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.extension:statusReason.​value[x] Base example BeVSPrescriptionStatusReason 📦1.0.0 This IG
ServiceRequest.identifier:UHMEP.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:SHORT.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base example BeVSAnnex81ReasonCode 📦1.0.0 This IG
ServiceRequest.note.​extension:code.value[x] Base example BeVSRequestNoteType 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-annex-81-based-on error ServiceRequest An approved Annex81 is always based on a request by a nurse intent = 'order' implies basedOn.exists()
be-inv-long-date warning ServiceRequest.authoredOn date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) empty() or toString().length()=25
be-inv-uhmep-short warning ServiceRequest.identifier:SHORT The 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-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id 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-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: be-inv-annex-81-based-on
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
.... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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/drp/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/drp/NamingSystem/uhmep-short
..... value 1..1 string The value that is unique
... basedOn S 0..* Reference(BeAnnex81) What request fulfills
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
... category S 0..* CodeableConcept Classification of service
.... coding
..... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 0..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
... code S 1..1 CodeableConcept What is being requested/ordered
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/CodeSystem/be-cs-temp-requested-service
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tmp-prep-x081-2
... subject S 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... Slices for occurrence[x] 0..1 dateTime, Period, Timing When service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceTiming 0..1 Timing When service should occur
..... repeat
...... frequency 0..1 positiveInt Event occurs frequency times per period
Required Pattern: 1
...... period 0..1 decimal Event occurs frequency times per period
Required Pattern: 1
...... periodUnit 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Required Pattern: wk
... authoredOn SC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester S 1..1 Reference(BePractitionerRole(2.1.2)) Who/what is requesting service
... reasonCode S 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: BeVSAnnex81ReasonCode (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.extension:statusReason.​value[x] Base example BeVSPrescriptionStatusReason 📦1.0.0 This IG
ServiceRequest.reasonCode Base example BeVSAnnex81ReasonCode 📦1.0.0 This IG
ServiceRequest.note.​extension:code.value[x] Base example BeVSRequestNoteType 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-annex-81-based-on error ServiceRequest An approved Annex81 is always based on a request by a nurse intent = 'order' implies basedOn.exists()
be-inv-long-date warning ServiceRequest.authoredOn date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) empty() or toString().length()=25
be-inv-uhmep-short warning ServiceRequest.identifier:SHORT The 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-annex-81-based-on
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
.... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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/drp/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/drp/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(BeAnnex81) What request fulfills
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... category SΣ 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... 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. For laboratory, LOINC is preferred.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/CodeSystem/be-cs-temp-requested-service
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tmp-prep-x081-2
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
Required Pattern: 1
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
Required Pattern: 1
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
Required Pattern: wk
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
... 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 Reference(BePractitionerRole(2.1.2)) Who/what is requesting service
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered.
... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: BeVSAnnex81ReasonCode (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... note S 0..* 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
.... 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

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.extension:statusReason.​value[x] Base example BeVSPrescriptionStatusReason 📦1.0.0 This IG
ServiceRequest.identifier:UHMEP.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:UHMEP.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.identifier:SHORT.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:SHORT.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​code Base preferred TimingAbbreviation 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📍3.0.0 THO v6.5
ServiceRequest.reasonCode Base example BeVSAnnex81ReasonCode 📦1.0.0 This IG
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ServiceRequest.note.​extension:code.value[x] Base example BeVSRequestNoteType 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-annex-81-based-on error ServiceRequest An approved Annex81 is always based on a request by a nurse intent = 'order' implies basedOn.exists()
be-inv-long-date warning ServiceRequest.authoredOn date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) empty() or toString().length()=25
be-inv-uhmep-short warning ServiceRequest.identifier:SHORT The 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-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id 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-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()
tim-1 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from ServiceRequest

Summary

Mandatory: 6 elements(4 nested mandatory elements)
Must-Support: 16 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

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-annex-81-based-on
... 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:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
.... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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/drp/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/drp/NamingSystem/uhmep-short
..... value Σ 1..1 string The value that is unique
Example General: 123456
... basedOn SΣ 0..* Reference(BeAnnex81) 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: RequestIntent (required): The kind of service request.
... category SΣ 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... 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. For laboratory, LOINC is preferred.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/CodeSystem/be-cs-temp-requested-service
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tmp-prep-x081-2
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 Reference(BePractitionerRole(2.1.2)) Who/what is requesting service
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: BeVSAnnex81ReasonCode (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
.... text Σ 1..1 markdown The annotation - plain text without markdown is strongly recommended

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.extension:statusReason.​value[x] Base example BeVSPrescriptionStatusReason 📦1.0.0 This IG
ServiceRequest.identifier:UHMEP.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:SHORT.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base example BeVSAnnex81ReasonCode 📦1.0.0 This IG
ServiceRequest.note.​extension:code.value[x] Base example BeVSRequestNoteType 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-annex-81-based-on error ServiceRequest An approved Annex81 is always based on a request by a nurse intent = 'order' implies basedOn.exists()
be-inv-long-date warning ServiceRequest.authoredOn date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) empty() or toString().length()=25
be-inv-uhmep-short warning ServiceRequest.identifier:SHORT The 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-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id 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-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: be-inv-annex-81-based-on
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
.... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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/drp/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/drp/NamingSystem/uhmep-short
..... value 1..1 string The value that is unique
... basedOn S 0..* Reference(BeAnnex81) What request fulfills
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
... category S 0..* CodeableConcept Classification of service
.... coding
..... system 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 0..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
... code S 1..1 CodeableConcept What is being requested/ordered
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/CodeSystem/be-cs-temp-requested-service
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tmp-prep-x081-2
... subject S 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... Slices for occurrence[x] 0..1 dateTime, Period, Timing When service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceTiming 0..1 Timing When service should occur
..... repeat
...... frequency 0..1 positiveInt Event occurs frequency times per period
Required Pattern: 1
...... period 0..1 decimal Event occurs frequency times per period
Required Pattern: 1
...... periodUnit 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Required Pattern: wk
... authoredOn SC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester S 1..1 Reference(BePractitionerRole(2.1.2)) Who/what is requesting service
... reasonCode S 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: BeVSAnnex81ReasonCode (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.extension:statusReason.​value[x] Base example BeVSPrescriptionStatusReason 📦1.0.0 This IG
ServiceRequest.reasonCode Base example BeVSAnnex81ReasonCode 📦1.0.0 This IG
ServiceRequest.note.​extension:code.value[x] Base example BeVSRequestNoteType 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-annex-81-based-on error ServiceRequest An approved Annex81 is always based on a request by a nurse intent = 'order' implies basedOn.exists()
be-inv-long-date warning ServiceRequest.authoredOn date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) empty() or toString().length()=25
be-inv-uhmep-short warning ServiceRequest.identifier:SHORT The 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-annex-81-based-on
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:validity S 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
.... 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... 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/drp/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/drp/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(BeAnnex81) What request fulfills
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... category SΣ 0..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... 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. For laboratory, LOINC is preferred.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/CodeSystem/be-cs-temp-requested-service
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: tmp-prep-x081-2
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... event Σ 0..* dateTime When the event occurs
..... repeat ΣC 0..1 Element When the event is to occur
Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... bounds[x] Σ 0..1 Length/Range of lengths, or (Start and/or end) limits
....... boundsDuration Duration
....... boundsRange Range
....... boundsPeriod Period
...... count Σ 0..1 positiveInt Number of times to repeat
...... countMax Σ 0..1 positiveInt Maximum number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... durationMax Σ 0..1 decimal How long when it happens (Max)
...... durationUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
...... frequency Σ 0..1 positiveInt Event occurs frequency times per period
Required Pattern: 1
...... frequencyMax Σ 0..1 positiveInt Event occurs up to frequencyMax times per period
...... period Σ 0..1 decimal Event occurs frequency times per period
Required Pattern: 1
...... periodMax Σ 0..1 decimal Upper limit of period (3-4 hours)
...... periodUnit Σ 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
Required Pattern: wk
...... dayOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ 0..* time Time of day for action
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
...... offset Σ 0..1 unsignedInt Minutes from event (before or after)
..... code Σ 0..1 CodeableConcept BID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.
... 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 Reference(BePractitionerRole(2.1.2)) Who/what is requesting service
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered.
... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode SΣ 1..* CodeableConcept Explanation/Justification for procedure or service
Binding: BeVSAnnex81ReasonCode (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... note S 0..* 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 (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet.
.... 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

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.extension:statusReason.​value[x] Base example BeVSPrescriptionStatusReason 📦1.0.0 This IG
ServiceRequest.identifier:UHMEP.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:UHMEP.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.identifier:SHORT.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ServiceRequest.identifier:SHORT.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.durationUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.periodUnit Base required UnitsOfTime 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.dayOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​repeat.when Base required EventTiming 📍4.0.1 FHIR Std.
ServiceRequest.occurrence[x]:occurrenceTiming.​code Base preferred TimingAbbreviation 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📍3.0.0 THO v6.5
ServiceRequest.reasonCode Base example BeVSAnnex81ReasonCode 📦1.0.0 This IG
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ServiceRequest.note.​extension:code.value[x] Base example BeVSRequestNoteType 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
be-inv-annex-81-based-on error ServiceRequest An approved Annex81 is always based on a request by a nurse intent = 'order' implies basedOn.exists()
be-inv-long-date warning ServiceRequest.authoredOn date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) empty() or toString().length()=25
be-inv-uhmep-short warning ServiceRequest.identifier:SHORT The 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-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id 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-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()
tim-1 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat if there's a duration, there needs to be duration units duration.empty() or durationUnit.exists()
tim-2 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat if there's a period, there needs to be period units period.empty() or periodUnit.exists()
tim-4 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat duration SHALL be a non-negative value duration.exists() implies duration >= 0
tim-5 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat period SHALL be a non-negative value period.exists() implies period >= 0
tim-6 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a periodMax, there must be a period periodMax.empty() or period.exists()
tim-7 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a durationMax, there must be a duration durationMax.empty() or duration.exists()
tim-8 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a countMax, there must be a count countMax.empty() or count.exists()
tim-9 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's an offset, there must be a when (and not C, CM, CD, CV) offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
tim-10 error ServiceRequest.occurrence[x]:occurrenceTiming.repeat If there's a timeOfDay, there cannot be a when, or vice versa timeOfDay.empty() or when.empty()

This structure is derived from ServiceRequest

Summary

Mandatory: 6 elements(4 nested mandatory elements)
Must-Support: 16 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron