England Pathology and Laboratory Medicine (PaLM) Technical Framework
0.1.0 - ci-build
England Pathology and Laboratory Medicine (PaLM) Technical Framework
0.1.0 - ci-build
England Pathology and Laboratory Medicine (PaLM) Technical Framework - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://examplesihe.org.uk/StructureDefinition/LaboratoryOrder | Version: 0.1.0 | ||||
| Draft as of 2026-11-04 | Computable Name: LaboratoryOrder | ||||
Diagnostic - Laboratory A laboratory test request - the IHE PaLM Order. One ServiceRequest per ordered test or panel (HL7 v2 ORC/OBR pair). Orders placed together share requisition (ORC-4 Placer Group Number).
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequestLabEu | Laboratory Order Constraints: prr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:accreditedLab |
0..1 | boolean | Accredited laboratory requested URL: http://hl7.eu/fhir/StructureDefinition/laboratory-accredited | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
1..* | CorrelationIdentifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 identifier:placerOrderNumber |
0..1 | OrderIdentifier | Placer Order Number, assigned by the Order Placer (HL7 v2 ORC-2 / OBR-2) | |
  use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
 type |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |
  assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
  identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |
 value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |
 identifier:fillerOrderNumber |
0..1 | OrderIdentifier | Filler Order Number, assigned by the Order Filler (HL7 v2 ORC-3 / OBR-3) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |
| requisition |
0..1 | CorrelationIdentifier | Placer Group Number - orders placed together (HL7 v2 ORC-4) | |
| status |
1..1 | code | HL7 v2 ORC-1 Order Control / ORC-5 Order Status Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| priority |
0..1 | code | HL7 v2 TQ1-9 Priority 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 |
1..1 | CodeableConcept | Test or panel requested (HL7 v2 OBR-4 Universal Service Identifier) Binding: Laboratory Order (preferred) | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:palmProcedure |
0..* | Coding | PaLM requestable test (SNOMED CT UK, Pathology and laboratory medicine procedure refset) - the England equivalent of the National Genomic Test Directory and NICIP. The laboratory's own test code can be sent as another coding Binding: PaLM Requestable Tests (SNOMED CT) (preferred) | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct (extensions allowed) | |
 code |
1..1 | code | Symbol in syntax defined by the system | |
| subject |
1..1 | Reference(Patient) | The patient the laboratory order is for | |
| encounter |
0..1 | Reference(Encounter) | HL7 v2 PV1-19 Visit Number | |
| identifier |
0..1 | VisitNumber | Logical reference, when literal reference is not known | |
| authoredOn |
0..1 | dateTime | HL7 v2 ORC-9 Date/Time of Transaction | |
| requester |
1..1 | Reference(PractitionerRole | Organization) | Ordering provider and organisation (HL7 v2 ORC-12 / OBR-16, ORC-21, PV1-8) | |
| performer |
0..* | Reference(Organization) | Laboratory asked to perform the test (HL7 v2 MSH-6 Receiving Facility) | |
| reasonCode |
0..* | CodeableConcept | HL7 v2 OBR-31 Reason for Study, DG1-3 Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |
| supportingInfo |
0..* | Reference(Resource) | Ask at order entry answers and clinical details (HL7 v2 OBX following OBR) | |
| specimen |
0..* | Reference(Specimen) | Specimens to be used by the laboratory procedure | |
| note |
0..* | Annotation | Clinical details and comments (HL7 v2 NTE, OBR-13 Relevant Clinical Information) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:placerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:placerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:fillerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | preferred | Laboratory Order | 📦2.1.0 | HL7 Europe Laboratory Report v2.1 |
| ServiceRequest.code.coding:palmProcedure | Base | preferred | PaLM Requestable Tests (SNOMED CT) | 📦0.1.0 | This IG |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ServiceRequestLabEu
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequestLabEu | Laboratory Order | |
| Slices for identifier |
1..* | CorrelationIdentifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:placerOrderNumber |
0..1 | OrderIdentifier | Placer Order Number, assigned by the Order Placer (HL7 v2 ORC-2 / OBR-2) | |
 type |
1..1 | CodeableConcept | Description of identifier Required Pattern: | |
| identifier:fillerOrderNumber |
0..1 | OrderIdentifier | Filler Order Number, assigned by the Order Filler (HL7 v2 ORC-3 / OBR-3) | |
| type |
1..1 | CodeableConcept | Description of identifier Required Pattern: | |
| requisition |
0..1 | CorrelationIdentifier | Placer Group Number - orders placed together (HL7 v2 ORC-4) | |
| status |
1..1 | code | HL7 v2 ORC-1 Order Control / ORC-5 Order Status | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | |
| priority |
0..1 | code | HL7 v2 TQ1-9 Priority | |
| code |
1..1 | CodeableConcept | Test or panel requested (HL7 v2 OBR-4 Universal Service Identifier) | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:palmProcedure |
0..* | Coding | PaLM requestable test (SNOMED CT UK, Pathology and laboratory medicine procedure refset) - the England equivalent of the National Genomic Test Directory and NICIP. The laboratory's own test code can be sent as another coding Binding: PaLM Requestable Tests (SNOMED CT) (preferred) | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct (extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| subject |
1..1 | Reference(Patient) | The patient the laboratory order is for | |
| encounter |
0..1 | Reference(Encounter) | HL7 v2 PV1-19 Visit Number | |
| identifier |
0..1 | VisitNumber | Logical reference, when literal reference is not known | |
| authoredOn |
0..1 | dateTime | HL7 v2 ORC-9 Date/Time of Transaction | |
| requester |
1..1 | Reference(PractitionerRole | Organization) | Ordering provider and organisation (HL7 v2 ORC-12 / OBR-16, ORC-21, PV1-8) | |
| performer |
0..* | Reference(Organization) | Laboratory asked to perform the test (HL7 v2 MSH-6 Receiving Facility) | |
| reasonCode |
0..* | CodeableConcept | HL7 v2 OBR-31 Reason for Study, DG1-3 | |
| supportingInfo |
0..* | Reference(Resource) | Ask at order entry answers and clinical details (HL7 v2 OBX following OBR) | |
| specimen |
0..* | Reference(Specimen) | Specimens to be used by the laboratory procedure | |
| note |
0..* | Annotation | Clinical details and comments (HL7 v2 NTE, OBR-13 Relevant Clinical Information) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code.coding:palmProcedure | Base | preferred | PaLM Requestable Tests (SNOMED CT) | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequestLabEu | Laboratory Order Constraints: prr-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:accreditedLab |
0..1 | boolean | Accredited laboratory requested URL: http://hl7.eu/fhir/StructureDefinition/laboratory-accredited | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | CorrelationIdentifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:placerOrderNumber |
0..1 | OrderIdentifier | Placer Order Number, assigned by the Order Placer (HL7 v2 ORC-2 / OBR-2) | |||||
| 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 |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |||||
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |||||
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |||||
| 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) | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| identifier:fillerOrderNumber |
0..1 | OrderIdentifier | Filler Order Number, assigned by the Order Filler (HL7 v2 ORC-3 / OBR-3) | |||||
| 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 |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |||||
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |||||
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |||||
| 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) | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | What request replaces | |||||
| requisition |
0..1 | CorrelationIdentifier | Placer Group Number - orders placed together (HL7 v2 ORC-4) | |||||
| status |
1..1 | code | HL7 v2 ORC-1 Order Control / ORC-5 Order Status Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |||||
| category |
0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |||||
| priority |
0..1 | code | HL7 v2 TQ1-9 Priority 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 |
1..1 | CodeableConcept | Test or panel requested (HL7 v2 OBR-4 Universal Service Identifier) Binding: Laboratory Order (preferred) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||
| coding:palmProcedure |
0..* | Coding | PaLM requestable test (SNOMED CT UK, Pathology and laboratory medicine procedure refset) - the England equivalent of the National Genomic Test Directory and NICIP. The laboratory's own test code can be sent as another coding Binding: PaLM Requestable Tests (SNOMED CT) (preferred) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| orderDetail |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
 quantity[x] |
0..1 | Service amount | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
1..1 | Reference(Patient) | The patient the laboratory order is for | |||||
| encounter |
0..1 | Reference(Encounter) | HL7 v2 PV1-19 Visit Number | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | VisitNumber | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| occurrence[x] |
0..1 | When service should occur | ||||||
| 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 |
0..1 | dateTime | HL7 v2 ORC-9 Date/Time of Transaction | |||||
| requester |
1..1 | Reference(PractitionerRole | Organization) | Ordering provider and organisation (HL7 v2 ORC-12 / OBR-16, ORC-21, PV1-8) | |||||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | |||||
| performer |
0..* | Reference(Organization) | Laboratory asked to perform the test (HL7 v2 MSH-6 Receiving Facility) | |||||
| locationCode |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | |||||
| locationReference |
0..* | Reference(Location) | Requested location | |||||
| reasonCode |
0..* | CodeableConcept | HL7 v2 OBR-31 Reason for Study, DG1-3 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) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Ask at order entry answers and clinical details (HL7 v2 OBX following OBR) | |||||
| specimen |
0..* | Reference(Specimen) | Specimens to be used by the laboratory procedure | |||||
| bodySite |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| note |
0..* | Annotation | Clinical details and comments (HL7 v2 NTE, OBR-13 Relevant Clinical Information) | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:placerOrderNumber.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:fillerOrderNumber.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | preferred | Laboratory Order | 📦2.1.0 | HL7 Europe Laboratory Report v2.1 |
| ServiceRequest.code.coding:palmProcedure | Base | preferred | PaLM Requestable Tests (SNOMED CT) | 📦0.1.0 | This IG |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.encounter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.5 |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ServiceRequestLabEu
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequestLabEu | Laboratory Order Constraints: prr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:accreditedLab |
0..1 | boolean | Accredited laboratory requested URL: http://hl7.eu/fhir/StructureDefinition/laboratory-accredited | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
1..* | CorrelationIdentifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:placerOrderNumber |
0..1 | OrderIdentifier | Placer Order Number, assigned by the Order Placer (HL7 v2 ORC-2 / OBR-2) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |
| identifier:fillerOrderNumber |
0..1 | OrderIdentifier | Filler Order Number, assigned by the Order Filler (HL7 v2 ORC-3 / OBR-3) | |
| use |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |
| requisition |
0..1 | CorrelationIdentifier | Placer Group Number - orders placed together (HL7 v2 ORC-4) | |
| status |
1..1 | code | HL7 v2 ORC-1 Order Control / ORC-5 Order Status Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |
| priority |
0..1 | code | HL7 v2 TQ1-9 Priority 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 |
1..1 | CodeableConcept | Test or panel requested (HL7 v2 OBR-4 Universal Service Identifier) Binding: Laboratory Order (preferred) | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:palmProcedure |
0..* | Coding | PaLM requestable test (SNOMED CT UK, Pathology and laboratory medicine procedure refset) - the England equivalent of the National Genomic Test Directory and NICIP. The laboratory's own test code can be sent as another coding Binding: PaLM Requestable Tests (SNOMED CT) (preferred) | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct (extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| subject |
1..1 | Reference(Patient) | The patient the laboratory order is for | |
| encounter |
0..1 | Reference(Encounter) | HL7 v2 PV1-19 Visit Number | |
| identifier |
0..1 | VisitNumber | Logical reference, when literal reference is not known | |
| authoredOn |
0..1 | dateTime | HL7 v2 ORC-9 Date/Time of Transaction | |
| requester |
1..1 | Reference(PractitionerRole | Organization) | Ordering provider and organisation (HL7 v2 ORC-12 / OBR-16, ORC-21, PV1-8) | |
| performer |
0..* | Reference(Organization) | Laboratory asked to perform the test (HL7 v2 MSH-6 Receiving Facility) | |
| reasonCode |
0..* | CodeableConcept | HL7 v2 OBR-31 Reason for Study, DG1-3 Binding: ProcedureReasonCodes (example): Diagnosis or problem codes justifying the reason for requesting the service investigation. | |
| supportingInfo |
0..* | Reference(Resource) | Ask at order entry answers and clinical details (HL7 v2 OBX following OBR) | |
| specimen |
0..* | Reference(Specimen) | Specimens to be used by the laboratory procedure | |
| note |
0..* | Annotation | Clinical details and comments (HL7 v2 NTE, OBR-13 Relevant Clinical Information) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:placerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:placerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:fillerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | preferred | Laboratory Order | 📦2.1.0 | HL7 Europe Laboratory Report v2.1 |
| ServiceRequest.code.coding:palmProcedure | Base | preferred | PaLM Requestable Tests (SNOMED CT) | 📦0.1.0 | This IG |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from ServiceRequestLabEu
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequestLabEu | Laboratory Order | |
| Slices for identifier |
1..* | CorrelationIdentifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:placerOrderNumber |
0..1 | OrderIdentifier | Placer Order Number, assigned by the Order Placer (HL7 v2 ORC-2 / OBR-2) | |
| type |
1..1 | CodeableConcept | Description of identifier Required Pattern: | |
| identifier:fillerOrderNumber |
0..1 | OrderIdentifier | Filler Order Number, assigned by the Order Filler (HL7 v2 ORC-3 / OBR-3) | |
| type |
1..1 | CodeableConcept | Description of identifier Required Pattern: | |
| requisition |
0..1 | CorrelationIdentifier | Placer Group Number - orders placed together (HL7 v2 ORC-4) | |
| status |
1..1 | code | HL7 v2 ORC-1 Order Control / ORC-5 Order Status | |
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | |
| priority |
0..1 | code | HL7 v2 TQ1-9 Priority | |
| code |
1..1 | CodeableConcept | Test or panel requested (HL7 v2 OBR-4 Universal Service Identifier) | |
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:palmProcedure |
0..* | Coding | PaLM requestable test (SNOMED CT UK, Pathology and laboratory medicine procedure refset) - the England equivalent of the National Genomic Test Directory and NICIP. The laboratory's own test code can be sent as another coding Binding: PaLM Requestable Tests (SNOMED CT) (preferred) | |
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct (extensions allowed) | |
| code |
1..1 | code | Symbol in syntax defined by the system | |
| subject |
1..1 | Reference(Patient) | The patient the laboratory order is for | |
| encounter |
0..1 | Reference(Encounter) | HL7 v2 PV1-19 Visit Number | |
| identifier |
0..1 | VisitNumber | Logical reference, when literal reference is not known | |
| authoredOn |
0..1 | dateTime | HL7 v2 ORC-9 Date/Time of Transaction | |
| requester |
1..1 | Reference(PractitionerRole | Organization) | Ordering provider and organisation (HL7 v2 ORC-12 / OBR-16, ORC-21, PV1-8) | |
| performer |
0..* | Reference(Organization) | Laboratory asked to perform the test (HL7 v2 MSH-6 Receiving Facility) | |
| reasonCode |
0..* | CodeableConcept | HL7 v2 OBR-31 Reason for Study, DG1-3 | |
| supportingInfo |
0..* | Reference(Resource) | Ask at order entry answers and clinical details (HL7 v2 OBX following OBR) | |
| specimen |
0..* | Reference(Specimen) | Specimens to be used by the laboratory procedure | |
| note |
0..* | Annotation | Clinical details and comments (HL7 v2 NTE, OBR-13 Relevant Clinical Information) | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code.coding:palmProcedure | Base | preferred | PaLM Requestable Tests (SNOMED CT) | 📦0.1.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequestLabEu | Laboratory Order Constraints: prr-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:accreditedLab |
0..1 | boolean | Accredited laboratory requested URL: http://hl7.eu/fhir/StructureDefinition/laboratory-accredited | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | CorrelationIdentifier | Identifiers assigned to this order Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:placerOrderNumber |
0..1 | OrderIdentifier | Placer Order Number, assigned by the Order Placer (HL7 v2 ORC-2 / OBR-2) | |||||
| 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 |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |||||
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |||||
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |||||
| 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) | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| identifier:fillerOrderNumber |
0..1 | OrderIdentifier | Filler Order Number, assigned by the Order Filler (HL7 v2 ORC-3 / OBR-3) | |||||
| 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 |
1..1 | CodeableConcept | Description of identifier Binding: NW IdentifierType (required) Required Pattern: | |||||
| system |
0..1 | uri | Recommended. This may be defined by a EPR/LIMS system. Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | The value MUST be unique to the organisation Example General: 123456 | |||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
1..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | Identifier | Logical reference, when literal reference is not known | |||||
| 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 Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed) | |||||
| value |
1..1 | string | The value that is unique Example General: 123456 Example Manchester University NHS Foundation Trust: R0A | |||||
| 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) | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | What request replaces | |||||
| requisition |
0..1 | CorrelationIdentifier | Placer Group Number - orders placed together (HL7 v2 ORC-4) | |||||
| status |
1..1 | code | HL7 v2 ORC-1 Order Control / ORC-5 Order Status Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | |||||
| category |
0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |||||
| priority |
0..1 | code | HL7 v2 TQ1-9 Priority 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 |
1..1 | CodeableConcept | Test or panel requested (HL7 v2 OBR-4 Universal Service Identifier) Binding: Laboratory Order (preferred) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||
| coding:palmProcedure |
0..* | Coding | PaLM requestable test (SNOMED CT UK, Pathology and laboratory medicine procedure refset) - the England equivalent of the National Genomic Test Directory and NICIP. The laboratory's own test code can be sent as another coding Binding: PaLM Requestable Tests (SNOMED CT) (preferred) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct (extensions allowed) | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| orderDetail |
C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| quantity[x] |
0..1 | Service amount | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
1..1 | Reference(Patient) | The patient the laboratory order is for | |||||
| encounter |
0..1 | Reference(Encounter) | HL7 v2 PV1-19 Visit Number | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | VisitNumber | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| occurrence[x] |
0..1 | When service should occur | ||||||
| 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 |
0..1 | dateTime | HL7 v2 ORC-9 Date/Time of Transaction | |||||
| requester |
1..1 | Reference(PractitionerRole | Organization) | Ordering provider and organisation (HL7 v2 ORC-12 / OBR-16, ORC-21, PV1-8) | |||||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | |||||
| performer |
0..* | Reference(Organization) | Laboratory asked to perform the test (HL7 v2 MSH-6 Receiving Facility) | |||||
| locationCode |
0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | |||||
| locationReference |
0..* | Reference(Location) | Requested location | |||||
| reasonCode |
0..* | CodeableConcept | HL7 v2 OBR-31 Reason for Study, DG1-3 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) | Associated insurance coverage | |||||
| supportingInfo |
0..* | Reference(Resource) | Ask at order entry answers and clinical details (HL7 v2 OBX following OBR) | |||||
| specimen |
0..* | Reference(Specimen) | Specimens to be used by the laboratory procedure | |||||
| bodySite |
0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| note |
0..* | Annotation | Clinical details and comments (HL7 v2 NTE, OBR-13 Relevant Clinical Information) | |||||
| patientInstruction |
0..1 | string | Patient or consumer-oriented instructions | |||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:placerOrderNumber.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:placerOrderNumber.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.type | Base | required | NW IdentifierType | 📦0.1.0 | This IG |
| ServiceRequest.identifier:fillerOrderNumber.assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.assigner.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| ServiceRequest.identifier:fillerOrderNumber.assigner.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| ServiceRequest.code | Base | preferred | Laboratory Order | 📦2.1.0 | HL7 Europe Laboratory Report v2.1 |
| ServiceRequest.code.coding:palmProcedure | Base | preferred | PaLM Requestable Tests (SNOMED CT) | 📦0.1.0 | This IG |
| ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.encounter.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std. |
| ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.5 |
| ServiceRequest.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ServiceRequestLabEu
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 18 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron