Kenya Patient Summary FHIR Implementation Guide
0.1.0 - ci-build KE

Kenya Patient Summary FHIR Implementation Guide, published by Digital Health Agency of Kenya. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IntelliSOFT-Consulting/Kenya-Patient-Summary-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: Service Request Profile - KPS (Referral)

Official URL: https://fhir.dha.go.ke/kps/StructureDefinition/ke-kps-service-request Version: 0.1.0
Draft as of 2026-05-11 Computable Name: KpsServiceRequest

Copyright/Legal: Copyright © 2024+ Digital Health Agency of Kenya. This content is licensed under Creative Commons Zero v1.0 Universal (CC0 1.0). No rights reserved.

This profile defines constraints on the ServiceRequest resource for use within the Kenya Patient Summary to represent clinical referrals (KPS.G). It captures the source facility, destination facility, referral reason, clinical summary, and communication preferences required for safe patient transfer.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referralDirection S 0..1 CodeableConcept Referral Direction
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-direction
Binding: Referral Direction ValueSet (required)
.... extension:referralSource S 0..1 CodeableConcept Source of Referral
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-source
Binding: Source of Referral ValueSet (required)
.... extension:communicationPreference S 0..* CodeableConcept Communication Preference
URL: https://fhir.dha.go.ke/kps/StructureDefinition/communication-preference
Binding: Communication Preference ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Required Pattern: order
... 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Σ 0..1 CodeableConcept Service being requested at the destination facility
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
... subject SΣ 1..1 Reference(Patient Profile - KPS) Patient being referred
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter that triggered the referral
... occurrence[x] SΣ 0..1 dateTime Referral date (KPS.G.DE.6)
... requester SΣ 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Referring clinician or source facility (KPS.G.DE.4, KPS.G.DE.13)
... locationReference SΣ 0..* Reference(Location Profile - KPS) Destination facility for the referral (KPS.G.DE.5)
... reasonCode SΣ 0..* CodeableConcept Reason(s) for the referral (KPS.G.DE.7)
Binding: Reason for Referral ValueSet (required)
... supportingInfo S 0..* Reference(Resource) Supporting clinical documents shared with the receiving facility
... note S 0..* Annotation Referral notes and clinical history summary (KPS.G.DE.14, KPS.G.DE.15)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base required Reason for Referral ValueSet 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referralDirection S 0..1 CodeableConcept Referral Direction
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-direction
Binding: Referral Direction ValueSet (required)
.... extension:referralSource S 0..1 CodeableConcept Source of Referral
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-source
Binding: Source of Referral ValueSet (required)
.... extension:communicationPreference S 0..* CodeableConcept Communication Preference
URL: https://fhir.dha.go.ke/kps/StructureDefinition/communication-preference
Binding: Communication Preference ValueSet (required)
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... code S 0..1 CodeableConcept Service being requested at the destination facility
... subject S 1..1 Reference(Patient Profile - KPS) Patient being referred
... encounter S 0..1 Reference(Encounter Profile - KPS) Encounter that triggered the referral
... occurrence[x] S 0..1 dateTime Referral date (KPS.G.DE.6)
... requester S 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Referring clinician or source facility (KPS.G.DE.4, KPS.G.DE.13)
... locationReference S 0..* Reference(Location Profile - KPS) Destination facility for the referral (KPS.G.DE.5)
... reasonCode S 0..* CodeableConcept Reason(s) for the referral (KPS.G.DE.7)
Binding: Reason for Referral ValueSet (required)
... supportingInfo S 0..* Reference(Resource) Supporting clinical documents shared with the receiving facility
... note S 0..* Annotation Referral notes and clinical history summary (KPS.G.DE.14, KPS.G.DE.15)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.reasonCode Base required Reason for Referral ValueSet 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referralDirection S 0..1 CodeableConcept Referral Direction
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-direction
Binding: Referral Direction ValueSet (required)
.... extension:referralSource S 0..1 CodeableConcept Source of Referral
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-source
Binding: Source of Referral ValueSet (required)
.... extension:communicationPreference S 0..* CodeableConcept Communication Preference
URL: https://fhir.dha.go.ke/kps/StructureDefinition/communication-preference
Binding: Communication Preference ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifiers assigned to this order
... 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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: 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 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Σ 0..1 CodeableConcept Service being requested at the destination facility
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient Profile - KPS) Patient being referred
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter that triggered the referral
... occurrence[x] SΣ 0..1 dateTime Referral date (KPS.G.DE.6)
... 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 SΣ 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Referring clinician or source facility (KPS.G.DE.4, KPS.G.DE.13)
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... locationReference SΣ 0..* Reference(Location Profile - KPS) Destination facility for the referral (KPS.G.DE.5)
... reasonCode SΣ 0..* CodeableConcept Reason(s) for the referral (KPS.G.DE.7)
Binding: Reason for Referral ValueSet (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo S 0..* Reference(Resource) Supporting clinical documents shared with the receiving facility
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... note S 0..* Annotation Referral notes and clinical history summary (KPS.G.DE.14, KPS.G.DE.15)
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
ServiceRequest.reasonCode Base required Reason for Referral ValueSet 📦0.1.0 This IG
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referralDirection S 0..1 CodeableConcept Referral Direction
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-direction
Binding: Referral Direction ValueSet (required)
.... extension:referralSource S 0..1 CodeableConcept Source of Referral
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-source
Binding: Source of Referral ValueSet (required)
.... extension:communicationPreference S 0..* CodeableConcept Communication Preference
URL: https://fhir.dha.go.ke/kps/StructureDefinition/communication-preference
Binding: Communication Preference ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Required Pattern: order
... 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Σ 0..1 CodeableConcept Service being requested at the destination facility
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
... subject SΣ 1..1 Reference(Patient Profile - KPS) Patient being referred
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter that triggered the referral
... occurrence[x] SΣ 0..1 dateTime Referral date (KPS.G.DE.6)
... requester SΣ 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Referring clinician or source facility (KPS.G.DE.4, KPS.G.DE.13)
... locationReference SΣ 0..* Reference(Location Profile - KPS) Destination facility for the referral (KPS.G.DE.5)
... reasonCode SΣ 0..* CodeableConcept Reason(s) for the referral (KPS.G.DE.7)
Binding: Reason for Referral ValueSet (required)
... supportingInfo S 0..* Reference(Resource) Supporting clinical documents shared with the receiving facility
... note S 0..* Annotation Referral notes and clinical history summary (KPS.G.DE.14, KPS.G.DE.15)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base required Reason for Referral ValueSet 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referralDirection S 0..1 CodeableConcept Referral Direction
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-direction
Binding: Referral Direction ValueSet (required)
.... extension:referralSource S 0..1 CodeableConcept Source of Referral
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-source
Binding: Source of Referral ValueSet (required)
.... extension:communicationPreference S 0..* CodeableConcept Communication Preference
URL: https://fhir.dha.go.ke/kps/StructureDefinition/communication-preference
Binding: Communication Preference ValueSet (required)
... status S 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... code S 0..1 CodeableConcept Service being requested at the destination facility
... subject S 1..1 Reference(Patient Profile - KPS) Patient being referred
... encounter S 0..1 Reference(Encounter Profile - KPS) Encounter that triggered the referral
... occurrence[x] S 0..1 dateTime Referral date (KPS.G.DE.6)
... requester S 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Referring clinician or source facility (KPS.G.DE.4, KPS.G.DE.13)
... locationReference S 0..* Reference(Location Profile - KPS) Destination facility for the referral (KPS.G.DE.5)
... reasonCode S 0..* CodeableConcept Reason(s) for the referral (KPS.G.DE.7)
Binding: Reason for Referral ValueSet (required)
... supportingInfo S 0..* Reference(Resource) Supporting clinical documents shared with the receiving facility
... note S 0..* Annotation Referral notes and clinical history summary (KPS.G.DE.14, KPS.G.DE.15)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.reasonCode Base required Reason for Referral ValueSet 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referralDirection S 0..1 CodeableConcept Referral Direction
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-direction
Binding: Referral Direction ValueSet (required)
.... extension:referralSource S 0..1 CodeableConcept Source of Referral
URL: https://fhir.dha.go.ke/kps/StructureDefinition/referral-source
Binding: Source of Referral ValueSet (required)
.... extension:communicationPreference S 0..* CodeableConcept Communication Preference
URL: https://fhir.dha.go.ke/kps/StructureDefinition/communication-preference
Binding: Communication Preference ValueSet (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifiers assigned to this order
... 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 ?!SΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!SΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: 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 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Σ 0..1 CodeableConcept Service being requested at the destination facility
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient Profile - KPS) Patient being referred
... encounter SΣ 0..1 Reference(Encounter Profile - KPS) Encounter that triggered the referral
... occurrence[x] SΣ 0..1 dateTime Referral date (KPS.G.DE.6)
... 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 SΣ 0..1 Reference(Practitioner Profile - KPS | Organization Profile - KPS) Referring clinician or source facility (KPS.G.DE.4, KPS.G.DE.13)
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... locationReference SΣ 0..* Reference(Location Profile - KPS) Destination facility for the referral (KPS.G.DE.5)
... reasonCode SΣ 0..* CodeableConcept Reason(s) for the referral (KPS.G.DE.7)
Binding: Reason for Referral ValueSet (required)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo S 0..* Reference(Resource) Supporting clinical documents shared with the receiving facility
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... note S 0..* Annotation Referral notes and clinical history summary (KPS.G.DE.14, KPS.G.DE.15)
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
ServiceRequest.reasonCode Base required Reason for Referral ValueSet 📦0.1.0 This IG
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ServiceRequest If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ServiceRequest If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ServiceRequest If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ServiceRequest A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
prr-1 error ServiceRequest orderDetail SHALL only be present if code is present orderDetail.empty() or code.exists()

 

Other representations of profile: CSV, Excel, Schematron