Digital Referral Prescription Implementation Guide
1.0.0 - STU
Digital Referral Prescription Implementation Guide
1.0.0 - STU
Digital Referral Prescription Implementation Guide, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/referral/ and changes regularly. See the Directory of published versions
| Official URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-referral-servicerequest-nursing | Version: 1.0.0 | ||||
| Active as of 2026-11-01 | Computable Name: BeReferralServiceRequestNursing | ||||
The nursing profile, generic version. Please note the nursing referral for medication does NOT depend on this generic version but is a FHIR prodfile on a different FHIR resource (MedicationRequest)
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:feedback |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |
| extension:validity |
1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |
| extension:latest |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |
| extension:performerType |
0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of insufficient cardinality URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | |
 extension:statusReason |
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 (example) | |
 extension:device |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |
   Slices for extension |
Content/Rules for all slices | |||
 extension:reference |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "reference" | |
| extension:concept |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "concept" | |
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
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 | |
| identifier:UHMEP |
0..1 | Identifier | Reference ID of the UHMEP once available there | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| identifier:SHORT |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
 basedOn |
0..* | Reference(ServiceRequest | MedicationRequest) | What request fulfills | |
| replaces |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| Slices for category |
1..* | 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 | |
| category:discipline |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) Binding: DRP Categories of Care (required): Categories of care that can be prescribed. See ValueSet. | |
 category:prescriptionType |
0..1 | CodeableConcept | Additional category that can be taylored to use-case specific purposes (e.g., prescription type for nursing, etc.) Binding: DRP Prescription Type (required): Technical types of prescriptions for routing and workflow. See ValueSet. | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| orderDetail |
C | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. |
| Slices for quantity[x] |
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 | ||
| quantityQuantity |
Quantity | |||
| quantityRatio |
Ratio | |||
| quantityRange |
Range | |||
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| subject |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 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 |
| Slices for bounds[x] |
0..1 | 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 | ||
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| Slices for bounds[x] |
Content/Rules for all slices | |||
| bounds[x]:boundsDuration |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| 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 | |
 when |
0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | |
| authoredOn |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date |
| requester |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |
| reasonCode |
0..1 | 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. | |
 Slices for extension |
Content/Rules for all slices | |||
| extension:bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note |
0..* | BeCodedAnnotation | Comments | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension |
0..0 | 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | example | BeVSPrescriptionStatusReason | 📦1.0.0 | This IG |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | required | DRP Categories of Care | 📦1.0.0 | This IG |
| ServiceRequest.category:prescriptionType | Base | required | DRP Prescription Type | 📦1.0.0 | This IG |
| ServiceRequest.code | Base | example | BeVSRequestedServicesNurse | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail | Base | example | BeVSRequestedServicesNurseDetail | 📦1.0.0 | This IG |
| ServiceRequest.quantity[x]:quantityQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | Base | required | EventTiming | 📍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. |
| Id | Grade | Path(s) | Description | Expression |
| be-inv-long-date | warning | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
empty() or toString().length()=25
|
| be-inv-uhmep-short | warning | ServiceRequest.identifier:SHORT | The format of UHMEP-SHORT is 6 capital alphanumerics, without O |
Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| tim-1 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
This structure is derived from BeReferralServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | BeReferralServiceRequest | A request for a service to be performed | |
| basedOn |
0..* | Reference(ServiceRequest | MedicationRequest) | What request fulfills | |
 category |
1..* | CodeableConcept | Classification of service | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |
| code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 (no extensions allowed) | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| orderDetail |
0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| 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 | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
| repeat |
||||
| Slices for bounds[x] |
0..1 | Duration, Range, Period | 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 | |
| Slices for bounds[x] |
Content/Rules for all slices | |||
| bounds[x]:boundsDuration |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| 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) | |
| frequency |
0..1 | positiveInt | Event occurs frequency times per period | |
| when |
0..* | code | Code for time period of occurrence | |
| reasonCode |
0..1 | CodeableConcept | Explanation/Justification for procedure or service | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | example | BeVSRequestedServicesNurse | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail | Base | example | BeVSRequestedServicesNurseDetail | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:feedback |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |||||
| extension:validity |
1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |||||
| extension:latest |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |||||
| extension:performerType |
0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of insufficient cardinality URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | |||||
| extension:statusReason |
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 (example) | |||||
| extension:device |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:reference |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "reference" | |||||
| value[x] |
0..1 | Reference(DeviceDefinition) | Value of extension | |||||
| extension:concept |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "concept" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension | |||||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
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 | |||||
| identifier:UHMEP |
0..1 | Identifier | Reference ID of the UHMEP once available there | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |||||
| 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 |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |||||
| requisition |
0..1 | Identifier | Composite Request ID | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |||||
| Slices for category |
1..* | 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 | |||||
| category:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 (no extensions allowed) | |||||
| 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 | |||||
| category:discipline |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) Binding: DRP Categories of Care (required): Categories of care that can be prescribed. See ValueSet. | |||||
| category:prescriptionType |
0..1 | CodeableConcept | Additional category that can be taylored to use-case specific purposes (e.g., prescription type for nursing, etc.) Binding: DRP Prescription Type (required): Technical types of prescriptions for routing and workflow. See ValueSet. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |||||
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |||||
| orderDetail |
C | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | ||||
| Slices for quantity[x] |
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 | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation | |||||
| system |
C | 0..1 | uri | System that defines coded unit form | ||||
| code |
0..1 | code | Coded form of the unit | |||||
| subject |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |||||
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| event |
0..* | dateTime | When the event occurs | |||||
| repeat |
C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] |
0..1 | 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 | ||||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| Slices for bounds[x] |
Content/Rules for all slices | |||||||
| bounds[x]:boundsDuration |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |||||
| count |
0..1 | positiveInt | Number of times to repeat | |||||
| countMax |
0..1 | positiveInt | Maximum number of times to repeat | |||||
| duration |
0..1 | decimal | How long when it happens | |||||
| durationMax |
0..1 | decimal | How long when it happens (Max) | |||||
| durationUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | |||||
| frequency |
0..1 | positiveInt | Event occurs frequency times per period | |||||
| frequencyMax |
0..1 | positiveInt | Event occurs up to frequencyMax times per period | |||||
| period |
0..1 | decimal | Event occurs frequency times per period | |||||
| periodMax |
0..1 | decimal | Upper limit of period (3-4 hours) | |||||
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | |||||
| dayOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |||||
| timeOfDay |
0..* | time | Time of day for action | |||||
| when |
0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | |||||
| offset |
0..1 | unsignedInt | Minutes from event (before or after) | |||||
| code |
0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | |||||
 asNeeded[x] |
0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | ||||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date | ||||
| requester |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |||||
| locationCode |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | |||||
| locationReference |
0..* | Reference(Location) | Requested location | |||||
| reasonCode |
0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
0..* | Reference(Specimen) | Procedure Samples | |||||
| bodySite |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| note |
0..* | BeCodedAnnotation | Comments | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | 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: DRP Note Type (example) | |||||
| author[x] |
0..1 | Individual responsible for the annotation | ||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
0..1 | dateTime | When the annotation was made | |||||
| text |
1..1 | markdown | The annotation - plain text without markdown is strongly recommended | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.extension:statusReason.value[x] | Base | example | BeVSPrescriptionStatusReason | 📦1.0.0 | This IG |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:UHMEP.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | required | DRP Categories of Care | 📦1.0.0 | This IG |
| ServiceRequest.category:prescriptionType | Base | required | DRP Prescription Type | 📦1.0.0 | This IG |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | BeVSRequestedServicesNurse | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail | Base | example | BeVSRequestedServicesNurseDetail | 📦1.0.0 | This IG |
| ServiceRequest.quantity[x]:quantityQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.code | Base | preferred | TimingAbbreviation | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v7.5 |
| 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 | example | DRP Note Type | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| be-inv-long-date | warning | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
empty() or toString().length()=25
|
| be-inv-uhmep-short | warning | ServiceRequest.identifier:SHORT | The format of UHMEP-SHORT is 6 capital alphanumerics, without O |
Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| tim-1 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
This structure is derived from BeReferralServiceRequest
Summary
Must-Support: 10 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:feedback |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |
| extension:validity |
1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |
| extension:latest |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |
| extension:performerType |
0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of insufficient cardinality URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | |
| extension:statusReason |
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 (example) | |
| extension:device |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:reference |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "reference" | |
| extension:concept |
0..1 | Extension | Extension | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "concept" | |
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
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 | |
| identifier:UHMEP |
0..1 | Identifier | Reference ID of the UHMEP once available there | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| identifier:SHORT |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 | |
| basedOn |
0..* | Reference(ServiceRequest | MedicationRequest) | What request fulfills | |
| replaces |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| Slices for category |
1..* | 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 | |
| category:discipline |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) Binding: DRP Categories of Care (required): Categories of care that can be prescribed. See ValueSet. | |
| category:prescriptionType |
0..1 | CodeableConcept | Additional category that can be taylored to use-case specific purposes (e.g., prescription type for nursing, etc.) Binding: DRP Prescription Type (required): Technical types of prescriptions for routing and workflow. See ValueSet. | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| orderDetail |
C | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. |
| Slices for quantity[x] |
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 | ||
| quantityQuantity |
Quantity | |||
| quantityRatio |
Ratio | |||
| quantityRange |
Range | |||
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| subject |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| 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 |
| Slices for bounds[x] |
0..1 | 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 | ||
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| Slices for bounds[x] |
Content/Rules for all slices | |||
| bounds[x]:boundsDuration |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| 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 | |
| when |
0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | |
| authoredOn |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date |
| requester |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |
| reasonCode |
0..1 | 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. | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note |
0..* | BeCodedAnnotation | Comments | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension |
0..0 | 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 | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | example | BeVSPrescriptionStatusReason | 📦1.0.0 | This IG |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | required | DRP Categories of Care | 📦1.0.0 | This IG |
| ServiceRequest.category:prescriptionType | Base | required | DRP Prescription Type | 📦1.0.0 | This IG |
| ServiceRequest.code | Base | example | BeVSRequestedServicesNurse | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail | Base | example | BeVSRequestedServicesNurseDetail | 📦1.0.0 | This IG |
| ServiceRequest.quantity[x]:quantityQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | Base | required | EventTiming | 📍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. |
| Id | Grade | Path(s) | Description | Expression |
| be-inv-long-date | warning | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
empty() or toString().length()=25
|
| be-inv-uhmep-short | warning | ServiceRequest.identifier:SHORT | The format of UHMEP-SHORT is 6 capital alphanumerics, without O |
Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| tim-1 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
Differential View
This structure is derived from BeReferralServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | BeReferralServiceRequest | A request for a service to be performed | |
| basedOn |
0..* | Reference(ServiceRequest | MedicationRequest) | What request fulfills | |
| category |
1..* | CodeableConcept | Classification of service | |
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |
| code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 (no extensions allowed) | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| orderDetail |
0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |
| 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 | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| system |
0..1 | uri | System that defines coded unit form | |
| code |
0..1 | code | Coded form of the unit | |
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
| repeat |
||||
| Slices for bounds[x] |
0..1 | Duration, Range, Period | 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 | |
| Slices for bounds[x] |
Content/Rules for all slices | |||
| bounds[x]:boundsDuration |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| 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) | |
| frequency |
0..1 | positiveInt | Event occurs frequency times per period | |
| when |
0..* | code | Code for time period of occurrence | |
| reasonCode |
0..1 | CodeableConcept | Explanation/Justification for procedure or service | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | example | BeVSRequestedServicesNurse | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail | Base | example | BeVSRequestedServicesNurseDetail | 📦1.0.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:feedback |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |||||
| extension:validity |
1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |||||
| extension:latest |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |||||
| extension:performerType |
0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of insufficient cardinality URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | |||||
| extension:statusReason |
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 (example) | |||||
| extension:device |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:reference |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "reference" | |||||
| value[x] |
0..1 | Reference(DeviceDefinition) | Value of extension | |||||
| extension:concept |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "concept" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension | |||||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
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 | |||||
| identifier:UHMEP |
0..1 | Identifier | Reference ID of the UHMEP once available there | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |||||
| 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 |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
| type |
0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep-short (no extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |||||
| requisition |
0..1 | Identifier | Composite Request ID | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |||||
| Slices for category |
1..* | 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 | |||||
| category:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 (no extensions allowed) | |||||
| 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 | |||||
| category:discipline |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) Binding: DRP Categories of Care (required): Categories of care that can be prescribed. See ValueSet. | |||||
| category:prescriptionType |
0..1 | CodeableConcept | Additional category that can be taylored to use-case specific purposes (e.g., prescription type for nursing, etc.) Binding: DRP Prescription Type (required): Technical types of prescriptions for routing and workflow. See ValueSet. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |||||
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | |||||
| orderDetail |
C | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. | ||||
| Slices for quantity[x] |
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 | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
| unit |
0..1 | string | Unit representation | |||||
| system |
C | 0..1 | uri | System that defines coded unit form | ||||
| code |
0..1 | code | Coded form of the unit | |||||
| subject |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |||||
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| event |
0..* | dateTime | When the event occurs | |||||
| repeat |
C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] |
0..1 | 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 | ||||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| Slices for bounds[x] |
Content/Rules for all slices | |||||||
| bounds[x]:boundsDuration |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |||||
| count |
0..1 | positiveInt | Number of times to repeat | |||||
| countMax |
0..1 | positiveInt | Maximum number of times to repeat | |||||
| duration |
0..1 | decimal | How long when it happens | |||||
| durationMax |
0..1 | decimal | How long when it happens (Max) | |||||
| durationUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | |||||
| frequency |
0..1 | positiveInt | Event occurs frequency times per period | |||||
| frequencyMax |
0..1 | positiveInt | Event occurs up to frequencyMax times per period | |||||
| period |
0..1 | decimal | Event occurs frequency times per period | |||||
| periodMax |
0..1 | decimal | Upper limit of period (3-4 hours) | |||||
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | |||||
| dayOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |||||
| timeOfDay |
0..* | time | Time of day for action | |||||
| when |
0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | |||||
| offset |
0..1 | unsignedInt | Minutes from event (before or after) | |||||
| code |
0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | |||||
| asNeeded[x] |
0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | ||||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date | ||||
| requester |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |||||
| locationCode |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | |||||
| locationReference |
0..* | Reference(Location) | Requested location | |||||
| reasonCode |
0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
0..* | Reference(Specimen) | Procedure Samples | |||||
| bodySite |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
| coding |
0..* | Coding | Code defined by a terminology system | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| note |
0..* | BeCodedAnnotation | Comments | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | 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: DRP Note Type (example) | |||||
| author[x] |
0..1 | Individual responsible for the annotation | ||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
0..1 | dateTime | When the annotation was made | |||||
| text |
1..1 | markdown | The annotation - plain text without markdown is strongly recommended | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.extension:statusReason.value[x] | Base | example | BeVSPrescriptionStatusReason | 📦1.0.0 | This IG |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:UHMEP.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | required | DRP Categories of Care | 📦1.0.0 | This IG |
| ServiceRequest.category:prescriptionType | Base | required | DRP Prescription Type | 📦1.0.0 | This IG |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | example | BeVSRequestedServicesNurse | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail | Base | example | BeVSRequestedServicesNurseDetail | 📦1.0.0 | This IG |
| ServiceRequest.quantity[x]:quantityQuantity.comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | Base | required | EventTiming | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.code | Base | preferred | TimingAbbreviation | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v7.5 |
| 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 | example | DRP Note Type | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| be-inv-long-date | warning | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
empty() or toString().length()=25
|
| be-inv-uhmep-short | warning | ServiceRequest.identifier:SHORT | The format of UHMEP-SHORT is 6 capital alphanumerics, without O |
Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue()
|
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present |
orderDetail.empty() or code.exists()
|
| tim-1 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a duration, there needs to be duration units |
duration.empty() or durationUnit.exists()
|
| tim-2 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a period, there needs to be period units |
period.empty() or periodUnit.exists()
|
| tim-4 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | duration SHALL be a non-negative value |
duration.exists() implies duration >= 0
|
| tim-5 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | period SHALL be a non-negative value |
period.exists() implies period >= 0
|
| tim-6 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a periodMax, there must be a period |
periodMax.empty() or period.exists()
|
| tim-7 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a durationMax, there must be a duration |
durationMax.empty() or duration.exists()
|
| tim-8 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a countMax, there must be a count |
countMax.empty() or count.exists()
|
| tim-9 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) |
offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))
|
| tim-10 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa |
timeOfDay.empty() or when.empty()
|
This structure is derived from BeReferralServiceRequest
Summary
Must-Support: 10 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ eHealth Platform.
Package hl7.fhir.be.drp#1.0.0 based on FHIR 4.0.1.
Generated
2026-11-01
Links:
Table of Contents |
QA Report
