v2.0.0 draft

eReferral Implementation Guide
2.0.0 - Belgium flag

eReferral Implementation Guide, published by Riziv-Inami Platform. This guide is not an authorized publication; it is the continuous build for version 2.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-uhmep/ and changes regularly. See the Directory of published versions

Resource Profile: EReferralAnnex81

Official URL: https://www.riziv-inami.be/standards/fhir/ereferral/StructureDefinition/ereferral-annex-81 Version: 2.0.0
Active as of 2026-08-28 Computable Name: EReferralAnnex81

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 their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* BeAnnex81 A request for a service to be performed
Constraints: prr-1, be-inv-annex-81-based-on, ereferral-inv-annex81-has-nursing-diagnosis, ereferral-inv-annex81-has-medical-problem
... 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/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/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 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (preferred): 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
..... 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
... 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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:discipline SΣ 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: As shown (Nursing procedure)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... category:annex81TechnicalType SΣ 0..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: As shown (Preparing medication (Appendix 81))
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..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/terminology/CodeSystem/be-cs-prescription-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: medication-prefill-preparation-appendix-81
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
... 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: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 385796006
..... 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
... Slices for quantity[x] Σ 0..1 Service amount
Slice: Unordered, Open by type:$this
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
.... quantity[x]:quantityQuantity Σ 0..1 Quantity Service amount
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
... 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, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 Reference(BePractitionerRole(2.2.0)) Who/what is requesting service
... note S 0..* BeCodedAnnotation(2.2.0) 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 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
.... 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 preferred BeVSPrescriptionStatusReason 📦1.0.0 Referral Prescription Implementation Guide v1.0
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.category:discipline Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.category:annex81TechnicalType Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

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())
ereferral-inv-annex81-has-medical-problem error ServiceRequest Annex 81 must contain at least one medical problem reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '52448006' or code = '397540003' or code = '211071000172100' or code = '211101000172107' or code = '1137439008')).exists()
ereferral-inv-annex81-has-nursing-diagnosis error ServiceRequest Annex 81 must contain at least one nursing diagnosis reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '275928001' or code = '1290542000' or code = '129834002' or code = '448176008' or code = '359748005' or code = '271299001' or code = '62014003' or code = '708014007')).exists()
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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* BeAnnex81 A request for a service to be performed
Constraints: ereferral-inv-annex81-has-nursing-diagnosis, ereferral-inv-annex81-has-medical-problem
... meta
.... versionId 0..0 Version specific identifier
.... lastUpdated 0..0 When the resource version last changed
.... source 0..0 Identifies where the resource comes from
.... security 0..0 Security Labels applied to this resource
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... language 0..0 Language of the resource content
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... requisition 0..0 Composite Request ID
... doNotPerform 0..0 True if service/procedure should not be performed
... orderDetail 0..0 Additional order information
... Slices for quantity[x] 0..1 Quantity, Ratio, Range Service amount
Slice: Unordered, Open by type:$this
.... quantity[x]:quantityQuantity 0..1 Quantity Service amount
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... comparator 0..0 < | <= | >= | > - how to understand the value
..... unit 0..0 Unit representation
... encounter 0..0 Encounter in which the request was created
... Slices for occurrence[x] Content/Rules for all slices
.... occurrence[x]:occurrenceTiming 0..1 Timing When service should occur
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... modifierExtension 0..0 Extension
..... event 0..0 When the event occurs
..... repeat
...... Slices for bounds[x] 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
...... Slices for bounds[x] Content/Rules for all slices
....... bounds[x]:boundsPeriod 0..0 Length/Range of lengths, or (Start and/or end) limits
....... bounds[x]:boundsRange 0..0 Length/Range of lengths, or (Start and/or end) limits
...... countMax 0..0 Maximum number of times to repeat
...... durationMax 0..0 How long when it happens (Max)
...... frequencyMax 0..0 Event occurs up to frequencyMax times per period
...... periodMax 0..0 Upper limit of period (3-4 hours)
...... dayOfWeek 0..0 mon | tue | wed | thu | fri | sat | sun
...... timeOfDay 0..0 Time of day for action
...... offset 0..0 Minutes from event (before or after)
..... code 0..0 BID | TID | QID | AM | PM | QD | QOD | +
... asNeeded[x] 0..0 Preconditions for service
... locationCode 0..0 Requested location
... locationReference 0..0 Requested location
... reasonReference 0..0 Explanation/Justification for service or service
... insurance 0..0 Associated insurance coverage
... specimen 0..0 Procedure Samples
... bodySite
.... id 0..0 Unique id for inter-element referencing
... note
.... author[x] 0..0 Individual responsible for the annotation
.... time 0..0 When the annotation was made
... patientInstruction 0..0 Patient or consumer-oriented instructions
... relevantHistory 0..0 Request provenance

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ereferral-inv-annex81-has-medical-problem error ServiceRequest Annex 81 must contain at least one medical problem reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '52448006' or code = '397540003' or code = '211071000172100' or code = '211101000172107' or code = '1137439008')).exists()
ereferral-inv-annex81-has-nursing-diagnosis error ServiceRequest Annex 81 must contain at least one nursing diagnosis reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '275928001' or code = '1290542000' or code = '129834002' or code = '448176008' or code = '359748005' or code = '271299001' or code = '62014003' or code = '708014007')).exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* BeAnnex81 A request for a service to be performed
Constraints: prr-1, be-inv-annex-81-based-on, ereferral-inv-annex81-has-nursing-diagnosis, ereferral-inv-annex81-has-medical-problem
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... 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
.... 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 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/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 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (preferred): 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/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)
... basedOn SΣ 0..* Reference(BeAnnex81) What request fulfills
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... 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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:discipline SΣ 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: As shown (Nursing procedure)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... category:annex81TechnicalType SΣ 0..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: As shown (Preparing medication (Appendix 81))
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..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/terminology/CodeSystem/be-cs-prescription-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: medication-prefill-preparation-appendix-81
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 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.
... 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: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 385796006
..... 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
... Slices for quantity[x] Σ 0..1 Service amount
Slice: Unordered, Open by type:$this
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
.... quantity[x]:quantityQuantity Σ 0..1 Quantity Service amount
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... value Σ 0..1 decimal Numerical value (with implicit precision)
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
... 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, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... 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
...... Slices for bounds[x] Σ 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
...... Slices for bounds[x] Content/Rules for all slices
...... count Σ 0..1 positiveInt Number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... 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
...... 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)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
Required Pattern: wk
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 Reference(BePractitionerRole(2.2.0)) 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
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
... supportingInfo 0..* Reference(Resource) Additional clinical information
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... note S 0..* BeCodedAnnotation(2.2.0) 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 Extension
Slice: Unordered, Open by value:url
...... 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: eReferral Note Type (preferred): Types of notes that can be associated with a prescription. See 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 preferred BeVSPrescriptionStatusReason 📦1.0.0 Referral Prescription Implementation Guide v1.0
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.category:discipline Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.category:annex81TechnicalType 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.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.when Base required EventTiming 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ServiceRequest.note.​extension:code.value[x] Base preferred eReferral Note Type 📦1.0.0 Referral Prescription Implementation Guide v1.0

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())
ereferral-inv-annex81-has-medical-problem error ServiceRequest Annex 81 must contain at least one medical problem reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '52448006' or code = '397540003' or code = '211071000172100' or code = '211101000172107' or code = '1137439008')).exists()
ereferral-inv-annex81-has-nursing-diagnosis error ServiceRequest Annex 81 must contain at least one nursing diagnosis reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '275928001' or code = '1290542000' or code = '129834002' or code = '448176008' or code = '359748005' or code = '271299001' or code = '62014003' or code = '708014007')).exists()
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()

Summary

Prohibited: 43 elements

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* BeAnnex81 A request for a service to be performed
Constraints: prr-1, be-inv-annex-81-based-on, ereferral-inv-annex81-has-nursing-diagnosis, ereferral-inv-annex81-has-medical-problem
... 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/referral/StructureDefinition/be-ext-validity-period
.... extension:latest S 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/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 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (preferred): 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
..... 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
... 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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:discipline SΣ 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: As shown (Nursing procedure)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... category:annex81TechnicalType SΣ 0..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: As shown (Preparing medication (Appendix 81))
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..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/terminology/CodeSystem/be-cs-prescription-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: medication-prefill-preparation-appendix-81
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
... 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: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 385796006
..... 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
... Slices for quantity[x] Σ 0..1 Service amount
Slice: Unordered, Open by type:$this
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
.... quantity[x]:quantityQuantity Σ 0..1 Quantity Service amount
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
... 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, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 Reference(BePractitionerRole(2.2.0)) Who/what is requesting service
... note S 0..* BeCodedAnnotation(2.2.0) 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 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
.... 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 preferred BeVSPrescriptionStatusReason 📦1.0.0 Referral Prescription Implementation Guide v1.0
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.category:discipline Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.category:annex81TechnicalType Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.

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())
ereferral-inv-annex81-has-medical-problem error ServiceRequest Annex 81 must contain at least one medical problem reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '52448006' or code = '397540003' or code = '211071000172100' or code = '211101000172107' or code = '1137439008')).exists()
ereferral-inv-annex81-has-nursing-diagnosis error ServiceRequest Annex 81 must contain at least one nursing diagnosis reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '275928001' or code = '1290542000' or code = '129834002' or code = '448176008' or code = '359748005' or code = '271299001' or code = '62014003' or code = '708014007')).exists()
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* BeAnnex81 A request for a service to be performed
Constraints: ereferral-inv-annex81-has-nursing-diagnosis, ereferral-inv-annex81-has-medical-problem
... meta
.... versionId 0..0 Version specific identifier
.... lastUpdated 0..0 When the resource version last changed
.... source 0..0 Identifies where the resource comes from
.... security 0..0 Security Labels applied to this resource
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... language 0..0 Language of the resource content
... instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
... instantiatesUri 0..0 Instantiates external protocol or definition
... requisition 0..0 Composite Request ID
... doNotPerform 0..0 True if service/procedure should not be performed
... orderDetail 0..0 Additional order information
... Slices for quantity[x] 0..1 Quantity, Ratio, Range Service amount
Slice: Unordered, Open by type:$this
.... quantity[x]:quantityQuantity 0..1 Quantity Service amount
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... comparator 0..0 < | <= | >= | > - how to understand the value
..... unit 0..0 Unit representation
... encounter 0..0 Encounter in which the request was created
... Slices for occurrence[x] Content/Rules for all slices
.... occurrence[x]:occurrenceTiming 0..1 Timing When service should occur
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... modifierExtension 0..0 Extension
..... event 0..0 When the event occurs
..... repeat
...... Slices for bounds[x] 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
...... Slices for bounds[x] Content/Rules for all slices
....... bounds[x]:boundsPeriod 0..0 Length/Range of lengths, or (Start and/or end) limits
....... bounds[x]:boundsRange 0..0 Length/Range of lengths, or (Start and/or end) limits
...... countMax 0..0 Maximum number of times to repeat
...... durationMax 0..0 How long when it happens (Max)
...... frequencyMax 0..0 Event occurs up to frequencyMax times per period
...... periodMax 0..0 Upper limit of period (3-4 hours)
...... dayOfWeek 0..0 mon | tue | wed | thu | fri | sat | sun
...... timeOfDay 0..0 Time of day for action
...... offset 0..0 Minutes from event (before or after)
..... code 0..0 BID | TID | QID | AM | PM | QD | QOD | +
... asNeeded[x] 0..0 Preconditions for service
... locationCode 0..0 Requested location
... locationReference 0..0 Requested location
... reasonReference 0..0 Explanation/Justification for service or service
... insurance 0..0 Associated insurance coverage
... specimen 0..0 Procedure Samples
... bodySite
.... id 0..0 Unique id for inter-element referencing
... note
.... author[x] 0..0 Individual responsible for the annotation
.... time 0..0 When the annotation was made
... patientInstruction 0..0 Patient or consumer-oriented instructions
... relevantHistory 0..0 Request provenance

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ereferral-inv-annex81-has-medical-problem error ServiceRequest Annex 81 must contain at least one medical problem reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '52448006' or code = '397540003' or code = '211071000172100' or code = '211101000172107' or code = '1137439008')).exists()
ereferral-inv-annex81-has-nursing-diagnosis error ServiceRequest Annex 81 must contain at least one nursing diagnosis reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '275928001' or code = '1290542000' or code = '129834002' or code = '448176008' or code = '359748005' or code = '271299001' or code = '62014003' or code = '708014007')).exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* BeAnnex81 A request for a service to be performed
Constraints: prr-1, be-inv-annex-81-based-on, ereferral-inv-annex81-has-nursing-diagnosis, ereferral-inv-annex81-has-medical-problem
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
... 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
.... 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 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/referral/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 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: BeVSPrescriptionStatusReason (preferred): 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/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)
... basedOn SΣ 0..* Reference(BeAnnex81) What request fulfills
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... 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.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:discipline SΣ 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: As shown (Nursing procedure)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 9632001
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... category:annex81TechnicalType SΣ 0..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: As shown (Preparing medication (Appendix 81))
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..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/terminology/CodeSystem/be-cs-prescription-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: medication-prefill-preparation-appendix-81
...... display 0..0 string Representation defined by the system
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 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.
... 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: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 385796006
..... 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
... Slices for quantity[x] Σ 0..1 Service amount
Slice: Unordered, Open by type:$this
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
.... quantity[x]:quantityQuantity Σ 0..1 Quantity Service amount
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... value Σ 0..1 decimal Numerical value (with implicit precision)
..... system ΣC 0..1 uri System that defines coded unit form
..... code Σ 0..1 code Coded form of the unit
... 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, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceTiming Σ 0..1 Timing When service should occur
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... 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
...... Slices for bounds[x] Σ 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
...... Slices for bounds[x] Content/Rules for all slices
...... count Σ 0..1 positiveInt Number of times to repeat
...... duration Σ 0..1 decimal How long when it happens
...... 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
...... 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)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
Required Pattern: wk
...... when Σ 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
... authoredOn SΣC 1..1 dateTime Date request signed
Constraints: be-inv-long-date
... requester SΣ 1..1 Reference(BePractitionerRole(2.2.0)) 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
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
... supportingInfo 0..* Reference(Resource) Additional clinical information
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... note S 0..* BeCodedAnnotation(2.2.0) 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 Extension
Slice: Unordered, Open by value:url
...... 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: eReferral Note Type (preferred): Types of notes that can be associated with a prescription. See 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 preferred BeVSPrescriptionStatusReason 📦1.0.0 Referral Prescription Implementation Guide v1.0
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.category:discipline Base example Service Request Category Codes 📦4.0.1 FHIR Std.
ServiceRequest.category:annex81TechnicalType 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.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.when Base required EventTiming 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ServiceRequest.note.​extension:code.value[x] Base preferred eReferral Note Type 📦1.0.0 Referral Prescription Implementation Guide v1.0

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())
ereferral-inv-annex81-has-medical-problem error ServiceRequest Annex 81 must contain at least one medical problem reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '52448006' or code = '397540003' or code = '211071000172100' or code = '211101000172107' or code = '1137439008')).exists()
ereferral-inv-annex81-has-nursing-diagnosis error ServiceRequest Annex 81 must contain at least one nursing diagnosis reason code. reasonCode.coding.where(system = 'http://snomed.info/sct' and (code = '275928001' or code = '1290542000' or code = '129834002' or code = '448176008' or code = '359748005' or code = '271299001' or code = '62014003' or code = '708014007')).exists()
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()

Summary

Prohibited: 43 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron