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-lab-prescription | Version: 1.0.0 | |||
| Draft as of 2021-07-15 | Responsible: HL7 Belgium | Computable Name: BeLabPrescription | ||
This is the Belgian profile for a laboratory order.
Initially, this profile is created for the unadressed flow for laboratory orders. These existing channels: via a specialized laboratory application, running on the environment of the ordering party, via the own application of the ordering party in which that own application places the order directly at the laboratory using a custom protocol, via the website of a laboratory or via a paper channel are initially out of scope for use of this profile. They might however benefit from using this format in the future.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from BeReferralPrescription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | BeReferralPrescription | A request for a service to be performed | |
  text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 urgentCommunication | 0..1 | (Complex) | when needed to communicate urgently any results URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-urgent-communication | |
| basedOn | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills - could be a different lab order for example in case of sub orders. | |
| replaces | S | 0..* | Reference(ServiceRequest) | What request replaces |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
 code | 0..1 | BeObservationCodeableConcept | High level code to describe the tests - if needed to detail within orderDetail - consult comment for more detail. | |
| orderDetail | 0..* | BeObservationCodeableConcept | Additional order information - consult comment for more information | |
| occurrence[x] | 0..0 | |||
| reasonCode | 0..1 | CodeableConcept | Explanation/Justification for procedure or service. Based on nomenclature codes. | |
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information - e.g. an Observation or Condition or a link to a supporting image. | |
| specimen | S | 0..* | Reference(Specimen) | Procedure Samples |
 bodySite | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | BeReferralPrescription | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
 statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding: (unbound) (example): Codes identifying the reason for the current state of an event. |
  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) | |
| feedback | S | 1..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 |
| latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-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 |
| recorder | S | 0..1 | Reference(BePatient | BePractitioner | BeOrganization) | The person responsable for this information, not necessarily the person who recorded the information URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder |
| 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: List of health care parties in Belgium (extensible) |
| urgentCommunication | 0..1 | (Complex) | when needed to communicate urgently any results URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-urgent-communication | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 Slices for identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
 identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
 basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills - could be a different lab order for example in case of sub orders. |
| replaces | SΣ | 0..* | Reference(ServiceRequest) | What request replaces |
| requisition | SΣ | 0..1 | Identifier | If needed to have a common identifier among different prescriptions. |
| 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) |
| priority | SΣ | 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 | BeObservationCodeableConcept | High level code to describe the tests - if needed to detail within orderDetail - consult comment for more detail. Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. |
| orderDetail | S | 0..* | BeObservationCodeableConcept | Additional order information - consult comment for more information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
| subject | SΣ | 1..1 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for |
| authoredOn | SΣC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| requester | SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole) | Prescriber of the requested service |
| performer | SΣ | 0..* | BeContainedOrLogicalReference(BePractitionerRole) | Requested performer - typically reference to practitionerroles |
| reasonCode | SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service. Based on nomenclature codes. Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information - e.g. an Observation or Condition or a link to a supporting image. |
| specimen | SΣ | 0..* | Reference(Specimen) | Procedure Samples |
| note | S | 0..* | BeCodedAnnotation | Text node with attribution |
| code | 0..1 | CodeableConcept | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
| text | Σ | 1..1 | markdown | The annotation - plain text without markdown is strongly recommended |
| patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | |
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | |
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | |
| 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..* | BeReferralPrescription | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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 | S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding: (unbound) (example): Codes identifying the reason for the current state of an event. | ||||
| id | 0..1 | string | 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) | |||||
| feedback | S | 1..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 | ||||
| latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-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 | ||||
| recorder | S | 0..1 | Reference(BePatient | BePractitioner | BeOrganization) | The person responsable for this information, not necessarily the person who recorded the information URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder | ||||
| 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: List of health care parties in Belgium (extensible) | ||||
| urgentCommunication | 0..1 | (Complex) | when needed to communicate urgently any results URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-urgent-communication | |||||
| 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) | ||||
| 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 - could be a different lab order for example in case of sub orders. | ||||
| replaces | SΣ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition | SΣ | 0..1 | Identifier | If needed to have a common identifier among different prescriptions. | ||||
| 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) | ||||
| priority | SΣ | 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 | BeObservationCodeableConcept | High level code to describe the tests - if needed to detail within orderDetail - consult comment for more detail. Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. | ||||
| orderDetail | S | 0..* | BeObservationCodeableConcept | Additional order information - consult comment for more 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 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| 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 | SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole) | Prescriber of the requested service | ||||
| performer | SΣ | 0..* | BeContainedOrLogicalReference(BePractitionerRole) | Requested performer - typically reference to practitionerroles | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode | SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service. Based on nomenclature codes. Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information - e.g. an Observation or Condition or a link to a supporting image. | ||||
| specimen | SΣ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| 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 | CodeableConcept | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |||||
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: BeVSRequestNoteType (required) | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | The annotation - plain text without markdown is strongly recommended | ||||
| patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | ||||
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | ||||
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-long-date | error | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
| 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 BeReferralPrescription
Differential View
This structure is derived from BeReferralPrescription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | 0..* | BeReferralPrescription | A request for a service to be performed | |
| text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| urgentCommunication | 0..1 | (Complex) | when needed to communicate urgently any results URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-urgent-communication | |
| basedOn | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills - could be a different lab order for example in case of sub orders. | |
| replaces | S | 0..* | Reference(ServiceRequest) | What request replaces |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
| code | 0..1 | BeObservationCodeableConcept | High level code to describe the tests - if needed to detail within orderDetail - consult comment for more detail. | |
| orderDetail | 0..* | BeObservationCodeableConcept | Additional order information - consult comment for more information | |
| occurrence[x] | 0..0 | |||
| reasonCode | 0..1 | CodeableConcept | Explanation/Justification for procedure or service. Based on nomenclature codes. | |
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information - e.g. an Observation or Condition or a link to a supporting image. | |
| specimen | S | 0..* | Reference(Specimen) | Procedure Samples |
| bodySite | 0..0 | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | BeReferralPrescription | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding: (unbound) (example): Codes identifying the reason for the current state of an event. |
| 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) | |
| feedback | S | 1..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 |
| latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-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 |
| recorder | S | 0..1 | Reference(BePatient | BePractitioner | BeOrganization) | The person responsable for this information, not necessarily the person who recorded the information URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder |
| 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: List of health care parties in Belgium (extensible) |
| urgentCommunication | 0..1 | (Complex) | when needed to communicate urgently any results URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-urgent-communication | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system |
| identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills - could be a different lab order for example in case of sub orders. |
| replaces | SΣ | 0..* | Reference(ServiceRequest) | What request replaces |
| requisition | SΣ | 0..1 | Identifier | If needed to have a common identifier among different prescriptions. |
| 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) |
| priority | SΣ | 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 | BeObservationCodeableConcept | High level code to describe the tests - if needed to detail within orderDetail - consult comment for more detail. Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. |
| orderDetail | S | 0..* | BeObservationCodeableConcept | Additional order information - consult comment for more information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. |
| subject | SΣ | 1..1 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for |
| authoredOn | SΣC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| requester | SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole) | Prescriber of the requested service |
| performer | SΣ | 0..* | BeContainedOrLogicalReference(BePractitionerRole) | Requested performer - typically reference to practitionerroles |
| reasonCode | SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service. Based on nomenclature codes. Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information - e.g. an Observation or Condition or a link to a supporting image. |
| specimen | SΣ | 0..* | Reference(Specimen) | Procedure Samples |
| note | S | 0..* | BeCodedAnnotation | Text node with attribution |
| code | 0..1 | CodeableConcept | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |
| extension | 0..0 | |||
| url | 1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |
| text | Σ | 1..1 | markdown | The annotation - plain text without markdown is strongly recommended |
| patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | |
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | |
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | |
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | |
| 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..* | BeReferralPrescription | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present | ||||
| 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 | S | 0..1 | Narrative | Text summary of the resource, for human interpretation | ||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding: (unbound) (example): Codes identifying the reason for the current state of an event. | ||||
| id | 0..1 | string | 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) | |||||
| feedback | S | 1..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 | ||||
| latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-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 | ||||
| recorder | S | 0..1 | Reference(BePatient | BePractitioner | BeOrganization) | The person responsable for this information, not necessarily the person who recorded the information URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder | ||||
| 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: List of health care parties in Belgium (extensible) | ||||
| urgentCommunication | 0..1 | (Complex) | when needed to communicate urgently any results URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-urgent-communication | |||||
| 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) | ||||
| 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 - could be a different lab order for example in case of sub orders. | ||||
| replaces | SΣ | 0..* | Reference(ServiceRequest) | What request replaces | ||||
| requisition | SΣ | 0..1 | Identifier | If needed to have a common identifier among different prescriptions. | ||||
| 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) | ||||
| priority | SΣ | 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 | BeObservationCodeableConcept | High level code to describe the tests - if needed to detail within orderDetail - consult comment for more detail. Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. | ||||
| orderDetail | S | 0..* | BeObservationCodeableConcept | Additional order information - consult comment for more 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 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| 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 | SΣ | 1..1 | BeContainedOrLogicalReference(BePractitionerRole) | Prescriber of the requested service | ||||
| performer | SΣ | 0..* | BeContainedOrLogicalReference(BePractitionerRole) | Requested performer - typically reference to practitionerroles | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | Σ | 0..* | Reference(Location) | Requested location | ||||
| reasonCode | SΣ | 0..1 | CodeableConcept | Explanation/Justification for procedure or service. Based on nomenclature codes. Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information - e.g. an Observation or Condition or a link to a supporting image. | ||||
| specimen | SΣ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| 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 | CodeableConcept | Code URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-codeableconcept" | |||||
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: BeVSRequestNoteType (required) | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | The annotation - plain text without markdown is strongly recommended | ||||
| patientInstruction | SΣ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ServiceRequest.extension:statusReason.value[x] | extensible | BeVSPrescriptionStatusReason (a valid code from BePrescriptionStatusReason)https://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-prescription-status-reasonfrom this IG | ||||
| ServiceRequest.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| ServiceRequest.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | ||||
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom the FHIR Standard | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailfrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonfrom the FHIR Standard | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonfrom the FHIR Standard | ||||
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-long-date | error | ServiceRequest.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
| 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 BeReferralPrescription
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-03-15
Links: Table of Contents |
QA Report |
Version History |
