SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. 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/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

## Resource Profile: SGHIServiceRequest - Detailed Descriptions

Draft as of 2026-05-21

Definitions for the servicerequest resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. ServiceRequest
Definition | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
Short | A request for a service to be performed
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | diagnostic request, referral, referral request, transfer of care request
Invariants | bdystr-1: bodyStructure SHALL only be present if bodySite is not present (bodySite.exists() implies bodyStructure.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) prr-1: orderDetail SHALL only be present if code is present (orderDetail.empty() or code.exists())
2. ServiceRequest.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ServiceRequest.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. ServiceRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. ServiceRequest.identifier
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Short | Identifiers assigned to this order
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 V2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 V2). For further discussion and examples see the resource notes section below.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ServiceRequest.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ServiceRequest.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from SGHI Default Identifier Types http://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ServiceRequest.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ServiceRequest.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. ServiceRequest.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Organization, Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. ServiceRequest.basedOn
Definition | Plan/proposal/order fulfilled by this request.
Short | What request fulfills
Control | 0..*
Type | Reference(SGHI Reference)(SGHI MedicationRequest, SGHI ServiceRequest, CarePlan, ServiceRequest, MedicationRequest)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | fulfills
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. ServiceRequest.replaces
Definition | The request takes the place of the referenced completed or terminated request(s).
Short | What request replaces
Control | 0..*
Type | Reference(SGHI Reference)(SGHI ServiceRequest, ServiceRequest)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | supersedes, prior, renewed order
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. ServiceRequest.status
Definition | The status of the order.
Short | draft | active | on-hold | revoked | completed | entered-in-error | unknown
Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.
Control | 1..1
Binding | The codes SHALL be taken from RequestStatus http://hl7.org/fhir/ValueSet/request-status|5.0.0 (required to `http://hl7.org/fhir/ValueSet/request-status|5.0.0` ) The status of a service order.
Type | code
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. ServiceRequest.intent
Definition | Whether the request is a proposal, plan, an original order or a reflex order.
Short | proposal | plan | directive | order +
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
Control | 1..1
Binding | The codes SHALL be taken from RequestIntent http://hl7.org/fhir/ValueSet/request-intent|5.0.0 (required to `http://hl7.org/fhir/ValueSet/request-intent|5.0.0` ) The kind of service request.
Type | code
Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. ServiceRequest.category
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Short | Classification of service
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.
Control | 10..*
Binding | The codes SHALL be taken from For example codes, see Service Request Categories http://hl7.org/fhir/ValueSet/servicerequest-category|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/service-request-category` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Used for filtering what service request are retrieved and displayed.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. ServiceRequest.priority
Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Short | routine | urgent | asap | stat
Control | 10..1
Binding | The codes SHALL be taken from RequestPriority http://hl7.org/fhir/ValueSet/request-priority|5.0.0 (required to `http://hl7.org/fhir/ValueSet/request-priority|5.0.0` ) Identifies the level of importance to be assigned to actioning the request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Meaning if Missing | If missing, this task should be performed with normal priority
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. ServiceRequest.doNotPerform
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed.
Short | True if service/procedure should not be performed
Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.
Control | 0..1
Type | boolean
Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.
Meaning if Missing | If missing, the request is a positive request e.g. "do perform"
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. ServiceRequest.code
Definition | A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
Short | What is being requested/ordered
Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.
Control | 0..1 This element is affected by the following invariants: prr-1
Binding | The codes SHALL be taken from For example codes, see All LOINC Codes http://hl7.org/fhir/ValueSet/procedure-code|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(ActivityDefinition, PlanDefinition, ActivityDefinition, PlanDefinition)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | service requested
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. ServiceRequest.subject
Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
Short | Individual or Entity the service is ordered for
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient, Patient, Group, Location, Device)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. ServiceRequest.encounter
Definition | An encounter that provides additional information about the healthcare context in which this request is made.
Short | Encounter in which the request was created
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Encounter, Encounter)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | context
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. ServiceRequest.authoredOn
Definition | When the request transitioned to being actionable.
Short | Date request signed
Control | 10..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Alternate Names | orderedOn
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. ServiceRequest.requester
Definition | The individual who initiated the request and has responsibility for its activation.
Short | Who/what is requesting service
Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | author, orderer
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. ServiceRequest.performer
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
Short | Requested performer
Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the http://hl7.org/fhir/StructureDefinition/request-performerOrder. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B).
Control | 10..*
Type | Reference(SGHI Reference)(SGHI Organization, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | request recipient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. ServiceRequest.location
Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
Short | Requested location
Control | 0..*
Binding | For example codes, see ServiceDeliveryLocationRoleType http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (example to `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType` ) A location type where services are delivered.
Type | CodeableReference(SGHI CodeableReference)(SGHI Location, Location)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. ServiceRequest.reason
Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
Short | Explanation/Justification for procedure or service
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use `concept.text` element if the data is free (uncoded) text as shown in the CT Scan example. This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use `concept.text` element if the data is free (uncoded) text as shown in the CT Scan example.
Control | 10..*
Binding | The codes SHALL be taken from For example codes, see All LOINC Codes http://hl7.org/fhir/ValueSet/procedure-reason|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(SGHI Condition, SGHI Observation, SGHI DiagnosticReport, Condition, Observation, DiagnosticReport, DocumentReference, DetectedIssue)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. ServiceRequest
2. ServiceRequest.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
4. ServiceRequest.identifier.use
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
6. ServiceRequest.identifier.type
Binding | The codes SHALL be taken from SGHI Default Identifier Types (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
8. ServiceRequest.identifier.system
Control | 1..?
10. ServiceRequest.identifier.value
Control | 1..?
12. ServiceRequest.identifier.assigner
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization)
14. ServiceRequest.basedOn
Type | Reference(SGHI Reference)(SGHI MedicationRequest, SGHI ServiceRequest)
16. ServiceRequest.replaces
Type | Reference(SGHI Reference)(SGHI ServiceRequest)
18. ServiceRequest.category
Control | 1..?
Binding | The codes SHALL be taken from Service Request Categories (required to `https://fhir.slade360.co.ke/fhir/ValueSet/service-request-category` )
Type | CodeableConcept(SGHI CodeableConcept)
20. ServiceRequest.priority
Control | 1..?
22. ServiceRequest.code
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(ActivityDefinition, PlanDefinition)
24. ServiceRequest.subject
Type | Reference(SGHI Reference)(SGHI Patient)
26. ServiceRequest.encounter
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Encounter)
28. ServiceRequest.authoredOn
Control | 1..?
30. ServiceRequest.requester
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
32. ServiceRequest.performer
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization)
34. ServiceRequest.location
Type | CodeableReference(SGHI CodeableReference)(SGHI Location)
36. ServiceRequest.reason
Control | 1..?
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(SGHI Condition, SGHI Observation, SGHI DiagnosticReport)

Guidance on how to interpret the contents of this table can be foundhere

0. ServiceRequest
Definition | A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
Short | A request for a service to be performed
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | diagnostic request, referral, referral request, transfer of care request
Invariants | bdystr-1: bodyStructure SHALL only be present if bodySite is not present (`bodySite.exists() implies bodyStructure.empty()`) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`) prr-1: orderDetail SHALL only be present if code is present (`orderDetail.empty() or code.exists()`)
2. ServiceRequest.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. ServiceRequest.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. ServiceRequest.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. ServiceRequest.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. ServiceRequest.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. ServiceRequest.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. ServiceRequest.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. ServiceRequest.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. ServiceRequest.identifier
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Short | Identifiers assigned to this order
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 V2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 V2). For further discussion and examples see the resource notes section below.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. ServiceRequest.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
22. ServiceRequest.identifier.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `ServiceRequest.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
24. ServiceRequest.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. ServiceRequest.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | The codes SHALL be taken from SGHI Default Identifier Types (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. ServiceRequest.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. ServiceRequest.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. ServiceRequest.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. ServiceRequest.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. ServiceRequest.instantiatesCanonical
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Short | Instantiates FHIR protocol or definition
Comments | The PlanDefinition resource is used to describe series, sequences, or groups of actions to be taken, while the ActivityDefinition resource is used to define each specific step or activity to be performed. More information can be found in the Boundaries and Relationships section for PlanDefinition.
Control | 0..*
Type | canonical(ActivityDefinition, PlanDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. ServiceRequest.instantiatesUri
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
Short | Instantiates external protocol or definition
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
Control | 0..*
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. ServiceRequest.basedOn
Definition | Plan/proposal/order fulfilled by this request.
Short | What request fulfills
Control | 0..*
Type | Reference(SGHI Reference)(SGHI MedicationRequest, SGHI ServiceRequest)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | fulfills
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. ServiceRequest.replaces
Definition | The request takes the place of the referenced completed or terminated request(s).
Short | What request replaces
Control | 0..*
Type | Reference(SGHI Reference)(SGHI ServiceRequest)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | supersedes, prior, renewed order
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. ServiceRequest.requisition
Definition | A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
Short | Composite Request ID
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
Control | 0..1
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Requirements | Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes.
Alternate Names | grouperId, groupIdentifier
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. ServiceRequest.status
Definition | The status of the order.
Short | draft | active | on-hold | revoked | completed | entered-in-error | unknown
Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, revoked or placed on-hold. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource.
Control | 1..1
Binding | The codes SHALL be taken from RequestStatus (required to `http://hl7.org/fhir/ValueSet/request-status|5.0.0` ) The status of a service order.
Type | code
Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. ServiceRequest.intent
Definition | Whether the request is a proposal, plan, an original order or a reflex order.
Short | proposal | plan | directive | order +
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
Control | 1..1
Binding | The codes SHALL be taken from RequestIntent (required to `http://hl7.org/fhir/ValueSet/request-intent|5.0.0` ) The kind of service request.
Type | code
Is Modifier | true because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. ServiceRequest.category
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Short | Classification of service
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set.
Control | 1..*
Binding | The codes SHALL be taken from Service Request Categories (required to `https://fhir.slade360.co.ke/fhir/ValueSet/service-request-category` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Used for filtering what service request are retrieved and displayed.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. ServiceRequest.priority
Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Short | routine | urgent | asap | stat
Control | 1..1
Binding | The codes SHALL be taken from RequestPriority (required to `http://hl7.org/fhir/ValueSet/request-priority|5.0.0` ) Identifies the level of importance to be assigned to actioning the request.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Meaning if Missing | If missing, this task should be performed with normal priority
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. ServiceRequest.doNotPerform
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed.
Short | True if service/procedure should not be performed
Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation.
Control | 0..1
Type | boolean
Is Modifier | true because If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc.
Meaning if Missing | If missing, the request is a positive request e.g. "do perform"
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. ServiceRequest.code
Definition | A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
Short | What is being requested/ordered
Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code.
Control | 0..1 This element is affected by the following invariants: prr-1
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(ActivityDefinition, PlanDefinition)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | service requested
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. ServiceRequest.orderDetail
Definition | Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
Short | Additional order information
Comments | For information from the medical record intended to support the delivery of the requested services, use the `supportingInformation` element.
Control | 0..* This element is affected by the following invariants: prr-1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | detailed instructions
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. ServiceRequest.orderDetail.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
62. ServiceRequest.orderDetail.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
64. ServiceRequest.orderDetail.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
66. ServiceRequest.orderDetail.parameterFocus
Definition | Indicates the context of the order details by reference.
Short | The context of the order details by reference
Control | 0..1
Type | CodeableReference(Device, DeviceDefinition, DeviceRequest, SupplyRequest, Medication, MedicationRequest, BiologicallyDerivedProduct, Substance)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. ServiceRequest.orderDetail.parameter
Definition | The parameter details for the service being requested.
Short | The parameter details for the service being requested
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. ServiceRequest.orderDetail.parameter.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
72. ServiceRequest.orderDetail.parameter.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
74. ServiceRequest.orderDetail.parameter.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
76. ServiceRequest.orderDetail.parameter.code
Definition | A value representing the additional detail or instructions for the order (e.g., catheter insertion, body elevation, descriptive device configuration and/or setting instructions).
Short | The detail of the order being requested
Control | 1..1
Binding | For example codes, see ServiceRequestOrderDetailParameterCode (example to `http://hl7.org/fhir/ValueSet/servicerequest-orderdetail-parameter-code|5.0.0` ) Codes for order detail parameters.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. ServiceRequest.orderDetail.parameter.value[x]
Definition | Indicates a value for the order detail.
Short | The value for the order detail
Comments | CodeableConcept values are indented to express concepts that would normally be coded - when a code is not available for a concept, CodeableConcept.text can be used. When the data is a text or not a single identifiable concept, string should be used.
Control | 1..1
Type | Choice of: Quantity, Ratio, Range, boolean, CodeableConcept, string, Period
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. ServiceRequest.quantity[x]
Definition | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
Short | Service amount
Control | 0..1
Type | Choice of: Quantity, Ratio, Range
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Must Support | false
Summary | true
Requirements | When ordering a service the number of service items may need to be specified separately from the the service item.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. ServiceRequest.subject
Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
Short | Individual or Entity the service is ordered for
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. ServiceRequest.focus
Definition | The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject's diet, another service request on the subject, or a body structure such as tumor or implanted device.
Short | What the service request is about, when it is not about the subject of record
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. ServiceRequest.encounter
Definition | An encounter that provides additional information about the healthcare context in which this request is made.
Short | Encounter in which the request was created
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Encounter)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | context
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. ServiceRequest.occurrence[x]
Definition | The date/time at which the requested service should occur.
Short | When service should occur
Control | 0..1
Type | Choice of: dateTime, Period, Timing
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Alternate Names | schedule
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. ServiceRequest.asNeeded[x]
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Short | Preconditions for service
Control | 0..1
Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to `http://hl7.org/fhir/ValueSet/medication-as-needed-reason|5.0.0` ) A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
Type | Choice of: boolean, CodeableConcept
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. ServiceRequest.authoredOn
Definition | When the request transitioned to being actionable.
Short | Date request signed
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Alternate Names | orderedOn
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. ServiceRequest.requester
Definition | The individual who initiated the request and has responsibility for its activation.
Short | Who/what is requesting service
Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource.
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization, SGHI Patient)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | author, orderer
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. ServiceRequest.performerType
Definition | Desired type of performer for doing the requested service.
Short | Performer role
Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”.
Control | 0..1
Binding | For example codes, see ParticipantRoles (example to `http://hl7.org/fhir/ValueSet/participant-role|5.0.0` ) Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | specialty
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. ServiceRequest.performer
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
Short | Requested performer
Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the http://hl7.org/fhir/StructureDefinition/request-performerOrder. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B).
Control | 1..*
Type | Reference(SGHI Reference)(SGHI Organization)
Is Modifier | false
Must Support | false
Summary | true
Alternate Names | request recipient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. ServiceRequest.location
Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
Short | Requested location
Control | 0..*
Binding | For example codes, see ServiceDeliveryLocationRoleType (example to `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType` ) A location type where services are delivered.
Type | CodeableReference(SGHI CodeableReference)(SGHI Location)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. ServiceRequest.reason
Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
Short | Explanation/Justification for procedure or service
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise, use `concept.text` element if the data is free (uncoded) text as shown in the CT Scan example.
Control | 1..*
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(SGHI Condition, SGHI Observation, SGHI DiagnosticReport)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. ServiceRequest.insurance
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
Short | Associated insurance coverage
Control | 0..*
Type | Reference(Coverage, ClaimResponse)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. ServiceRequest.supportingInfo
Definition | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
Short | Additional clinical information
Comments | To represent information about how the services are to be delivered use the `instructions` element.
Control | 0..*
Type | CodeableReference(Resource)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | Ask at order entry question, AOE
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. ServiceRequest.specimen
Definition | One or more specimens that the laboratory procedure will use.
Short | Procedure Samples
Comments | The purpose of the ServiceRequest.specimen is to reflect the actual specimen that the requested test/procedure is asked to be performed on, whether the lab already has it or not. References to specimens for purposes other than to perform a test/procedure on should be made using the ServiceRequest.supportingInfo or the Specimen.parent where the Specimen.parent would enable descendency and ServiceRequest.supportingInfo a general reference for context.
Control | 0..*
Type | Reference(Specimen)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. ServiceRequest.bodySite
Definition | Anatomic location where the procedure should be performed. This is the target site.
Short | Coded location on Body
Comments | Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure.
Control | 0..* This element is affected by the following invariants: bdystr-1
Binding | For example codes, see SNOMEDCTBodyStructures (example to `http://hl7.org/fhir/ValueSet/body-site|5.0.0` ) SNOMED CT Body site concepts
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible.
Alternate Names | location
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. ServiceRequest.bodyStructure
Definition | Anatomic location where the procedure should be performed. This is the target site.
Short | BodyStructure-based location on the body
Control | 0..1 This element is affected by the following invariants: bdystr-1
Type | Reference(BodyStructure)
Is Modifier | false
Must Support | false
Summary | true
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible.
Alternate Names | locationStructure
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. ServiceRequest.note
Definition | Any other notes and comments made about the service request. For example, internal billing notes.
Short | Comments
Control | 0..*
Type | Annotation
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. ServiceRequest.patientInstruction
Definition | Instructions in terms that are understood by the patient or consumer.
Short | Patient or consumer-oriented instructions
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. ServiceRequest.patientInstruction.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
120. ServiceRequest.patientInstruction.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
122. ServiceRequest.patientInstruction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
124. ServiceRequest.patientInstruction.instruction[x]
Definition | Instructions in terms that are understood by the patient or consumer.
Short | Patient or consumer-oriented instructions
Control | 0..1
Type | Choice of: markdown, Reference(DocumentReference)
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. ServiceRequest.relevantHistory
Definition | Key events in the history of the request.
Short | Request provenance
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.
Control | 0..*
Type | Reference(Provenance)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)