Botswana FHIR Implementation Guide
1.0.0 - ci-build
Botswana FHIR Implementation Guide
1.0.0 - ci-build
Botswana FHIR Implementation Guide, published by Jembi Health Systems. 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/jembi/botswana-hie-fhir-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://moh.bw.org/StructureDefinition/lab-order-service-request | Version: 1.0.0 | |||
| Active as of 2026-10-13 | Computable Name: LabOrderServiceRequest | |||
Represents the service request for lab orders.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, prr-1 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
  Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   identifier:PLAC |
1..1 | Identifier | Identifiers assigned to this order | |
  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: http://moh.bw.org/identifier/service-request-id | |
 value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
 code |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Lab Order Codes (extensible) |
| subject |
1..1 | Reference(Patient - Botswana Patient) | Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |
| Slices for occurrence[x] |
1..1 | dateTime | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 occurrence[x]:occurrenceDateTime |
1..1 | dateTime | When service should occur | |
| requester |
1..1 | Reference(Practitioner | Service Provider) | Who/what is requesting service | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Requested performer | |
 specimen |
1..* | Reference(Specimen) | Procedure Samples | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:PLAC.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| ServiceRequest.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PLAC |
1..1 | Identifier | Identifiers assigned to this order | |
 system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/service-request-id | |
| value |
1..1 | string | The value that is unique | |
| intent |
1..1 | code | proposal | plan | directive | order + Required Pattern: order | |
| code |
1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Lab Order Codes (extensible) | |
| subject |
1..1 | Reference(Patient - Botswana Patient) | Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |
| Slices for occurrence[x] |
1..1 | dateTime | When service should occur Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | When service should occur | |
| requester |
1..1 | Reference(Practitioner | Service Provider) | Who/what is requesting service | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Requested performer | |
| specimen |
1..* | Reference(Specimen) | Procedure Samples | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, 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: AllLanguages (required): IETF language tag for 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:PLAC |
1..1 | Identifier | Identifiers assigned to this order | |||||
| id |
0..1 | id | 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: IdentifierTypeCodes (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: http://moh.bw.org/identifier/service-request-id | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | What request replaces | |||||
| requisition |
0..1 | Identifier | Composite Request ID | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order | |||||
| category |
0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |||||
| 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 |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Lab Order Codes (extensible) | ||||
| orderDetail |
C | 0..* | BackboneElement | Additional order information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| parameterFocus |
0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | |||||
 parameter |
1..* | BackboneElement | The parameter details for the service being requested | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. | |||||
 value[x] |
1..1 | The value for the order detail | ||||||
| valueQuantity |
Quantity | |||||||
| valueRatio |
Ratio | |||||||
| valueRange |
Range | |||||||
| valueBoolean |
boolean | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valuePeriod |
Period | |||||||
| quantity[x] |
0..1 | Service amount | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
1..1 | Reference(Patient - Botswana Patient) | Individual or Entity the service is ordered for | |||||
| focus |
0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
| Slices for occurrence[x] |
1..1 | dateTime | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | When service should occur | |||||
| 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 | Date request signed | |||||
| requester |
1..1 | Reference(Practitioner | Service Provider) | Who/what is requesting service | |||||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | |||||
| performer |
1..* | Reference(Practitioner | Service Provider) | Requested performer | |||||
| location |
0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | |||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | CodeableReference(Resource) | Additional clinical information | |||||
| specimen |
1..* | Reference(Specimen) | Procedure Samples | |||||
| bodySite |
C | 0..* | CodeableConcept | Coded location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| bodyStructure |
C | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..* | BackboneElement | Patient or consumer-oriented instructions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| instruction[x] |
0..1 | Patient or consumer-oriented instructions | ||||||
| instructionMarkdown |
markdown | |||||||
| instructionReference |
Reference(DocumentReference) | |||||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ServiceRequest.identifier:PLAC.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ServiceRequest.identifier:PLAC.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| ServiceRequest.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail.parameter.code | Base | example | Servicerequest OrderDetail Parameter Code | 📍5.0.0 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍5.0.0 | FHIR Std. |
| ServiceRequest.location | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.4 |
| ServiceRequest.reason | Base | example | Procedure Reason Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 10 elements
Must-Support: 1 element
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..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, prr-1 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PLAC |
1..1 | Identifier | Identifiers assigned to this order | |
| 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: http://moh.bw.org/identifier/service-request-id | |
| value |
C | 1..1 | string | The value that is unique Example General: 123456 |
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |
| intent |
1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order | |
| doNotPerform |
0..1 | boolean | True if service/procedure should not be performed | |
| code |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Lab Order Codes (extensible) |
| subject |
1..1 | Reference(Patient - Botswana Patient) | Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |
| Slices for occurrence[x] |
1..1 | dateTime | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | When service should occur | |
| requester |
1..1 | Reference(Practitioner | Service Provider) | Who/what is requesting service | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Requested performer | |
| specimen |
1..* | Reference(Specimen) | Procedure Samples | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.identifier:PLAC.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| ServiceRequest.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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 ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ServiceRequest |
0..* | ServiceRequest | A request for a service to be performed | |
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:PLAC |
1..1 | Identifier | Identifiers assigned to this order | |
| system |
1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.bw.org/identifier/service-request-id | |
| value |
1..1 | string | The value that is unique | |
| intent |
1..1 | code | proposal | plan | directive | order + Required Pattern: order | |
| code |
1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Lab Order Codes (extensible) | |
| subject |
1..1 | Reference(Patient - Botswana Patient) | Individual or Entity the service is ordered for | |
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |
| Slices for occurrence[x] |
1..1 | dateTime | When service should occur Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | When service should occur | |
| requester |
1..1 | Reference(Practitioner | Service Provider) | Who/what is requesting service | |
| performer |
1..* | Reference(Practitioner | Service Provider) | Requested performer | |
| specimen |
1..* | Reference(Specimen) | Procedure Samples | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | ServiceRequest | A request for a service to be performed Constraints: bdystr-1, 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: AllLanguages (required): IETF language tag for 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for identifier |
1..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:PLAC |
1..1 | Identifier | Identifiers assigned to this order | |||||
| id |
0..1 | id | 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: IdentifierTypeCodes (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: http://moh.bw.org/identifier/service-request-id | |||||
| value |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
0..1 | Period | Time period when id is/was valid for use | |||||
| assigner |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| instantiatesCanonical |
0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | |||||
| replaces |
0..* | Reference(ServiceRequest) | What request replaces | |||||
| requisition |
0..1 | Identifier | Composite Request ID | |||||
| status |
1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | |||||
| intent |
1..1 | code | proposal | plan | directive | order + Binding: RequestIntent (required): The kind of service request. Required Pattern: order | |||||
| category |
0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | |||||
| 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 |
C | 1..1 | CodeableReference(ActivityDefinition | PlanDefinition) | What is being requested/ordered Binding: Lab Order Codes (extensible) | ||||
| orderDetail |
C | 0..* | BackboneElement | Additional order information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| parameterFocus |
0..1 | CodeableReference(Device | DeviceDefinition | DeviceRequest | SupplyRequest | Medication | MedicationRequest | BiologicallyDerivedProduct | Substance) | The context of the order details by reference | |||||
| parameter |
1..* | BackboneElement | The parameter details for the service being requested | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
1..1 | CodeableConcept | The detail of the order being requested Binding: ServiceRequestOrderDetailParameterCode (example): Codes for order detail parameters. | |||||
| value[x] |
1..1 | The value for the order detail | ||||||
| valueQuantity |
Quantity | |||||||
| valueRatio |
Ratio | |||||||
| valueRange |
Range | |||||||
| valueBoolean |
boolean | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valuePeriod |
Period | |||||||
| quantity[x] |
0..1 | Service amount | ||||||
| quantityQuantity |
Quantity | |||||||
| quantityRatio |
Ratio | |||||||
| quantityRange |
Range | |||||||
| subject |
1..1 | Reference(Patient - Botswana Patient) | Individual or Entity the service is ordered for | |||||
| focus |
0..* | Reference(Resource) | What the service request is about, when it is not about the subject of record | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter in which the request was created | |||||
| Slices for occurrence[x] |
1..1 | dateTime | When service should occur Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| occurrence[x]:occurrenceDateTime |
1..1 | dateTime | When service should occur | |||||
| 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 | Date request signed | |||||
| requester |
1..1 | Reference(Practitioner | Service Provider) | Who/what is requesting service | |||||
| performerType |
0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | |||||
| performer |
1..* | Reference(Practitioner | Service Provider) | Requested performer | |||||
| location |
0..* | CodeableReference(Location) | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | |||||
| reason |
0..* | CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) | Explanation/Justification for procedure or service Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo |
0..* | CodeableReference(Resource) | Additional clinical information | |||||
| specimen |
1..* | Reference(Specimen) | Procedure Samples | |||||
| bodySite |
C | 0..* | CodeableConcept | Coded location on Body Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
| bodyStructure |
C | 0..1 | Reference(BodyStructure) | BodyStructure-based location on the body | ||||
| note |
0..* | Annotation | Comments | |||||
| patientInstruction |
0..* | BackboneElement | Patient or consumer-oriented instructions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| instruction[x] |
0..1 | Patient or consumer-oriented instructions | ||||||
| instructionMarkdown |
markdown | |||||||
| instructionReference |
Reference(DocumentReference) | |||||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ServiceRequest.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ServiceRequest.identifier:PLAC.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| ServiceRequest.identifier:PLAC.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| ServiceRequest.intent | Base | required | RequestIntent | 📍5.0.0 | FHIR Std. |
| ServiceRequest.category | Base | example | Service Request Category Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.priority | Base | required | RequestPriority | 📍5.0.0 | FHIR Std. |
| ServiceRequest.code | Base | extensible | Lab Order Codes | 📦1.0.0 | This IG |
| ServiceRequest.orderDetail.parameter.code | Base | example | Servicerequest OrderDetail Parameter Code | 📍5.0.0 | FHIR Std. |
| ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.performerType | Base | example | Participant Roles | 📍5.0.0 | FHIR Std. |
| ServiceRequest.location | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.4 |
| ServiceRequest.reason | Base | example | Procedure Reason Codes | 📍5.0.0 | FHIR Std. |
| ServiceRequest.bodySite | Base | example | SNOMED CT Body Structures | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdystr-1 | error | ServiceRequest | bodyStructure SHALL only be present if bodySite is not present |
bodySite.exists() implies bodyStructure.empty()
|
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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: 10 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron