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-referralprescription | Version: 1.0.0 | |||
| Draft as of 2021-07-15 | Responsible: HL7 Belgium | Computable Name: BeReferralPrescription | ||
The common structure for referral prescription.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
  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. |
   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) |
 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 | |
  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 | |
| basedOn | S | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
| 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 |
| 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) |
| 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 | 0..* | CodeableConcept | Additional order information |
 subject | S | 1..1 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for |
| occurrence[x] | S | 0..1 | dateTime, Period, Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. |
| authoredOn | SC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| requester | S | 1..1 | BeContainedOrLogicalReference(BePractitionerRole) | Prescriber of the requested service |
| performerType | S | 0..0 | ||
| performer | S | 0..* | BeContainedOrLogicalReference(BePractitionerRole) | Requested performer - typically reference to practitionerroles |
| reasonCode | S | 0..1 | CodeableConcept | Explanation/Justification for procedure or service |
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite | S | 0..* | CodeableConcept | Location on Body |
 bodyLaterality | 0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
 note | S | 0..* | BeCodedAnnotation | Text node with attribution |
 extension:code | 0..1 | BeExtCodeableConcept | Code | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: BeVSRequestNoteType (required) | |
| 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.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | |
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom 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 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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) |
 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 |
| 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) |
| 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. |
| subject | SΣ | 1..1 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for |
 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 | |||
| 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 Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| bodyLaterality | 0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note | S | 0..* | BeCodedAnnotation | Text node with attribution |
| 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" | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: BeVSRequestNoteType (required) | |
| 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.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 | |
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-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..* | ServiceRequest | 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 | 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) | ||||
| 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 | ||||
| replaces | Σ | 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 | Σ | 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 | BeContainedOrLogicalReference(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] | Σ | 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 Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information | ||||
| specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bodyLaterality | 0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| note | S | 0..* | BeCodedAnnotation | Text node with attribution | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | 0..1 | 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.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-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 ServiceRequest
Summary
Mandatory: 5 elements (2 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
| 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. |
| 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) |
| 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 | |
| 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 | |
| basedOn | S | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills |
| 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 |
| 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) |
| 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 | 0..* | CodeableConcept | Additional order information |
| subject | S | 1..1 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for |
| occurrence[x] | S | 0..1 | dateTime, Period, Timing | When service shall occur - once this is past, this prescription is no longer valid and the status shall reflect this. |
| authoredOn | SC | 1..1 | dateTime | Date request signed be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
| requester | S | 1..1 | BeContainedOrLogicalReference(BePractitionerRole) | Prescriber of the requested service |
| performerType | S | 0..0 | ||
| performer | S | 0..* | BeContainedOrLogicalReference(BePractitionerRole) | Requested performer - typically reference to practitionerroles |
| reasonCode | S | 0..1 | CodeableConcept | Explanation/Justification for procedure or service |
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite | S | 0..* | CodeableConcept | Location on Body |
| bodyLaterality | 0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note | S | 0..* | BeCodedAnnotation | Text node with attribution |
| extension:code | 0..1 | BeExtCodeableConcept | Code | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: BeVSRequestNoteType (required) | |
| 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.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intentfrom this IG | |
| ServiceRequest.category | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-categoryfrom this IG | |
| ServiceRequest.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codefrom 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 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed prr-1: orderDetail SHALL only be present if code is present |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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) |
| 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 |
| 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) |
| 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. |
| subject | SΣ | 1..1 | BeContainedOrLogicalReference(BePatient) | Individual or Entity the service is ordered for |
| 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 | |||
| 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 Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. |
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information |
| bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| bodyLaterality | 0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |
| note | S | 0..* | BeCodedAnnotation | Text node with attribution |
| 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" | |
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: BeVSRequestNoteType (required) | |
| 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.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 | |
| ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-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..* | ServiceRequest | 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 | 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) | ||||
| 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 | ||||
| replaces | Σ | 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 | Σ | 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 | BeContainedOrLogicalReference(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] | Σ | 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 Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | S | 0..* | Reference(Resource) | Additional clinical information | ||||
| specimen | Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||
| bodySite | SΣ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| bodyLaterality | 0..1 | Coding | BeExtLaterality URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality Binding: Laterality (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| note | S | 0..* | BeCodedAnnotation | Text node with attribution | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| code | 0..1 | 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.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| ServiceRequest.note.extension:code.value[x] | required | BeVSRequestNoteTypehttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-note-typefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| be-inv-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 ServiceRequest
Summary
Mandatory: 5 elements (2 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ . Package hl7.fhir.be.referral#1.0.0 based on FHIR 4.0.1. Generated 2024-03-15
Links: Table of Contents |
QA Report |
Version History |
