Botswana FHIR Implementation Guide
1.0.0 - ci-build Botswana flag

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

Resource Profile: ServiceRequest - Lab Orders

Official URL: http://moh.bw.org/StructureDefinition/lab-order-service-request Version: 1.0.0
Active as of 2025-08-20 Computable Name: LabOrderServiceRequest

Represents the service request for lab orders.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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 SΣ 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.identifier:PLAC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
From the FHIR Standard
ServiceRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
From the FHIR Standard
ServiceRequest.codeextensibleVSLabOrderCodes
http://moh.bw.org/ValueSet/vs-lab-order-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest ServiceRequest
... Slices for identifier 1..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... 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)
... encounter S 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
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.codeextensibleVSLabOrderCodes
http://moh.bw.org/ValueSet/vs-lab-order-codes
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Additional BindingsPurpose
CommonLanguages Starter
... 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
.... 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 SΣ 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ServiceRequest.identifier:PLAC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
ServiceRequest.identifier:PLAC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
From the FHIR Standard
ServiceRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
From the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
From the FHIR Standard
ServiceRequest.codeextensibleVSLabOrderCodes
http://moh.bw.org/ValueSet/vs-lab-order-codes
From this IG
ServiceRequest.orderDetail.parameter.codeexampleServiceRequestOrderDetailParameterCode
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail-parameter-code
From the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
From the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
From the FHIR Standard
ServiceRequest.locationexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail 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:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
.... 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 SΣ 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.identifier:PLAC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
From the FHIR Standard
ServiceRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
From the FHIR Standard
ServiceRequest.codeextensibleVSLabOrderCodes
http://moh.bw.org/ValueSet/vs-lab-order-codes
From this IG

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest ServiceRequest
... Slices for identifier 1..* Identifier Identifiers assigned to this order
Slice: Unordered, Open by value:system
.... 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)
... encounter S 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
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.codeextensibleVSLabOrderCodes
http://moh.bw.org/ValueSet/vs-lab-order-codes
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
Additional BindingsPurpose
CommonLanguages Starter
... 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
.... 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 SΣ 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
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ServiceRequest.identifier:PLAC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
From the FHIR Standard
ServiceRequest.identifier:PLAC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|5.0.0
From the FHIR Standard
ServiceRequest.intentrequiredPattern Value: order
http://hl7.org/fhir/ValueSet/request-intent|5.0.0
From the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|5.0.0
From the FHIR Standard
ServiceRequest.codeextensibleVSLabOrderCodes
http://moh.bw.org/ValueSet/vs-lab-order-codes
From this IG
ServiceRequest.orderDetail.parameter.codeexampleServiceRequestOrderDetailParameterCode
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail-parameter-code
From the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
From the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
From the FHIR Standard
ServiceRequest.locationexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
bdystr-1errorServiceRequestbodyStructure SHALL only be present if bodySite is not present
: bodySite.exists() implies bodyStructure.empty()
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf 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-4errorServiceRequestIf 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-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail 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:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron