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-annex-81 | Version: 1.0.0 | |||
| Draft as of 2024-09-15 | Computable Name: BeAnnex81 | |||
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   feedback |
S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber |
| coprescriber |
S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info |
| 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 |
| proposalType |
S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVSProposalType (required) |
| pss |
S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info |
 performerType |
S | 0..* | (Complex) | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type |
   value[x] |
||||
 coding |
||||
 system |
0..1 | uri | Identity of the terminology system Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | |
 Slices for identifier |
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 | |
  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 | |
| 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 |
| 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 | |
  basedOn |
0..* | Reference(BeAnnex81) | What request fulfills | |
| 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 |
0..1 | CodeableConcept | What is being requested/ordered Required Pattern: At least the following | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/CodeSystem/be-cs-temp-requested-service | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: tmp-prep-x081-2 | |
| Slices for occurrence[x] |
0..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service should occur | |
| repeat |
||||
| frequency |
0..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | |
| period |
0..1 | decimal | Event occurs frequency times per period Required Pattern: 1 | |
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: wk | |
| authoredOn |
SC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| reasonCode |
S | 1..* | CodeableConcept | Explanation/Justification for procedure or service Binding: BeVSAnnex81ReasonCode (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.reasonCode | required | BeVSAnnex81ReasonCodehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-annex-81-based-on | error | ServiceRequest | An approved Annex81 is always based on a request by a nurse : intent = 'order' implies basedOn.exists() | |
| be-inv-long-date | 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() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse |
 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 | |
| feedback |
S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber |
| coprescriber |
S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info |
| 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 |
| proposalType |
S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVSProposalType (required) |
| pss |
S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info |
| performerType |
S | 0..* | (Complex) | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type" | |
 value[x] |
S | 0..1 | CodeableConcept | Value of extension Binding: BeVSCdHcParty (extensible) |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 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 |
Σ | 0..* | Reference(BeAnnex81) | What request fulfills |
| 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 kind of service request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/CodeSystem/be-cs-temp-requested-service | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: tmp-prep-x081-2 | |
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceTiming |
Σ | 0..1 | Timing | When service should occur |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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) |
| reasonCode |
SΣ | 1..* | CodeableConcept | Explanation/Justification for procedure or service Binding: BeVSAnnex81ReasonCode (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.extension:performerType.value[x] | extensible | BeVSCdHcPartyhttps://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-cd-hcparty | |
| 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 | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | Pattern: tmp-prep-x081-2http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.reasonCode | required | BeVSAnnex81ReasonCodehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-annex-81-based-on | error | ServiceRequest | An approved Annex81 is always based on a request by a nurse : intent = 'order' implies basedOn.exists() | |
| be-inv-long-date | 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse | ||||
| 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 | |||||
| feedback |
S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber | ||||
| coprescriber |
S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info | ||||
| 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 | ||||
| proposalType |
S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVSProposalType (required) | ||||
| pss |
S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info | ||||
| performerType |
S | 0..* | (Complex) | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type" | |||||
| value[x] |
S | 0..1 | CodeableConcept | Value of extension Binding: BeVSCdHcParty (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 Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | ||||
| 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 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 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 |
Σ | 0..* | Reference(BeAnnex81) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| 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 |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/CodeSystem/be-cs-temp-requested-service | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: tmp-prep-x081-2 | |||||
| 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 | |||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
 quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| occurrence[x]:occurrenceTiming |
Σ | 0..1 | Timing | When service should occur | ||||
| 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 | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period Required Pattern: 1 | ||||
| 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). Required Pattern: wk | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
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 |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 1..* | CodeableConcept | Explanation/Justification for procedure or service Binding: BeVSAnnex81ReasonCode (required) | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.extension:performerType.value[x] | extensible | BeVSCdHcPartyhttps://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-cd-hcparty | ||||
| 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 | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | Pattern: tmp-prep-x081-2http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom 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 | Pattern: wkhttp://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.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | required | BeVSAnnex81ReasonCodehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-codefrom this IG | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-annex-81-based-on | error | ServiceRequest | An approved Annex81 is always based on a request by a nurse : intent = 'order' implies basedOn.exists() | |
| be-inv-long-date | 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 ServiceRequest
Summary
Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 9 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| feedback |
S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber |
| coprescriber |
S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info |
| 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 |
| proposalType |
S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVSProposalType (required) |
| pss |
S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info |
| performerType |
S | 0..* | (Complex) | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type |
| value[x] |
||||
| coding |
||||
| system |
0..1 | uri | Identity of the terminology system Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | |
| Slices for identifier |
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 | |
| 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 | |
| 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 |
| 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 | |
| basedOn |
0..* | Reference(BeAnnex81) | What request fulfills | |
| 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 |
0..1 | CodeableConcept | What is being requested/ordered Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/CodeSystem/be-cs-temp-requested-service | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: tmp-prep-x081-2 | |
| Slices for occurrence[x] |
0..1 | dateTime, Period, Timing | When service should occur Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceTiming |
0..1 | Timing | When service should occur | |
| repeat |
||||
| frequency |
0..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | |
| period |
0..1 | decimal | Event occurs frequency times per period Required Pattern: 1 | |
| periodUnit |
0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Required Pattern: wk | |
| authoredOn |
SC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| reasonCode |
S | 1..* | CodeableConcept | Explanation/Justification for procedure or service Binding: BeVSAnnex81ReasonCode (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.reasonCode | required | BeVSAnnex81ReasonCodehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-annex-81-based-on | error | ServiceRequest | An approved Annex81 is always based on a request by a nurse : intent = 'order' implies basedOn.exists() | |
| be-inv-long-date | 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() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse |
| 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 | |
| feedback |
S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber |
| coprescriber |
S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info |
| 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 |
| proposalType |
S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVSProposalType (required) |
| pss |
S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info |
| performerType |
S | 0..* | (Complex) | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type |
| extension |
0..0 | |||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type" | |
| value[x] |
S | 0..1 | CodeableConcept | Value of extension Binding: BeVSCdHcParty (extensible) |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 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 |
Σ | 0..* | Reference(BeAnnex81) | What request fulfills |
| 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 kind of service request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/CodeSystem/be-cs-temp-requested-service | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: tmp-prep-x081-2 | |
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |
| occurrenceDateTime |
dateTime | |||
| occurrencePeriod |
Period | |||
| occurrenceTiming |
Timing | |||
| occurrence[x]:occurrenceTiming |
Σ | 0..1 | Timing | When service should occur |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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) |
| reasonCode |
SΣ | 1..* | CodeableConcept | Explanation/Justification for procedure or service Binding: BeVSAnnex81ReasonCode (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.extension:performerType.value[x] | extensible | BeVSCdHcPartyhttps://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-cd-hcparty | |
| 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 | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | Pattern: tmp-prep-x081-2http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.reasonCode | required | BeVSAnnex81ReasonCodehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-annex-81-based-on | error | ServiceRequest | An approved Annex81 is always based on a request by a nurse : intent = 'order' implies basedOn.exists() | |
| be-inv-long-date | 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present be-inv-annex-81-based-on: An approved Annex81 is always based on a request by a nurse | ||||
| 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 | |||||
| feedback |
S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber | ||||
| coprescriber |
S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info | ||||
| 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 | ||||
| proposalType |
S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVSProposalType (required) | ||||
| pss |
S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info | ||||
| performerType |
S | 0..* | (Complex) | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type" | |||||
| value[x] |
S | 0..1 | CodeableConcept | Value of extension Binding: BeVSCdHcParty (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 Required Pattern: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty | ||||
| 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 | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 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 |
Σ | 0..* | Reference(BeAnnex81) | What request fulfills | ||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition |
Σ | 0..1 | Identifier | Composite Request ID | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent |
?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category |
Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| 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 |
Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/CodeSystem/be-cs-temp-requested-service | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: tmp-prep-x081-2 | |||||
| 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 | |||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
Σ | 0..1 | Service amount | |||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| Slices for occurrence[x] |
Σ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| occurrenceTiming |
Timing | |||||||
| occurrence[x]:occurrenceTiming |
Σ | 0..1 | Timing | When service should occur | ||||
| 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 | |||||
| bounds[x] |
Σ | 0..1 | Length/Range of lengths, or (Start and/or end) limits | |||||
| boundsDuration |
Duration | |||||||
| boundsRange |
Range | |||||||
| boundsPeriod |
Period | |||||||
| count |
Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax |
Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration |
Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax |
Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit |
Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency |
Σ | 0..1 | positiveInt | Event occurs frequency times per period Required Pattern: 1 | ||||
| frequencyMax |
Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period |
Σ | 0..1 | decimal | Event occurs frequency times per period Required Pattern: 1 | ||||
| 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). Required Pattern: wk | ||||
| dayOfWeek |
Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay |
Σ | 0..* | time | Time of day for action | ||||
| when |
Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset |
Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code |
Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
| asNeededBoolean |
boolean | |||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||
| authoredOn |
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 |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode |
SΣ | 1..* | CodeableConcept | Explanation/Justification for procedure or service Binding: BeVSAnnex81ReasonCode (required) | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite |
Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.extension:performerType.value[x] | extensible | BeVSCdHcPartyhttps://www.ehealth.fgov.be/standards/fhir/core/ValueSet/be-vs-cd-hcparty | ||||
| 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 | RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | Pattern: tmp-prep-x081-2http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom 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 | Pattern: wkhttp://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.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-rolefrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | required | BeVSAnnex81ReasonCodehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-annex-81-reason-codefrom this IG | ||||
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-annex-81-based-on | error | ServiceRequest | An approved Annex81 is always based on a request by a nurse : intent = 'order' implies basedOn.exists() | |
| be-inv-long-date | 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 ServiceRequest
Summary
Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 9 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
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-15
Links: Table of Contents |
QA Report |
Version History |
