Referral Prescription
1.0.0 - STU
Referral Prescription
1.0.0 - STU
Referral Prescription, published by . 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/referral/StructureDefinition/be-referral-servicerequest-nursing | Version: 1.0.0 | |||
| Draft as of 2021-07-15 | Computable Name: BeReferralServiceRequestNursing | |||
The nursing profile, generic version. Please note the nursing referral for medication does NOT depend on this generic version but is a FHIR prodfile on a different FHIR resource (MedicationRequest)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from BeReferralServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
0..* | BeReferralServiceRequest | A request for a service to be performed | |
  category |
||||
  coding |
||||
  system |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
 code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (required) | |
| orderDetail |
0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (required) | |
 Slices for quantity[x] |
0..1 | Quantity, Ratio, Range | Service amount Slice: Unordered, Open by type:$this | |
  quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
 value |
S | 0..1 | decimal | Numerical value (with implicit precision) |
| system |
S | 0..1 | uri | System that defines coded unit form |
 code |
S | 0..1 | code | Coded form of the unit |
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceTiming |
S | 0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. |
 repeat |
||||
| Slices for bounds[x] |
0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
 bounds[x]:boundsDuration |
S | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
| count |
S | 0..1 | positiveInt | Number of times to repeat |
| duration |
S | 0..1 | decimal | How long when it happens |
| durationUnit |
S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
| frequency |
S | 0..1 | positiveInt | Event occurs frequency times per period |
| when |
S | 0..* | code | Code for time period of occurrence |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | required | BeVSRequestedServicesNursehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nursefrom this IG | |
| ServiceRequest.orderDetail | required | BeVSRequestedServicesNurseDetailhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nurse-detailfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-body-site: if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 validity |
S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period |
| latest |
S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date |
| performerType |
S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) |
 statusReason |
S | 0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |
 value[x] |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (extensible) | |
| device |
S | 0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference |
 Slices for extension |
Content/Rules for all slices | |||
 extension:reference |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "reference" | |
| extension:concept |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "concept" | |
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
| 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/referral/NamingSystem/uhmep |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:SHORT |
ΣC | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) be-inv-uhmep-short: The format of UHMEP-SHORT is 6 capital alphanumerics, without O |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
 basedOn |
SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVSRequestIntent (required) |
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: BeReferralCategory (extensible) |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (required) |
| orderDetail |
SΣC | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (required) |
| Slices for quantity[x] |
Σ | 0..1 | Service amount Slice: Unordered, Open by type:$this | |
| quantityQuantity |
Quantity | |||
| quantityRatio |
Ratio | |||
| quantityRange |
Range | |||
| quantity[x]:quantityQuantity |
Σ | 0..1 | Quantity | Service amount |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| system |
SΣC | 0..1 | uri | System that defines coded unit form |
| code |
SΣ | 0..1 | code | Coded form of the unit |
| subject |
SΣ | 1..1 | BeContainedOrLogicalReference(BePatient(2.1.2)) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] |
SΣ | 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 |
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| bounds[x]:boundsDuration |
SΣ | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
| count |
SΣ | 0..1 | positiveInt | Number of times to repeat |
| duration |
SΣ | 0..1 | decimal | How long when it happens |
| durationUnit |
SΣ | 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 |
SΣ | 0..1 | positiveInt | Event occurs frequency times per period |
| when |
SΣ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
 asNeeded[x] |
SΣ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| authoredOn |
SΣC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| requester |
SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole(2.1.2)) | Prescriber of the requested service |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| Slices for extension |
Content/Rules for all slices | |||
| bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note |
S | 0..* | BeCodedAnnotation | Text node with attribution |
| Slices for extension |
Content/Rules for all slices | |||
| code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension |
0..0 | |||
| 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 |
| patientInstruction |
SΣ | 0..1 | string | Patient or consumer-oriented instructions |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | |
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | |
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | |
| ServiceRequest.code | required | BeVSRequestedServicesNursehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nursefrom this IG | |
| ServiceRequest.orderDetail | required | BeVSRequestedServicesNurseDetailhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nurse-detailfrom this IG | |
| ServiceRequest.quantity[x]:quantityQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | |
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-body-site | error | ServiceRequest | if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing : bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue() | |
| be-inv-long-date | error | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
| be-inv-uhmep-short | error | 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 | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-body-site: if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| validity |
S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period | ||||
| latest |
S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date | ||||
| performerType |
S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | ||||
| statusReason |
S | 0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (extensible) | |||||
| device |
S | 0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:reference |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "reference" | |||||
| value[x] |
0..1 | Reference(DeviceDefinition) | Value of extension | |||||
| extension:concept |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "concept" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension | |||||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | ||||
| 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/referral/NamingSystem/uhmep | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:SHORT |
ΣC | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) be-inv-uhmep-short: The format of UHMEP-SHORT is 6 capital alphanumerics, without O | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVSRequestIntent (required) | ||||
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: BeReferralCategory (extensible) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | ||||
| 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. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (required) | ||||
| orderDetail |
SΣC | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (required) | ||||
| Slices for quantity[x] |
Σ | 0..1 | Service amount Slice: Unordered, Open by type:$this | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| quantity[x]:quantityQuantity |
Σ | 0..1 | Quantity | Service amount | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit |
Σ | 0..1 | string | Unit representation | ||||
| system |
SΣC | 0..1 | uri | System that defines coded unit form | ||||
| code |
SΣ | 0..1 | code | Coded form of the unit | ||||
| subject |
SΣ | 1..1 | BeContainedOrLogicalReference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] |
SΣ | 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 | ||||
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| bounds[x]:boundsDuration |
SΣ | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | ||||
| count |
SΣ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
SΣ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
SΣ | 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 |
SΣ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
SΣ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| asNeeded[x] |
SΣ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
SΣC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) | ||||
| requester |
SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| note |
S | 0..* | BeCodedAnnotation | Text node with attribution | ||||
| 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 | |||||
| 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 | |||||||
| 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: BeVSRequestNoteType (required) | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - plain text without markdown is strongly recommended | ||||
| patientInstruction |
SΣ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | ||||
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:SHORT.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | ||||
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | required | BeVSRequestedServicesNursehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nursefrom this IG | ||||
| ServiceRequest.orderDetail | required | BeVSRequestedServicesNurseDetailhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nurse-detailfrom this IG | ||||
| ServiceRequest.quantity[x]:quantityQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-body-site | error | ServiceRequest | if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing : bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue() | |
| be-inv-long-date | error | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
| be-inv-uhmep-short | error | ServiceRequest.identifier:SHORT | The format of UHMEP-SHORT is 6 capital alphanumerics, without O : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue() | |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() | |
| tim-1 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from BeReferralServiceRequest
Summary
Mandatory: 1 element
Must-Support: 10 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from BeReferralServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
0..* | BeReferralServiceRequest | A request for a service to be performed | |
| category |
||||
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code |
0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | |
| code |
1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (required) | |
| orderDetail |
0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (required) | |
| Slices for quantity[x] |
0..1 | Quantity, Ratio, Range | Service amount Slice: Unordered, Open by type:$this | |
| quantity[x]:quantityQuantity |
0..1 | Quantity | Service amount | |
| value |
S | 0..1 | decimal | Numerical value (with implicit precision) |
| system |
S | 0..1 | uri | System that defines coded unit form |
| code |
S | 0..1 | code | Coded form of the unit |
| Slices for occurrence[x] |
0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceTiming |
S | 0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. |
| repeat |
||||
| Slices for bounds[x] |
0..1 | Duration, Range, Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
| bounds[x]:boundsDuration |
S | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
| count |
S | 0..1 | positiveInt | Number of times to repeat |
| duration |
S | 0..1 | decimal | How long when it happens |
| durationUnit |
S | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) |
| frequency |
S | 0..1 | positiveInt | Event occurs frequency times per period |
| when |
S | 0..* | code | Code for time period of occurrence |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.code | required | BeVSRequestedServicesNursehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nursefrom this IG | |
| ServiceRequest.orderDetail | required | BeVSRequestedServicesNurseDetailhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nurse-detailfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-body-site: if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| validity |
S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period |
| latest |
S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date |
| performerType |
S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) |
| statusReason |
S | 0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (extensible) | |
| device |
S | 0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference |
| Slices for extension |
Content/Rules for all slices | |||
| extension:reference |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "reference" | |
| extension:concept |
0..1 | Extension | Extension | |
| extension |
0..0 | |||
| url |
1..1 | uri | "concept" | |
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
| 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/referral/NamingSystem/uhmep |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:SHORT |
ΣC | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) be-inv-uhmep-short: The format of UHMEP-SHORT is 6 capital alphanumerics, without O |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| basedOn |
SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVSRequestIntent (required) |
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: BeReferralCategory (extensible) |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (required) |
| orderDetail |
SΣC | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (required) |
| Slices for quantity[x] |
Σ | 0..1 | Service amount Slice: Unordered, Open by type:$this | |
| quantityQuantity |
Quantity | |||
| quantityRatio |
Ratio | |||
| quantityRange |
Range | |||
| quantity[x]:quantityQuantity |
Σ | 0..1 | Quantity | Service amount |
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) |
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
| system |
SΣC | 0..1 | uri | System that defines coded unit form |
| code |
SΣ | 0..1 | code | Coded form of the unit |
| subject |
SΣ | 1..1 | BeContainedOrLogicalReference(BePatient(2.1.2)) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] |
SΣ | 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 |
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa |
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |
| boundsDuration |
Duration | |||
| boundsRange |
Range | |||
| boundsPeriod |
Period | |||
| bounds[x]:boundsDuration |
SΣ | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits |
| count |
SΣ | 0..1 | positiveInt | Number of times to repeat |
| duration |
SΣ | 0..1 | decimal | How long when it happens |
| durationUnit |
SΣ | 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 |
SΣ | 0..1 | positiveInt | Event occurs frequency times per period |
| when |
SΣ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. |
| asNeeded[x] |
SΣ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |
| asNeededBoolean |
boolean | |||
| asNeededCodeableConcept |
CodeableConcept | |||
| authoredOn |
SΣC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| requester |
SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole(2.1.2)) | Prescriber of the requested service |
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| Slices for extension |
Content/Rules for all slices | |||
| bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note |
S | 0..* | BeCodedAnnotation | Text node with attribution |
| Slices for extension |
Content/Rules for all slices | |||
| code |
0..1 | (Complex) | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension |
0..0 | |||
| 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 |
| patientInstruction |
SΣ | 0..1 | string | Patient or consumer-oriented instructions |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | |
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | |
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | |
| ServiceRequest.code | required | BeVSRequestedServicesNursehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nursefrom this IG | |
| ServiceRequest.orderDetail | required | BeVSRequestedServicesNurseDetailhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nurse-detailfrom this IG | |
| ServiceRequest.quantity[x]:quantityQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | |
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | |
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-body-site | error | ServiceRequest | if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing : bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue() | |
| be-inv-long-date | error | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
| be-inv-uhmep-short | error | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | BeReferralServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-body-site: if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| validity |
S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period | ||||
| latest |
S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date | ||||
| performerType |
S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | ||||
| statusReason |
S | 0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/request-statusReason" | |||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: BeVSPrescriptionStatusReason (extensible) | |||||
| device |
S | 0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:reference |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "reference" | |||||
| value[x] |
0..1 | Reference(DeviceDefinition) | Value of extension | |||||
| extension:concept |
0..1 | Extension | Extension | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "concept" | |||||
| value[x] |
0..1 | CodeableConcept | Value of extension | |||||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference" | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system | ||||
| 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/referral/NamingSystem/uhmep | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:SHORT |
ΣC | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) be-inv-uhmep-short: The format of UHMEP-SHORT is 6 capital alphanumerics, without O | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn |
SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVSRequestIntent (required) | ||||
| category |
SΣ | 1..1 | CodeableConcept | Classification of service Binding: BeReferralCategory (extensible) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 9632001 | ||||
| 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. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
| code |
SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: BeVSRequestedServicesNurse (required) | ||||
| orderDetail |
SΣC | 0..* | CodeableConcept | Details of the nursing activity Binding: BeVSRequestedServicesNurseDetail (required) | ||||
| Slices for quantity[x] |
Σ | 0..1 | Service amount Slice: Unordered, Open by type:$this | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| quantity[x]:quantityQuantity |
Σ | 0..1 | Quantity | Service amount | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 0..1 | decimal | Numerical value (with implicit precision) | ||||
| comparator |
?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
| unit |
Σ | 0..1 | string | Unit representation | ||||
| system |
SΣC | 0..1 | uri | System that defines coded unit form | ||||
| code |
SΣ | 0..1 | code | Coded form of the unit | ||||
| subject |
SΣ | 1..1 | BeContainedOrLogicalReference(BePatient(2.1.2)) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] |
SΣ | 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 | ||||
| occurrence[x]:occurrenceTiming |
SΣ | 0..1 | Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event |
Σ | 0..* | dateTime | When the event occurs | ||||
| repeat |
ΣC | 0..1 | Element | When the event is to occur tim-1: if there's a duration, there needs to be duration units tim-2: if there's a period, there needs to be period units tim-4: duration SHALL be a non-negative value tim-5: period SHALL be a non-negative value tim-6: If there's a periodMax, there must be a period tim-7: If there's a durationMax, there must be a duration tim-8: If there's a countMax, there must be a count tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Open by type:$this | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| bounds[x]:boundsDuration |
SΣ | 0..1 | Duration | Length/Range of lengths, or (Start and/or end) limits | ||||
| count |
SΣ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
SΣ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
SΣ | 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 |
SΣ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
| periodMax |
Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
SΣ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| asNeeded[x] |
SΣ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
SΣC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) | ||||
| requester |
SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole(2.1.2)) | Prescriber of the requested service | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
S | 0..* | Reference(Resource) | Additional clinical information | ||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bodyLaterality |
0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| note |
S | 0..* | BeCodedAnnotation | Text node with attribution | ||||
| 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 | |||||
| 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 | |||||||
| 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: BeVSRequestNoteType (required) | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - plain text without markdown is strongly recommended | ||||
| patientInstruction |
SΣ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | ||||
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:SHORT.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | ||||
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | required | BeVSRequestedServicesNursehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nursefrom this IG | ||||
| ServiceRequest.orderDetail | required | BeVSRequestedServicesNurseDetailhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-requested-services-nurse-detailfrom this IG | ||||
| ServiceRequest.quantity[x]:quantityQuantity.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1from the FHIR Standard | ||||
| ServiceRequest.occurrence[x]:occurrenceTiming.code | preferred | TimingAbbreviationhttp://hl7.org/fhir/ValueSet/timing-abbreviationfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-body-site | error | ServiceRequest | if the category of the request is SNOMED-CT 9632001 (Nursing Procedure) then the bodySite will be member of the ValueSet be-vs-bodysite-nursing : bodySite.empty() or category.coding.where(system = 'http://snomed.info/sct' and code = '9632001').exists() implies bodySite.select($this.memberOf('https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-bodysite-nursing')).allTrue() | |
| be-inv-long-date | error | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
| be-inv-uhmep-short | error | ServiceRequest.identifier:SHORT | The format of UHMEP-SHORT is 6 capital alphanumerics, without O : Identifier.where(system = 'https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short').where(value.extension.empty() or value.extension.where(url = 'https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymization').empty()).value.select($this.matches('[A-NP-Z0-9]{6}')).allTrue() | |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() | |
| tim-1 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
| tim-2 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
| tim-4 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
| tim-5 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | period SHALL be a non-negative value : period.exists() implies period >= 0 | |
| tim-6 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
| tim-7 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
| tim-8 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
| tim-9 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's an offset, there must be a when (and not C, CM, CD, CV) : offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())) | |
| tim-10 | error | ServiceRequest.occurrence[x]:occurrenceTiming.repeat | If there's a timeOfDay, there cannot be a when, or vice versa : timeOfDay.empty() or when.empty() |
This structure is derived from BeReferralServiceRequest
Summary
Mandatory: 1 element
Must-Support: 10 elements
Fixed: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ . Package hl7.fhir.be.referral#1.0.0 based on FHIR 4.0.1. Generated 2024-09-23
Links: Table of Contents |
QA Report |
Version History |
