HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
​0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Service Request Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-service-request Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreServiceRequest

Zambia request profile for laboratory, imaging, procedure, and referral services.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

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
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... requisition SΣ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... category SΣ 1..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣC 1..1 CodeableReference(ActivityDefinition | PlanDefinition) ​What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
... orderDetail SΣC 0..* BackboneElement Additional order information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... parameter Σ 1..* BackboneElement The parameter details for the service being requested
..... 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] SΣ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) Individual or Entity the service is ordered for
... encounter SΣ 0..1 Reference(ZM-Core Encounter Profile) Encounter in which the request was created
... occurrence[x] SΣ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Patient Profile | ZM-Core Related Person Profile) Who/what is requesting service
... performer SΣ 0..* Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Healthcare Service Profile | CareTeam | Device) Requested performer
... location SΣ 0..* CodeableReference(ZM-Core Location Profile) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... reason SΣ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes
... supportingInfo S 0..* CodeableReference(Resource) Additional clinical information
... specimen SΣ 0..* Reference(ZM-Core Specimen Profile) Procedure Samples
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier.​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.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 example Procedure Codes (SNOMED CT) 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.location Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
ServiceRequest.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.

Constraints

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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... identifier S 1..* Identifier Identifiers assigned to this order
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... requisition S 0..1 Identifier Composite Request ID
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... category S 1..* CodeableConcept Classification of service
... priority S 0..1 code routine | urgent | asap | stat
... code S 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
... orderDetail S 0..* BackboneElement Additional order information
... quantity[x] S 0..1 Quantity, Ratio, Range Service amount
... subject S 1..1 Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) Individual or Entity the service is ordered for
... encounter S 0..1 Reference(ZM-Core Encounter Profile) Encounter in which the request was created
... occurrence[x] S 0..1 dateTime, Period, Timing When service should occur
... authoredOn S 0..1 dateTime Date request signed
... requester S 1..1 Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Patient Profile | ZM-Core Related Person Profile) Who/what is requesting service
... performer S 0..* Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Healthcare Service Profile | CareTeam | Device) Requested performer
... location S 0..* CodeableReference(ZM-Core Location Profile) Requested location
... reason S 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
... supportingInfo S 0..* CodeableReference(Resource) Additional clinical information
... specimen S 0..* Reference(ZM-Core Specimen Profile) Procedure Samples
... note S 0..* Annotation Comments

doco Documentation for this format
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
... identifier SΣ 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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ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 SΣ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... category SΣ 1..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣC 1..1 CodeableReference(ActivityDefinition | PlanDefinition) ​What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
... orderDetail SΣ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] SΣ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) 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(ZM-Core Encounter Profile) Encounter in which the request was created
... occurrence[x] SΣ 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Patient Profile | ZM-Core Related Person Profile) 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 SΣ 0..* Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Healthcare Service Profile | CareTeam | Device) Requested performer
... location SΣ 0..* CodeableReference(ZM-Core Location Profile) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... reason SΣ 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 S 0..* CodeableReference(Resource) Additional clinical information
... specimen SΣ 0..* Reference(ZM-Core Specimen Profile) 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 S 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

Path Status Usage ValueSet Version Source
ServiceRequest.language Base required All Languages 📍5.0.0 FHIR Std.
ServiceRequest.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
ServiceRequest.identifier.​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 example Procedure Codes (SNOMED CT) 📍5.0.0 FHIR Std.
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.1
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.

Constraints

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()

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
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... requisition SΣ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... category SΣ 1..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣC 1..1 CodeableReference(ActivityDefinition | PlanDefinition) ​What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
... orderDetail SΣC 0..* BackboneElement Additional order information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... parameter Σ 1..* BackboneElement The parameter details for the service being requested
..... 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] SΣ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) Individual or Entity the service is ordered for
... encounter SΣ 0..1 Reference(ZM-Core Encounter Profile) Encounter in which the request was created
... occurrence[x] SΣ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Patient Profile | ZM-Core Related Person Profile) Who/what is requesting service
... performer SΣ 0..* Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Healthcare Service Profile | CareTeam | Device) Requested performer
... location SΣ 0..* CodeableReference(ZM-Core Location Profile) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... reason SΣ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example): SNOMED CT Condition/Problem/Diagnosis Codes
... supportingInfo S 0..* CodeableReference(Resource) Additional clinical information
... specimen SΣ 0..* Reference(ZM-Core Specimen Profile) Procedure Samples
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.identifier.​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.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 example Procedure Codes (SNOMED CT) 📍5.0.0 FHIR Std.
ServiceRequest.orderDetail.​parameter.code Base example Servicerequest OrderDetail Parameter Code 📍5.0.0 FHIR Std.
ServiceRequest.location Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
ServiceRequest.reason Base example Procedure Reason Codes 📍5.0.0 FHIR Std.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... identifier S 1..* Identifier Identifiers assigned to this order
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... requisition S 0..1 Identifier Composite Request ID
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... category S 1..* CodeableConcept Classification of service
... priority S 0..1 code routine | urgent | asap | stat
... code S 1..1 CodeableReference(ActivityDefinition | PlanDefinition) What is being requested/ordered
... orderDetail S 0..* BackboneElement Additional order information
... quantity[x] S 0..1 Quantity, Ratio, Range Service amount
... subject S 1..1 Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) Individual or Entity the service is ordered for
... encounter S 0..1 Reference(ZM-Core Encounter Profile) Encounter in which the request was created
... occurrence[x] S 0..1 dateTime, Period, Timing When service should occur
... authoredOn S 0..1 dateTime Date request signed
... requester S 1..1 Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Patient Profile | ZM-Core Related Person Profile) Who/what is requesting service
... performer S 0..* Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Healthcare Service Profile | CareTeam | Device) Requested performer
... location S 0..* CodeableReference(ZM-Core Location Profile) Requested location
... reason S 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference | DetectedIssue) Explanation/Justification for procedure or service
... supportingInfo S 0..* CodeableReference(Resource) Additional clinical information
... specimen S 0..* Reference(ZM-Core Specimen Profile) Procedure Samples
... note S 0..* Annotation Comments

doco Documentation for this format

Snapshot ViewView

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
... identifier SΣ 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 SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ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 SΣ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order +
Binding: RequestIntent (required): The kind of service request.
... category SΣ 1..* CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... priority SΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣC 1..1 CodeableReference(ActivityDefinition | PlanDefinition) ​What is being requested/ordered
Binding: ProcedureCodesSNOMEDCT (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here.
... orderDetail SΣ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] SΣ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(ZM-Core Patient Profile | ZM-Core Recipient Group Profile) 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(ZM-Core Encounter Profile) Encounter in which the request was created
... occurrence[x] SΣ 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 SΣ 0..1 dateTime Date request signed
... requester SΣ 1..1 Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Patient Profile | ZM-Core Related Person Profile) 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 SΣ 0..* Reference(ZM-Core Practitioner Profile | ZM-Core Practitioner Role Profile | ZM-Core Organization Profile | ZM-Core Healthcare Service Profile | CareTeam | Device) Requested performer
... location SΣ 0..* CodeableReference(ZM-Core Location Profile) Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... reason SΣ 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 S 0..* CodeableReference(Resource) Additional clinical information
... specimen SΣ 0..* Reference(ZM-Core Specimen Profile) 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 S 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

Path Status Usage ValueSet Version Source
ServiceRequest.language Base required All Languages 📍5.0.0 FHIR Std.
ServiceRequest.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
ServiceRequest.identifier.​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 example Procedure Codes (SNOMED CT) 📍5.0.0 FHIR Std.
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.1
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.

Constraints

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()

 

Other representations of profile: CSV, Excel, Schematron