v3.0.0 draft

eReferral Implementation Guide
3.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 3.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: 3.0.0
Active as of 2026-10-29 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: doco
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
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:validity This element must be supported. 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
ServiceRequest.Slices for extension.extension:latest This element must be supported. 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
ServiceRequest.Slices for extension.extension:statusReason This element must be supported. 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
ServiceRequest.Slices for extension.extension:statusReason.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:statusReason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
ServiceRequest.Slices for extension.extension: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.
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for identifier.identifier:UHMEP This element must be supported. This element is included in summaries. 0..1 Identifier Reference ID of the UHMEP once available there
ServiceRequest.Slices for identifier.identifier:UHMEP.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:UHMEP.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:UHMEP.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.Slices for identifier.identifier:SHORT This element must be supported. This element is included in summaries. C 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
ServiceRequest.Slices for identifier.identifier:SHORT.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:SHORT.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:SHORT.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.basedOn This element must be supported. This element is included in summaries. 0..* Reference(BeAnnex81) What request fulfills
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.Slices for category This element must be supported. This element is included in summaries. 2..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for category.category:discipline This element must be supported. This element is included in summaries. 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "9632001"
    }
  ]
}
ServiceRequest.Slices for category.category:annex81TechnicalType This element must be supported. This element is included in summaries. 1..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type",
      "code" : "medication-prefill-preparation-appendix-81"
    }
  ]
}
ServiceRequest.code This element must be supported. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "385796006"
    }
  ]
}
ServiceRequest.Slices for quantity[x] This element is included in summaries. 0..1 Service amount
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for quantity[x].quantityQuantity Quantity
ServiceRequest.Slices for quantity[x].quantityRatio Ratio
ServiceRequest.Slices for quantity[x].quantityRange Range
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.Slices for occurrence[x] This element is included in summaries. 0..1 When service should occur
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrenceDateTime dateTime
ServiceRequest.Slices for occurrence[x].occurrencePeriod Period
ServiceRequest.Slices for occurrence[x].occurrenceTiming Timing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming This element is included in summaries. 0..1 Timing When service should occur
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 1..1 dateTime Date request signed
Constraints: be-inv-long-date
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole(2.2.0)) Who/what is requesting service
ServiceRequest.note This element must be supported. 0..* BeCodedAnnotation(2.2.0) Comments
ServiceRequest.note.Slices for extension Content/Rules for all slices
ServiceRequest.note.Slices for extension.extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
ServiceRequest.note.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.note.Slices for extension.extension:code.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
ServiceRequest.note.text This element is included in summaries. 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.1.1 eReferral Prescription Implementation Guide v1.1
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: doco
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
ServiceRequest.meta
ServiceRequest.meta.versionId 0..0 Version specific identifier
ServiceRequest.meta.lastUpdated 0..0 When the resource version last changed
ServiceRequest.meta.source 0..0 Identifies where the resource comes from
ServiceRequest.meta.security 0..0 Security Labels applied to this resource
ServiceRequest.meta.tag 0..0 Tags applied to this resource
ServiceRequest.implicitRules 0..0 A set of rules under which this content was created
ServiceRequest.language 0..0 Language of the resource content
ServiceRequest.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri 0..0 Instantiates external protocol or definition
ServiceRequest.requisition 0..0 Composite Request ID
ServiceRequest.category 2..* CodeableConcept Classification of service
ServiceRequest.Slices for category Content/Rules for all slices
ServiceRequest.Slices for category.category:annex81TechnicalType 1..1 CodeableConcept Technical type for Annex 81 prescriptions
ServiceRequest.doNotPerform 0..0 True if service/procedure should not be performed
ServiceRequest.orderDetail 0..0 Additional order information
ServiceRequest.Slices for quantity[x] 0..1 Quantity, Ratio, Range Service amount
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity 0..1 Quantity Service amount
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.id 0..0 Unique id for inter-element referencing
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.extension 0..0 Extension
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.comparator 0..0 < | <= | >= | > - how to understand the value
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.unit 0..0 Unit representation
ServiceRequest.encounter 0..0 Encounter in which the request was created
ServiceRequest.Slices for occurrence[x] Content/Rules for all slices
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming 0..1 Timing When service should occur
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.id 0..0 Unique id for inter-element referencing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.extension 0..0 Extension
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.modifierExtension 0..0 Extension
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.event 0..0 When the event occurs
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] Content/Rules for all slices
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x].bounds[x]:boundsPeriod 0..0 Length/Range of lengths, or (Start and/or end) limits
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x].bounds[x]:boundsRange 0..0 Length/Range of lengths, or (Start and/or end) limits
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.countMax 0..0 Maximum number of times to repeat
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.durationMax 0..0 How long when it happens (Max)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.frequencyMax 0..0 Event occurs up to frequencyMax times per period
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.periodMax 0..0 Upper limit of period (3-4 hours)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.dayOfWeek 0..0 mon | tue | wed | thu | fri | sat | sun
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.timeOfDay 0..0 Time of day for action
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.offset 0..0 Minutes from event (before or after)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.code 0..0 BID | TID | QID | AM | PM | QD | QOD | +
ServiceRequest.asNeeded[x] 0..0 Preconditions for service
ServiceRequest.locationCode 0..0 Requested location
ServiceRequest.locationReference 0..0 Requested location
ServiceRequest.reasonReference 0..0 Explanation/Justification for service or service
ServiceRequest.insurance 0..0 Associated insurance coverage
ServiceRequest.specimen 0..0 Procedure Samples
ServiceRequest.bodySite
ServiceRequest.bodySite.id 0..0 Unique id for inter-element referencing
ServiceRequest.note
ServiceRequest.note.author[x] 0..0 Individual responsible for the annotation
ServiceRequest.note.time 0..0 When the annotation was made
ServiceRequest.patientInstruction 0..0 Patient or consumer-oriented instructions
ServiceRequest.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: doco
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
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.meta.id 0..1 string Unique id for inter-element referencing
ServiceRequest.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ServiceRequest.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
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:validity This element must be supported. 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
ServiceRequest.Slices for extension.extension:latest This element must be supported. 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
ServiceRequest.Slices for extension.extension:statusReason This element must be supported. 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
ServiceRequest.Slices for extension.extension:statusReason.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for extension.extension:statusReason.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:statusReason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
ServiceRequest.Slices for extension.extension: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.
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for identifier.identifier:UHMEP This element must be supported. This element is included in summaries. 0..1 Identifier Reference ID of the UHMEP once available there
ServiceRequest.Slices for identifier.identifier:UHMEP.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for identifier.identifier:UHMEP.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.Slices for identifier.identifier:UHMEP.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:UHMEP.type This element is included in summaries. 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.
ServiceRequest.Slices for identifier.identifier:UHMEP.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:UHMEP.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.Slices for identifier.identifier:UHMEP.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
ServiceRequest.Slices for identifier.identifier:UHMEP.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
ServiceRequest.Slices for identifier.identifier:SHORT This element must be supported. This element is included in summaries. C 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
ServiceRequest.Slices for identifier.identifier:SHORT.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for identifier.identifier:SHORT.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.Slices for identifier.identifier:SHORT.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:SHORT.type This element is included in summaries. 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.
ServiceRequest.Slices for identifier.identifier:SHORT.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:SHORT.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.Slices for identifier.identifier:SHORT.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
ServiceRequest.Slices for identifier.identifier:SHORT.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
ServiceRequest.basedOn This element must be supported. This element is included in summaries. 0..* Reference(BeAnnex81) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.Slices for category This element must be supported. This element is included in summaries. 2..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for category.category:discipline This element must be supported. This element is included in summaries. 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "9632001"
    }
  ]
}
ServiceRequest.Slices for category.category:annex81TechnicalType This element must be supported. This element is included in summaries. 1..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type",
      "code" : "medication-prefill-preparation-appendix-81"
    }
  ]
}
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.code This element must be supported. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "385796006"
    }
  ]
}
ServiceRequest.Slices for quantity[x] This element is included in summaries. 0..1 Service amount
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for quantity[x].quantityQuantity Quantity
ServiceRequest.Slices for quantity[x].quantityRatio Ratio
ServiceRequest.Slices for quantity[x].quantityRange Range
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.value This element is included in summaries. 0..1 decimal Numerical value (with implicit precision)
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.system This element is included in summaries. C 0..1 uri System that defines coded unit form
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.code This element is included in summaries. 0..1 code Coded form of the unit
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.Slices for occurrence[x] This element is included in summaries. 0..1 When service should occur
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrenceDateTime dateTime
ServiceRequest.Slices for occurrence[x].occurrencePeriod Period
ServiceRequest.Slices for occurrence[x].occurrenceTiming Timing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming This element is included in summaries. 0..1 Timing When service should occur
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat This element is included in summaries. 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
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] This element is included in summaries. 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] Content/Rules for all slices
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.count This element is included in summaries. 0..1 positiveInt Number of times to repeat
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.duration This element is included in summaries. 0..1 decimal How long when it happens
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.durationUnit This element is included in summaries. 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.frequency This element is included in summaries. 0..1 positiveInt Event occurs frequency times per period
Required Pattern: 1 (extensions allowed)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.period This element is included in summaries. 0..1 decimal Event occurs frequency times per period
Required Pattern: 1 (extensions allowed)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.periodUnit This element is included in summaries. 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 (extensions allowed)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.when This element is included in summaries. 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 1..1 dateTime Date request signed
Constraints: be-inv-long-date
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole(2.2.0)) Who/what is requesting service
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.bodySite.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.bodySite.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
ServiceRequest.bodySite.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.note This element must be supported. 0..* BeCodedAnnotation(2.2.0) Comments
ServiceRequest.note.id 0..1 string Unique id for inter-element referencing
ServiceRequest.note.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.note.Slices for extension.extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
ServiceRequest.note.Slices for extension.extension:code.id 0..1 string Unique id for inter-element referencing
ServiceRequest.note.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.note.Slices for extension.extension:code.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
ServiceRequest.note.Slices for extension.extension:code.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.
ServiceRequest.note.text This element is included in summaries. 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.1.1 eReferral Prescription Implementation Guide v1.1
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.1.1 eReferral Prescription Implementation Guide v1.1

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

Mandatory: 1 element
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: doco
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
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:validity This element must be supported. 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
ServiceRequest.Slices for extension.extension:latest This element must be supported. 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
ServiceRequest.Slices for extension.extension:statusReason This element must be supported. 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
ServiceRequest.Slices for extension.extension:statusReason.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:statusReason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
ServiceRequest.Slices for extension.extension: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.
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for identifier.identifier:UHMEP This element must be supported. This element is included in summaries. 0..1 Identifier Reference ID of the UHMEP once available there
ServiceRequest.Slices for identifier.identifier:UHMEP.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:UHMEP.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:UHMEP.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.Slices for identifier.identifier:SHORT This element must be supported. This element is included in summaries. C 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
ServiceRequest.Slices for identifier.identifier:SHORT.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:SHORT.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:SHORT.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.basedOn This element must be supported. This element is included in summaries. 0..* Reference(BeAnnex81) What request fulfills
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.Slices for category This element must be supported. This element is included in summaries. 2..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for category.category:discipline This element must be supported. This element is included in summaries. 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "9632001"
    }
  ]
}
ServiceRequest.Slices for category.category:annex81TechnicalType This element must be supported. This element is included in summaries. 1..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type",
      "code" : "medication-prefill-preparation-appendix-81"
    }
  ]
}
ServiceRequest.code This element must be supported. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "385796006"
    }
  ]
}
ServiceRequest.Slices for quantity[x] This element is included in summaries. 0..1 Service amount
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for quantity[x].quantityQuantity Quantity
ServiceRequest.Slices for quantity[x].quantityRatio Ratio
ServiceRequest.Slices for quantity[x].quantityRange Range
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.Slices for occurrence[x] This element is included in summaries. 0..1 When service should occur
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrenceDateTime dateTime
ServiceRequest.Slices for occurrence[x].occurrencePeriod Period
ServiceRequest.Slices for occurrence[x].occurrenceTiming Timing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming This element is included in summaries. 0..1 Timing When service should occur
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 1..1 dateTime Date request signed
Constraints: be-inv-long-date
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole(2.2.0)) Who/what is requesting service
ServiceRequest.note This element must be supported. 0..* BeCodedAnnotation(2.2.0) Comments
ServiceRequest.note.Slices for extension Content/Rules for all slices
ServiceRequest.note.Slices for extension.extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
ServiceRequest.note.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.note.Slices for extension.extension:code.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
ServiceRequest.note.text This element is included in summaries. 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.1.1 eReferral Prescription Implementation Guide v1.1
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: doco
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
ServiceRequest.meta
ServiceRequest.meta.versionId 0..0 Version specific identifier
ServiceRequest.meta.lastUpdated 0..0 When the resource version last changed
ServiceRequest.meta.source 0..0 Identifies where the resource comes from
ServiceRequest.meta.security 0..0 Security Labels applied to this resource
ServiceRequest.meta.tag 0..0 Tags applied to this resource
ServiceRequest.implicitRules 0..0 A set of rules under which this content was created
ServiceRequest.language 0..0 Language of the resource content
ServiceRequest.contained 0..0 Contained, inline Resources
ServiceRequest.instantiatesCanonical 0..0 Instantiates FHIR protocol or definition
ServiceRequest.instantiatesUri 0..0 Instantiates external protocol or definition
ServiceRequest.requisition 0..0 Composite Request ID
ServiceRequest.category 2..* CodeableConcept Classification of service
ServiceRequest.Slices for category Content/Rules for all slices
ServiceRequest.Slices for category.category:annex81TechnicalType 1..1 CodeableConcept Technical type for Annex 81 prescriptions
ServiceRequest.doNotPerform 0..0 True if service/procedure should not be performed
ServiceRequest.orderDetail 0..0 Additional order information
ServiceRequest.Slices for quantity[x] 0..1 Quantity, Ratio, Range Service amount
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity 0..1 Quantity Service amount
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.id 0..0 Unique id for inter-element referencing
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.extension 0..0 Extension
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.comparator 0..0 < | <= | >= | > - how to understand the value
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.unit 0..0 Unit representation
ServiceRequest.encounter 0..0 Encounter in which the request was created
ServiceRequest.Slices for occurrence[x] Content/Rules for all slices
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming 0..1 Timing When service should occur
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.id 0..0 Unique id for inter-element referencing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.extension 0..0 Extension
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.modifierExtension 0..0 Extension
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.event 0..0 When the event occurs
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] Content/Rules for all slices
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x].bounds[x]:boundsPeriod 0..0 Length/Range of lengths, or (Start and/or end) limits
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x].bounds[x]:boundsRange 0..0 Length/Range of lengths, or (Start and/or end) limits
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.countMax 0..0 Maximum number of times to repeat
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.durationMax 0..0 How long when it happens (Max)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.frequencyMax 0..0 Event occurs up to frequencyMax times per period
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.periodMax 0..0 Upper limit of period (3-4 hours)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.dayOfWeek 0..0 mon | tue | wed | thu | fri | sat | sun
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.timeOfDay 0..0 Time of day for action
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.offset 0..0 Minutes from event (before or after)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.code 0..0 BID | TID | QID | AM | PM | QD | QOD | +
ServiceRequest.asNeeded[x] 0..0 Preconditions for service
ServiceRequest.locationCode 0..0 Requested location
ServiceRequest.locationReference 0..0 Requested location
ServiceRequest.reasonReference 0..0 Explanation/Justification for service or service
ServiceRequest.insurance 0..0 Associated insurance coverage
ServiceRequest.specimen 0..0 Procedure Samples
ServiceRequest.bodySite
ServiceRequest.bodySite.id 0..0 Unique id for inter-element referencing
ServiceRequest.note
ServiceRequest.note.author[x] 0..0 Individual responsible for the annotation
ServiceRequest.note.time 0..0 When the annotation was made
ServiceRequest.patientInstruction 0..0 Patient or consumer-oriented instructions
ServiceRequest.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: doco
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
ServiceRequest.id This element is included in summaries. 0..1 id Logical id of this artifact
ServiceRequest.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ServiceRequest.meta.id 0..1 string Unique id for inter-element referencing
ServiceRequest.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ServiceRequest.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
ServiceRequest.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:validity This element must be supported. 1..1 Period Validity period of the prescription
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period
ServiceRequest.Slices for extension.extension:latest This element must be supported. 0..1 dateTime Request must be executed before
URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date
ServiceRequest.Slices for extension.extension:statusReason This element must be supported. 0..1 (Complex) Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
ServiceRequest.Slices for extension.extension:statusReason.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for extension.extension:statusReason.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.Slices for extension.extension:statusReason.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/request-statusReason"
ServiceRequest.Slices for extension.extension: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.
ServiceRequest.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ServiceRequest.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for identifier.identifier:UHMEP This element must be supported. This element is included in summaries. 0..1 Identifier Reference ID of the UHMEP once available there
ServiceRequest.Slices for identifier.identifier:UHMEP.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for identifier.identifier:UHMEP.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.Slices for identifier.identifier:UHMEP.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:UHMEP.type This element is included in summaries. 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.
ServiceRequest.Slices for identifier.identifier:UHMEP.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:UHMEP.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.Slices for identifier.identifier:UHMEP.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
ServiceRequest.Slices for identifier.identifier:UHMEP.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
ServiceRequest.Slices for identifier.identifier:SHORT This element must be supported. This element is included in summaries. C 0..1 Identifier Patient friendly ID (UHMEP SHORT)
Constraints: be-inv-uhmep-short
ServiceRequest.Slices for identifier.identifier:SHORT.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for identifier.identifier:SHORT.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.Slices for identifier.identifier:SHORT.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
ServiceRequest.Slices for identifier.identifier:SHORT.type This element is included in summaries. 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.
ServiceRequest.Slices for identifier.identifier:SHORT.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed)
ServiceRequest.Slices for identifier.identifier:SHORT.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
ServiceRequest.Slices for identifier.identifier:SHORT.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
ServiceRequest.Slices for identifier.identifier:SHORT.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
ServiceRequest.basedOn This element must be supported. This element is included in summaries. 0..* Reference(BeAnnex81) What request fulfills
ServiceRequest.replaces This element is included in summaries. 0..* Reference(ServiceRequest) What request replaces
ServiceRequest.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
ServiceRequest.intent This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
ServiceRequest.Slices for category This element must be supported. This element is included in summaries. 2..* CodeableConcept Classification of service
Slice: Unordered, Open by value:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for category.category:discipline This element must be supported. This element is included in summaries. 1..1 CodeableConcept Category that identifies the type of referral
Binding: ServiceRequestCategoryCodes (example): Categories of care that can be prescribed. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "9632001"
    }
  ]
}
ServiceRequest.Slices for category.category:annex81TechnicalType This element must be supported. This element is included in summaries. 1..1 CodeableConcept Technical type for Annex 81 prescriptions
Binding: ServiceRequestCategoryCodes (example): Technical type for Annex 81 prescriptions. See ValueSet.

Fixed Value: 
{
  "coding" : [
    {
      "system" : "https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type",
      "code" : "medication-prefill-preparation-appendix-81"
    }
  ]
}
ServiceRequest.priority This element is included in summaries. 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
ServiceRequest.code This element must be supported. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://snomed.info/sct",
      "code" : "385796006"
    }
  ]
}
ServiceRequest.Slices for quantity[x] This element is included in summaries. 0..1 Service amount
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for quantity[x].quantityQuantity Quantity
ServiceRequest.Slices for quantity[x].quantityRatio Ratio
ServiceRequest.Slices for quantity[x].quantityRange Range
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity This element is included in summaries. 0..1 Quantity Service amount
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.value This element is included in summaries. 0..1 decimal Numerical value (with implicit precision)
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.system This element is included in summaries. C 0..1 uri System that defines coded unit form
ServiceRequest.Slices for quantity[x].quantity[x]:quantityQuantity.code This element is included in summaries. 0..1 code Coded form of the unit
ServiceRequest.subject This element must be supported. This element is included in summaries. 1..1 Reference(Patient | Group | Location | Device) Individual or Entity the service is ordered for
ServiceRequest.Slices for occurrence[x] This element is included in summaries. 0..1 When service should occur
Slice: Unordered, Closed by type:$this
Slicing Note: Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrenceDateTime dateTime
ServiceRequest.Slices for occurrence[x].occurrencePeriod Period
ServiceRequest.Slices for occurrence[x].occurrenceTiming Timing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming This element is included in summaries. 0..1 Timing When service should occur
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat This element is included in summaries. 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
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.id 0..1 string Unique id for inter-element referencing
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] This element is included in summaries. 0..1 Duration Length/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.Slices for bounds[x] Content/Rules for all slices
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.count This element is included in summaries. 0..1 positiveInt Number of times to repeat
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.duration This element is included in summaries. 0..1 decimal How long when it happens
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.durationUnit This element is included in summaries. 0..1 code s | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.frequency This element is included in summaries. 0..1 positiveInt Event occurs frequency times per period
Required Pattern: 1 (extensions allowed)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.period This element is included in summaries. 0..1 decimal Event occurs frequency times per period
Required Pattern: 1 (extensions allowed)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.periodUnit This element is included in summaries. 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 (extensions allowed)
ServiceRequest.Slices for occurrence[x].occurrence[x]:occurrenceTiming.repeat.when This element is included in summaries. 0..* code Code for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.
ServiceRequest.authoredOn This element must be supported. This element is included in summaries. C 1..1 dateTime Date request signed
Constraints: be-inv-long-date
ServiceRequest.requester This element must be supported. This element is included in summaries. 1..1 Reference(BePractitionerRole(2.2.0)) Who/what is requesting service
ServiceRequest.performerType This element is included in summaries. 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.
ServiceRequest.performer This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
ServiceRequest.reasonCode This element is included in summaries. 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation.
ServiceRequest.supportingInfo 0..* Reference(Resource) Additional clinical information
ServiceRequest.bodySite This element is included in summaries. 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
ServiceRequest.bodySite.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.bodySite.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
ServiceRequest.bodySite.text This element is included in summaries. 0..1 string Plain text representation of the concept
ServiceRequest.note This element must be supported. 0..* BeCodedAnnotation(2.2.0) Comments
ServiceRequest.note.id 0..1 string Unique id for inter-element referencing
ServiceRequest.note.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ServiceRequest.note.Slices for extension.extension:code 0..1 (Complex) Code
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept
ServiceRequest.note.Slices for extension.extension:code.id 0..1 string Unique id for inter-element referencing
ServiceRequest.note.Slices for extension.extension:code.extension 0..0 Extension
Slice: Unordered, Open by value:url
ServiceRequest.note.Slices for extension.extension:code.url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept"
ServiceRequest.note.Slices for extension.extension:code.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.
ServiceRequest.note.text This element is included in summaries. 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.1.1 eReferral Prescription Implementation Guide v1.1
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.1.1 eReferral Prescription Implementation Guide v1.1

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

Mandatory: 1 element
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