v3.0.0
draft
eReferral Implementation Guide
3.0.0 -
v3.0.0
draft
eReferral Implementation Guide
3.0.0 -
eReferral Implementation Guide, published by Riziv-Inami Platform. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/referral-uhmep/ and changes regularly. See the Directory of published versions
| Official URL: https://www.riziv-inami.be/standards/fhir/ereferral/StructureDefinition/ereferral-servicerequest-nursing | Version: 3.0.0 | |||
| Draft as of 2026-10-29 | Computable Name: EReferralServiceRequestNursing | |||
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 of Profiles, Differentials, Snapshots, and their representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | BeReferralServiceRequestNursing | A request for a service to be performed Constraints: prr-1 |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   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 (2.2.0) (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 (preferred) | |
  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 |
2..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system 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: eReferral Categories of Care (preferred): Categories of care that can be prescribed. See ValueSet. Fixed Value: | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| category:prescriptionType |
1..1 | CodeableConcept | Technical prescription type for nursing referrals Binding: eReferral Nursing Prescription Technical Type (required) | |
 coding |
1..1 | Coding | Code defined by a terminology system | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type (no extensions allowed) | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: eReferral Nursing Care Requested (preferred): 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: ServiceRequestOrderDetailsCodes (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| Slices for quantity[x] |
0..1 | Quantity | 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 | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| subject |
1..1 | Reference(BePatient(2.2.0)) | 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. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| 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 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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.2.0)) | Prescriber of the requested service | |
| reasonCode |
1..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 ValueSet (required) | |
| note |
0..* | BeCodedAnnotation(2.2.0) | Comments | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
| text |
1..1 | markdown | The annotation - plain text without markdown is strongly recommended | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | preferred | BeVSPrescriptionStatusReason | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | preferred | eReferral Categories of Care | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.category:prescriptionType | Base | required | eReferral Nursing Prescription Technical Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.code | Base | preferred | eReferral Nursing Care Requested | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📦4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | BeReferralServiceRequestNursing | A request for a service to be performed | |
 meta |
||||
| versionId |
0..0 | Version specific identifier | ||
| lastUpdated |
0..0 | When the resource version last changed | ||
| source |
0..0 | Identifies where the resource comes from | ||
| security |
0..0 | Security Labels applied to this resource | ||
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
Content/Rules for all slices | |||
| extension:device |
0..0 | BeExtCodeableReference | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| requisition |
0..0 | Composite Request ID | ||
| category |
2..* | CodeableConcept | Classification of service | |
| Slices for category |
Content/Rules for all slices | |||
| category:discipline |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| category:prescriptionType |
1..1 | CodeableConcept | Technical prescription type for nursing referrals Binding: eReferral Nursing Prescription Technical Type (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type (no extensions allowed) | |
| doNotPerform |
0..0 | True if service/procedure should not be performed | ||
| orderDetail |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| quantity[x] |
0..1 | Quantity | Service amount | |
| Slices for quantity[x] |
Content/Rules for all slices | |||
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| comparator |
0..0 | < | <= | >= | > - how to understand the value | ||
| encounter |
0..0 | Encounter in which the request was created | ||
| Slices for occurrence[x] |
Content/Rules for all slices | |||
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| event |
0..0 | When the event occurs | ||
 repeat |
||||
 bounds[x] |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| countMax |
0..0 | Maximum number of times to repeat | ||
| durationMax |
0..0 | How long when it happens (Max) | ||
| frequencyMax |
0..0 | Event occurs up to frequencyMax times per period | ||
| periodMax |
0..0 | Upper limit of period (3-4 hours) | ||
| dayOfWeek |
0..0 | mon | tue | wed | thu | fri | sat | sun | ||
| timeOfDay |
0..0 | Time of day for action | ||
| offset |
0..0 | Minutes from event (before or after) | ||
| code |
0..0 | BID | TID | QID | AM | PM | QD | QOD | + | ||
| asNeeded[x] |
0..0 | Preconditions for service | ||
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..0 | Requested location | ||
| reasonCode |
1..1 | CodeableConcept | Explanation/Justification for procedure or service | |
| reasonReference |
0..0 | Explanation/Justification for service or service | ||
| insurance |
0..0 | Associated insurance coverage | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| note |
||||
| author[x] |
0..0 | Individual responsible for the annotation | ||
| time |
0..0 | When the annotation was made | ||
| patientInstruction |
0..0 | Patient or consumer-oriented instructions | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.category:prescriptionType | Base | required | eReferral Nursing Prescription Technical Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequestNursing | 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 (2.2.0) (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 (preferred) | |
| 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) | |
| 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 |
2..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system 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: eReferral Categories of Care (preferred): Categories of care that can be prescribed. See ValueSet. Fixed Value: | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| 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 |
1..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 | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| category:prescriptionType |
1..1 | CodeableConcept | Technical prescription type for nursing referrals Binding: eReferral Nursing Prescription Technical Type (required) | |
| 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 |
1..1 | 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 |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type (no extensions allowed) | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: eReferral Nursing Care Requested (preferred): 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: ServiceRequestOrderDetailsCodes (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| 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 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for quantity[x] |
0..1 | Quantity | 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 | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| 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.2.0)) | 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. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| repeat |
C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for bounds[x] |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, 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 | |
| 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 | |
| period |
0..1 | decimal | Event occurs frequency times per period | |
| 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). | |
| 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.2.0)) | Prescriber of the requested service | |
| reasonCode |
1..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 |
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 ValueSet (required) | |
| coding |
0..* | Coding | Code defined by a terminology system | |
| text |
0..1 | string | Plain text representation of the concept | |
| note |
0..* | BeCodedAnnotation(2.2.0) | Comments | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: eReferral Note Type (preferred) | |
| 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 | preferred | BeVSPrescriptionStatusReason | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:UHMEP.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | preferred | eReferral Categories of Care | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.category:prescriptionType | Base | required | eReferral Nursing Prescription Technical Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | preferred | eReferral Nursing Care Requested | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📦4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.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. |
| ServiceRequest.note.extension:code.value[x] | Base | preferred | eReferral Note Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| 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()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequestNursing | A request for a service to be performed Constraints: prr-1 |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 (2.2.0) (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 (preferred) | |
| 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 |
2..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system 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: eReferral Categories of Care (preferred): Categories of care that can be prescribed. See ValueSet. Fixed Value: | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| category:prescriptionType |
1..1 | CodeableConcept | Technical prescription type for nursing referrals Binding: eReferral Nursing Prescription Technical Type (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type (no extensions allowed) | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: eReferral Nursing Care Requested (preferred): 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: ServiceRequestOrderDetailsCodes (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| Slices for quantity[x] |
0..1 | Quantity | 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 | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| system |
C | 0..1 | uri | System that defines coded unit form |
| code |
0..1 | code | Coded form of the unit | |
| subject |
1..1 | Reference(BePatient(2.2.0)) | 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. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| 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 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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.2.0)) | Prescriber of the requested service | |
| reasonCode |
1..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 ValueSet (required) | |
| note |
0..* | BeCodedAnnotation(2.2.0) | Comments | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
| text |
1..1 | markdown | The annotation - plain text without markdown is strongly recommended | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.extension:statusReason.value[x] | Base | preferred | BeVSPrescriptionStatusReason | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | preferred | eReferral Categories of Care | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.category:prescriptionType | Base | required | eReferral Nursing Prescription Technical Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.code | Base | preferred | eReferral Nursing Care Requested | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📦4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | BeReferralServiceRequestNursing | A request for a service to be performed | |
| meta |
||||
| versionId |
0..0 | Version specific identifier | ||
| lastUpdated |
0..0 | When the resource version last changed | ||
| source |
0..0 | Identifies where the resource comes from | ||
| security |
0..0 | Security Labels applied to this resource | ||
| tag |
0..0 | Tags applied to this resource | ||
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
Content/Rules for all slices | |||
| extension:device |
0..0 | BeExtCodeableReference | ||
| instantiatesCanonical |
0..0 | Instantiates FHIR protocol or definition | ||
| instantiatesUri |
0..0 | Instantiates external protocol or definition | ||
| requisition |
0..0 | Composite Request ID | ||
| category |
2..* | CodeableConcept | Classification of service | |
| Slices for category |
Content/Rules for all slices | |||
| category:discipline |
1..1 | CodeableConcept | Category that identifies the type of referral (e.g., nursing, physiotherapy) | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct (no extensions allowed) | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| category:prescriptionType |
1..1 | CodeableConcept | Technical prescription type for nursing referrals Binding: eReferral Nursing Prescription Technical Type (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type (no extensions allowed) | |
| doNotPerform |
0..0 | True if service/procedure should not be performed | ||
| orderDetail |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| coding |
||||
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| quantity[x] |
0..1 | Quantity | Service amount | |
| Slices for quantity[x] |
Content/Rules for all slices | |||
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| comparator |
0..0 | < | <= | >= | > - how to understand the value | ||
| encounter |
0..0 | Encounter in which the request was created | ||
| Slices for occurrence[x] |
Content/Rules for all slices | |||
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |
| id |
0..0 | Unique id for inter-element referencing | ||
| extension |
0..0 | Extension | ||
| modifierExtension |
0..0 | Extension | ||
| event |
0..0 | When the event occurs | ||
| repeat |
||||
| bounds[x] |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | |
| countMax |
0..0 | Maximum number of times to repeat | ||
| durationMax |
0..0 | How long when it happens (Max) | ||
| frequencyMax |
0..0 | Event occurs up to frequencyMax times per period | ||
| periodMax |
0..0 | Upper limit of period (3-4 hours) | ||
| dayOfWeek |
0..0 | mon | tue | wed | thu | fri | sat | sun | ||
| timeOfDay |
0..0 | Time of day for action | ||
| offset |
0..0 | Minutes from event (before or after) | ||
| code |
0..0 | BID | TID | QID | AM | PM | QD | QOD | + | ||
| asNeeded[x] |
0..0 | Preconditions for service | ||
| locationCode |
0..0 | Requested location | ||
| locationReference |
0..0 | Requested location | ||
| reasonCode |
1..1 | CodeableConcept | Explanation/Justification for procedure or service | |
| reasonReference |
0..0 | Explanation/Justification for service or service | ||
| insurance |
0..0 | Associated insurance coverage | ||
| specimen |
0..0 | Procedure Samples | ||
| bodySite |
||||
| id |
0..0 | Unique id for inter-element referencing | ||
| note |
||||
| author[x] |
0..0 | Individual responsible for the annotation | ||
| time |
0..0 | When the annotation was made | ||
| patientInstruction |
0..0 | Patient or consumer-oriented instructions | ||
| relevantHistory |
0..0 | Request provenance | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.category:prescriptionType | Base | required | eReferral Nursing Prescription Technical Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequestNursing | 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 | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| 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 (2.2.0) (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 (preferred) | |
| 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) | |
| 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 |
2..* | CodeableConcept | Classification of service Slice: Unordered, Open by value:coding.system 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: eReferral Categories of Care (preferred): Categories of care that can be prescribed. See ValueSet. Fixed Value: | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| 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 |
1..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 | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| category:prescriptionType |
1..1 | CodeableConcept | Technical prescription type for nursing referrals Binding: eReferral Nursing Prescription Technical Type (required) | |
| 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 |
1..1 | 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 |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type (no extensions allowed) | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: eReferral Nursing Care Requested (preferred): 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: ServiceRequestOrderDetailsCodes (example): The actual valueset will be provided when a terminology package is available. For current guidance, see the included ValueSet. |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| 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 | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for quantity[x] |
0..1 | Quantity | 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 | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| value |
0..1 | decimal | Numerical value (with implicit precision) | |
| 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.2.0)) | 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. | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| repeat |
C | 0..1 | Element | When the event is to occur Constraints: tim-1, tim-2, tim-4, tim-5, tim-6, tim-7, tim-8, tim-9, tim-10 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for bounds[x] |
0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, 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 | |
| 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 | |
| period |
0..1 | decimal | Event occurs frequency times per period | |
| 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). | |
| 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.2.0)) | Prescriber of the requested service | |
| reasonCode |
1..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 |
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 ValueSet (required) | |
| coding |
0..* | Coding | Code defined by a terminology system | |
| text |
0..1 | string | Plain text representation of the concept | |
| note |
0..* | BeCodedAnnotation(2.2.0) | Comments | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: eReferral Note Type (preferred) | |
| 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 | preferred | BeVSPrescriptionStatusReason | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.identifier:UHMEP.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:UHMEP.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:SHORT.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category:discipline | Base | preferred | eReferral Categories of Care | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.category:prescriptionType | Base | required | eReferral Nursing Prescription Technical Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | preferred | eReferral Nursing Care Requested | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📦4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | Base | required | UnitsOfTime | 📍4.0.1 | FHIR Std. |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.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. |
| ServiceRequest.note.extension:code.value[x] | Base | preferred | eReferral Note Type | 📦1.1.1 | eReferral Prescription Implementation Guide v1.1 |
| 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()
|
Other representations of profile: CSV, Excel, Schematron
IG © 2026+ Riziv-Inami Platform.
Package inami.fhir.be.ereferral#3.0.0 based on FHIR 4.0.1.
Generated 2026-10-29
