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-telemonitoring | Version: 1.0.0 | ||||
| Draft as of 2026-11-01 | Computable Name: BeReferralServiceRequestTelemonitoring | ||||
Referral prescription for remote monitoring of vital parameters (inline-extension variant).
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: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |
![]() ![]() ![]() |
1..1 | (Complex) | BeValidityPeriod URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period" | |
![]() ![]() ![]() ![]() |
0..1 | Period | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (example) | |
![]() ![]() ![]() |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | |
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |
![]() ![]() ![]() |
0..* | (Complex) | Per-parameter alert thresholds and rate-of-change rules URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-telemonitoring-plan | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
0..1 | Identifier | Reference ID of the UHMEP once available there | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() ![]() |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |
![]() ![]() |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
![]() ![]() |
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. | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
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. Required Pattern: | |
![]() ![]() ![]() |
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. | |
![]() ![]() |
0..1 | boolean | True if service/procedure should not be performed | |
![]() ![]() |
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. | |
![]() ![]() |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
![]() ![]() |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |
![]() ![]() |
0..1 | 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 Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
![]() ![]() |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date |
![]() ![]() |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |
![]() ![]() |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |
![]() ![]() |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
![]() ![]() |
0..* | BeCodedAnnotation | Comments | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
![]() ![]() ![]() |
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 | Procedure Codes (SNOMED CT) | 📦4.0.1 | FHIR Std. |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍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()
|
This structure is derived from BeReferralServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | BeReferralServiceRequest | A request for a service to be performed | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BeValidityPeriod | BeValidityPeriod | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
![]() ![]() ![]() |
0..* | (Complex) | Per-parameter alert thresholds and rate-of-change rules URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-telemonitoring-plan | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) Required Pattern: | |
![]() ![]() |
0..1 | dateTime, Period, Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |
![]() ![]() ![]() |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |||||
![]() ![]() ![]() |
1..1 | (Complex) | BeValidityPeriod URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period" | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (example) | |||||
![]() ![]() ![]() |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(DeviceDefinition) | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |||||
![]() ![]() ![]() |
0..* | (Complex) | Per-parameter alert thresholds and rate-of-change rules URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-telemonitoring-plan | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | Identifier | Reference ID of the UHMEP once available there | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |||||
![]() ![]() |
0..1 | Identifier | Composite Request ID | |||||
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
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. Required Pattern: | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() |
0..1 | boolean | True if service/procedure should not be performed | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
![]() ![]() |
0..1 | Service amount | ||||||
![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
![]() ![]() |
0..1 | 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 Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |||||
![]() ![]() |
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. | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date | ||||
![]() ![]() |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |||||
![]() ![]() |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | |||||
![]() ![]() |
0..* | Reference(Location) | Requested location | |||||
![]() ![]() |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |||||
![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |||||
![]() ![]() |
0..* | Reference(Specimen) | Procedure Samples | |||||
![]() ![]() |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
0..* | BeCodedAnnotation | Comments | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: DRP Note Type (example) | |||||
![]() ![]() ![]() |
0..1 | Individual responsible for the annotation | ||||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | dateTime | When the annotation was made | |||||
![]() ![]() ![]() |
1..1 | markdown | The annotation - plain text without markdown is strongly recommended | |||||
![]() ![]() |
0..1 | string | Patient or consumer-oriented instructions | |||||
![]() ![]() |
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 | Procedure Codes (SNOMED CT) | 📦4.0.1 | FHIR Std. |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍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()
|
This structure is derived from BeReferralServiceRequest
Summary
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |
![]() ![]() ![]() |
1..1 | (Complex) | BeValidityPeriod URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period" | |
![]() ![]() ![]() ![]() |
0..1 | Period | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
![]() ![]() ![]() |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (example) | |
![]() ![]() ![]() |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | |
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |
![]() ![]() ![]() |
0..* | (Complex) | Per-parameter alert thresholds and rate-of-change rules URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-telemonitoring-plan | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
0..1 | Identifier | Reference ID of the UHMEP once available there | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() ![]() |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |
![]() ![]() |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |
![]() ![]() |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
![]() ![]() |
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. | |
![]() ![]() |
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 | |
![]() ![]() ![]() |
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. Required Pattern: | |
![]() ![]() ![]() |
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. | |
![]() ![]() |
0..1 | boolean | True if service/procedure should not be performed | |
![]() ![]() |
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. | |
![]() ![]() |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
![]() ![]() |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |
![]() ![]() |
0..1 | 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 Other type slices that contain no new information are not shown in this view | ||
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
Timing | |||
![]() ![]() ![]() |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
![]() ![]() |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date |
![]() ![]() |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |
![]() ![]() |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |
![]() ![]() |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
![]() ![]() |
0..* | BeCodedAnnotation | Comments | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
![]() ![]() ![]() |
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 | Procedure Codes (SNOMED CT) | 📦4.0.1 | FHIR Std. |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍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()
|
Differential View
This structure is derived from BeReferralServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | BeReferralServiceRequest | A request for a service to be performed | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BeValidityPeriod | BeValidityPeriod | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | Starting time with inclusive boundary | |
![]() ![]() ![]() ![]() ![]() |
0..1 | dateTime | End time with inclusive boundary, if not ongoing | |
![]() ![]() ![]() |
0..* | (Complex) | Per-parameter alert thresholds and rate-of-change rules URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-telemonitoring-plan | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) Required Pattern: | |
![]() ![]() |
0..1 | dateTime, Period, Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. 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 | |
![]() ![]() ![]() |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed Constraints: prr-1 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | boolean | Whether prescriber requests feedback URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-feedback-to-prescriber | |||||
![]() ![]() ![]() |
1..1 | (Complex) | BeValidityPeriod URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-validity-period" | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
0..1 | dateTime | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-latest-end-date | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (example) | |||||
![]() ![]() ![]() |
0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(DeviceDefinition) | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |||||
![]() ![]() ![]() |
0..* | (Complex) | Per-parameter alert thresholds and rate-of-change rules URL: https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/be-ext-telemonitoring-plan | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | Identifier | Reference ID of the UHMEP once available there | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/drp/NamingSystem/uhmep (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
C | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) Constraints: be-inv-uhmep-short | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
![]() ![]() |
0..* | Reference(ServiceRequest) | The request that this is a continuation of | |||||
![]() ![]() |
0..1 | Identifier | Composite Request ID | |||||
![]() ![]() |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
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. Required Pattern: | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |||||
![]() ![]() |
0..1 | boolean | True if service/procedure should not be performed | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
![]() ![]() |
0..1 | Service amount | ||||||
![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() |
1..1 | Reference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
![]() ![]() |
0..1 | 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 Other type slices that contain no new information are not shown in this view | ||||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |||||
![]() ![]() |
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. | ||||||
![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() |
C | 1..1 | dateTime | Date request signed Constraints: be-inv-long-date | ||||
![]() ![]() |
1..1 | Reference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | |||||
![]() ![]() |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (3.0.0) (example): A location type where services are delivered. | |||||
![]() ![]() |
0..* | Reference(Location) | Requested location | |||||
![]() ![]() |
0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | |||||
![]() ![]() |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
![]() ![]() |
0..* | Reference(Resource) | Additional clinical information | |||||
![]() ![]() |
0..* | Reference(Specimen) | Procedure Samples | |||||
![]() ![]() |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
0..* | BeCodedAnnotation | Comments | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: DRP Note Type (example) | |||||
![]() ![]() ![]() |
0..1 | Individual responsible for the annotation | ||||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | dateTime | When the annotation was made | |||||
![]() ![]() ![]() |
1..1 | markdown | The annotation - plain text without markdown is strongly recommended | |||||
![]() ![]() |
0..1 | string | Patient or consumer-oriented instructions | |||||
![]() ![]() |
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 | Procedure Codes (SNOMED CT) | 📦4.0.1 | FHIR Std. |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍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()
|
This structure is derived from BeReferralServiceRequest
Summary
Must-Support: 4 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron