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-diagnosticimaging | Version: 1.0.0 | |||
Draft as of 2024-12-11 | Computable Name: BeReferralServiceRequestDiagnosticImaging |
Referral prescription for a generic diagnostic imaging. Please note in .orderDetail, a specific slicing is available to give guidance how to express acquisition modalities if needed. In future iterations of this profile, more slicing might provide additional guidance.
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 | |
Slices for extension | Content/Rules for all slices | |||
relevantSupportingInformationAsAnnotationOrCodeableConcept | S | 0..* | Annotation, CodeableConcept | Relevant clinical information in the context of this prescription concerning for example allergies, kidney function, diabetic. This extension allows the use of a codeableConcept or Annotation but when more detailed information can be given, it is RECOMMENDED to express it as structured as possible using the appropriate elements (for general relevant supporting information, this means the use of the .supportingInfo element.) ContraIndications SHALL be expressed using the contraIndication modifierExtension. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-supporting-info |
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: 363679005 | |
reasonCode | 0..1 | CodeableConcept | Diagnostic question, explanation/Justification for procedure or service | |
supportingInfo | 0..* | Reference(Resource) | Relevant information in the context of this prescription concerning for example allergies, kidney function, diabetic. When detailed information can be given, it is RECOMMENDED to express it as structured as possible. ContraIndications SHALL be expressed using the contraIndication modifierExtension | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | BeReferralServiceRequest | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
statusReason | S | 0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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) ele-1: All FHIR elements must have a @value or children | |
device | S | 0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for extension | Content/Rules for all slices | |||
extension:reference | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "reference" | |
extension:concept | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
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" | |
relevantSupportingInformationAsAnnotationOrCodeableConcept | S | 0..* | Annotation, CodeableConcept | Relevant clinical information in the context of this prescription concerning for example allergies, kidney function, diabetic. This extension allows the use of a codeableConcept or Annotation but when more detailed information can be given, it is RECOMMENDED to express it as structured as possible using the appropriate elements (for general relevant supporting information, this means the use of the .supportingInfo element.) ContraIndications SHALL be expressed using the contraIndication modifierExtension. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-supporting-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
identifier:SHORT | ΣC | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) ele-1: All FHIR elements must have a @value or children 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 . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVSRequestIntent (required) ele-1: All FHIR elements must have a @value or children |
category | SΣ | 1..1 | CodeableConcept | Classification of service Binding: BeReferralCategory (extensible) ele-1: All FHIR elements must have a @value or children |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children |
code | SΣ | 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. ele-1: All FHIR elements must have a @value or children |
orderDetail | SΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | BeNoContainedReference(BePatient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children |
occurrence[x] | SΣ | 0..1 | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. ele-1: All FHIR elements must have a @value or children | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
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. ele-1: All FHIR elements must have a @value or children | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | SΣC | 1..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
requester | SΣ | 1..1 | BeNoContainedReference(BePractitionerRole) | Prescriber of the requested service ele-1: All FHIR elements must have a @value or children |
reasonCode | SΣ | 0..1 | CodeableConcept | Diagnostic question, explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. ele-1: All FHIR elements must have a @value or children |
supportingInfo | S | 0..* | Reference(Resource) | Relevant information in the context of this prescription concerning for example allergies, kidney function, diabetic. When detailed information can be given, it is RECOMMENDED to express it as structured as possible. ContraIndications SHALL be expressed using the contraIndication modifierExtension ele-1: All FHIR elements must have a @value or children |
bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. ele-1: All FHIR elements must have a @value or children |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
note | S | 0..* | BeCodedAnnotation | Text node with attribution ele-1: All FHIR elements must have a @value or children |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
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 ele-1: All FHIR elements must have a @value or children |
patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions ele-1: All FHIR elements must have a @value or children |
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-reason from this IG | |
ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | |
ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | |
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from 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() |
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" | |||||
relevantSupportingInformationAsAnnotationOrCodeableConcept | S | 0..* | Annotation, CodeableConcept | Relevant clinical information in the context of this prescription concerning for example allergies, kidney function, diabetic. This extension allows the use of a codeableConcept or Annotation but when more detailed information can be given, it is RECOMMENDED to express it as structured as possible using the appropriate elements (for general relevant supporting information, this means the use of the .supportingInfo element.) ContraIndications SHALL be expressed using the contraIndication modifierExtension. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-supporting-info | ||||
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: 363679005 | ||||
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Σ | 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. | ||||
orderDetail | SΣ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 | SΣ | 1..1 | BeNoContainedReference(BePatient) | Individual or Entity the service is ordered for | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
occurrence[x] | SΣ | 0..1 | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
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 | BeNoContainedReference(BePractitionerRole) | 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 | Diagnostic question, 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) | Relevant information in the context of this prescription concerning for example allergies, kidney function, diabetic. When detailed information can be given, it is RECOMMENDED to express it as structured as possible. ContraIndications SHALL be expressed using the contraIndication modifierExtension | ||||
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 | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from 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-reason from this IG | ||||
ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.identifier:SHORT.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | ||||
ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type from 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() |
This structure is derived from BeReferralServiceRequest
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 | |
Slices for extension | Content/Rules for all slices | |||
relevantSupportingInformationAsAnnotationOrCodeableConcept | S | 0..* | Annotation, CodeableConcept | Relevant clinical information in the context of this prescription concerning for example allergies, kidney function, diabetic. This extension allows the use of a codeableConcept or Annotation but when more detailed information can be given, it is RECOMMENDED to express it as structured as possible using the appropriate elements (for general relevant supporting information, this means the use of the .supportingInfo element.) ContraIndications SHALL be expressed using the contraIndication modifierExtension. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-supporting-info |
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: 363679005 | |
reasonCode | 0..1 | CodeableConcept | Diagnostic question, explanation/Justification for procedure or service | |
supportingInfo | 0..* | Reference(Resource) | Relevant information in the context of this prescription concerning for example allergies, kidney function, diabetic. When detailed information can be given, it is RECOMMENDED to express it as structured as possible. ContraIndications SHALL be expressed using the contraIndication modifierExtension | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | C | 0..* | BeReferralServiceRequest | A request for a service to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
statusReason | S | 0..1 | (Complex) | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
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) ele-1: All FHIR elements must have a @value or children | |
device | S | 0..* | (Complex) | BeExtCodeableReference URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeable-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for extension | Content/Rules for all slices | |||
extension:reference | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "reference" | |
extension:concept | 0..1 | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
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" | |
relevantSupportingInformationAsAnnotationOrCodeableConcept | S | 0..* | Annotation, CodeableConcept | Relevant clinical information in the context of this prescription concerning for example allergies, kidney function, diabetic. This extension allows the use of a codeableConcept or Annotation but when more detailed information can be given, it is RECOMMENDED to express it as structured as possible using the appropriate elements (for general relevant supporting information, this means the use of the .supportingInfo element.) ContraIndications SHALL be expressed using the contraIndication modifierExtension. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-supporting-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
identifier:SHORT | ΣC | 0..1 | Identifier | Patient friendly ID (UHMEP SHORT) ele-1: All FHIR elements must have a @value or children 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 . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep-short |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills ele-1: All FHIR elements must have a @value or children |
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. ele-1: All FHIR elements must have a @value or children |
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVSRequestIntent (required) ele-1: All FHIR elements must have a @value or children |
category | SΣ | 1..1 | CodeableConcept | Classification of service Binding: BeReferralCategory (extensible) ele-1: All FHIR elements must have a @value or children |
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children |
code | SΣ | 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. ele-1: All FHIR elements must have a @value or children |
orderDetail | SΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. ele-1: All FHIR elements must have a @value or children |
subject | SΣ | 1..1 | BeNoContainedReference(BePatient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children |
occurrence[x] | SΣ | 0..1 | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. ele-1: All FHIR elements must have a @value or children | |
occurrenceDateTime | dateTime | |||
occurrencePeriod | Period | |||
occurrenceTiming | Timing | |||
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. ele-1: All FHIR elements must have a @value or children | |
asNeededBoolean | boolean | |||
asNeededCodeableConcept | CodeableConcept | |||
authoredOn | SΣC | 1..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
requester | SΣ | 1..1 | BeNoContainedReference(BePractitionerRole) | Prescriber of the requested service ele-1: All FHIR elements must have a @value or children |
reasonCode | SΣ | 0..1 | CodeableConcept | Diagnostic question, explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. ele-1: All FHIR elements must have a @value or children |
supportingInfo | S | 0..* | Reference(Resource) | Relevant information in the context of this prescription concerning for example allergies, kidney function, diabetic. When detailed information can be given, it is RECOMMENDED to express it as structured as possible. ContraIndications SHALL be expressed using the contraIndication modifierExtension ele-1: All FHIR elements must have a @value or children |
bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. ele-1: All FHIR elements must have a @value or children |
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
note | S | 0..* | BeCodedAnnotation | Text node with attribution ele-1: All FHIR elements must have a @value or children |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
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 ele-1: All FHIR elements must have a @value or children |
patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions ele-1: All FHIR elements must have a @value or children |
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-reason from this IG | |
ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | |
ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | |
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | |
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | |
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | |
ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | |
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from 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() |
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" | |||||
relevantSupportingInformationAsAnnotationOrCodeableConcept | S | 0..* | Annotation, CodeableConcept | Relevant clinical information in the context of this prescription concerning for example allergies, kidney function, diabetic. This extension allows the use of a codeableConcept or Annotation but when more detailed information can be given, it is RECOMMENDED to express it as structured as possible using the appropriate elements (for general relevant supporting information, this means the use of the .supportingInfo element.) ContraIndications SHALL be expressed using the contraIndication modifierExtension. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-supporting-info | ||||
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: 363679005 | ||||
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Σ | 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. | ||||
orderDetail | SΣ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 | SΣ | 1..1 | BeNoContainedReference(BePatient) | Individual or Entity the service is ordered for | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
occurrence[x] | SΣ | 0..1 | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
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 | BeNoContainedReference(BePractitionerRole) | 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 | Diagnostic question, 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) | Relevant information in the context of this prescription concerning for example allergies, kidney function, diabetic. When detailed information can be given, it is RECOMMENDED to express it as structured as possible. ContraIndications SHALL be expressed using the contraIndication modifierExtension | ||||
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 | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from 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-reason from this IG | ||||
ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ServiceRequest.identifier:SHORT.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.identifier:SHORT.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | BeVSRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | ||||
ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-type from 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() |
This structure is derived from BeReferralServiceRequest
Other representations of profile: CSV, Excel, Schematron