ChanjoKE Immunization Implementation Guide
0.1.0 - ci-build
ChanjoKE Immunization Implementation Guide, published by Intellisoft Consulting Ltd. 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/ChanjoKe-FHIR-IG/ and changes regularly. See the Directory of published versions
Official URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/SupplyRequestProfile | Version: 0.1.0 | |||
Draft as of 2024-11-08 | Computable Name: SupplyRequestProfile |
A record of a request for a medication, substance or device used in the healthcare setting.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SupplyRequest
Path | Conformance | ValueSet | URI |
SupplyRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
SupplyRequest.status | required | SupplyRequestStatushttp://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.1 from the FHIR Standard | |
SupplyRequest.item[x] | example | SNOMEDCTSupplyItemhttp://hl7.org/fhir/ValueSet/supply-item from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyRequest | 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 | SupplyRequest | 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 | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyRequest | 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
date-of-last-order | S | 0..1 | date | Extension for Date Of last Order URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/date-of-last-order | ||||
expected-date-of-next-order | S | 0..1 | date | Extension for Expected Date of Next Order URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/expected-date-of-next-order | ||||
total-population | S | 0..1 | integer | Extension for Total Population URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/total-population | ||||
children | S | 0..1 | integer | Extension for Children URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/children | ||||
pregnant-women | S | 0..1 | integer | Extension for Pregnant women URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/pregnant-women | ||||
doses-in-stock | S | 0..1 | integer | Extension for Doses in stock URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/doses-in-stock | ||||
minimum | S | 0..1 | integer | Extension for Minimum URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/minimum | ||||
maximum | S | 0..1 | integer | Extension for Maximum URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/maximum | ||||
recommended-stock | S | 0..1 | integer | Extension for Recommended Stock URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/recommended-stock | ||||
ordered-amount | S | 0..1 | integer | Extension for Ordered Amount URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/ordered-amount | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business Identifier for SupplyRequest | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 0..1 | code | draft | active | suspended + Binding: SupplyRequestStatus (required): Status of the supply request. | ||||
category | Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc.) Binding: SupplyType (example): Category of supply request. | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
Slices for item[x] | Σ | 1..1 | Medication, Substance, or Device requested to be supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTSupplyItem (example): The item that was requested. | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Medication | Substance | Device) | |||||||
item[x]:itemReference | Σ | 0..1 | Reference(Medication) | Antigen | ||||
quantity | Σ | 1..1 | Quantity | The requested amount of the item indicated | ||||
parameter | 0..* | BackboneElement | Ordered item details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Item detail Binding Description (No ValueSet): (example): A code that identifies the device detail. | |||||
value[x] | 0..1 | Value of detail | ||||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueBoolean | boolean | |||||||
Slices for occurrence[x] | Σ | 1..1 | dateTime | When the request should be fulfilled Slice: Unordered, Closed by type:$this | ||||
occurrence[x]:occurrenceDateTime | SΣ | 1..1 | dateTime | When the request should be fulfilled | ||||
authoredOn | SΣ | 1..1 | dateTime | When the request was made | ||||
requester | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Individual making the request | ||||
supplier | Σ | 0..* | Reference(Organization | HealthcareService) | Who is intended to fulfill the request | ||||
reasonCode | 0..* | CodeableConcept | The reason why the supply item was requested Binding: SupplyRequestReason (example): The reason why the supply item was requested. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | The reason why the supply item was requested | |||||
deliverFrom | 0..1 | Reference(Organization | Location) | The origin of the supply | |||||
deliverTo | 0..1 | Reference(Organization | Location | Patient) | The destination of the supply | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
SupplyRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
SupplyRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
SupplyRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
SupplyRequest.status | required | SupplyRequestStatushttp://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.1 from the FHIR Standard | ||||
SupplyRequest.category | example | SupplyTypehttp://hl7.org/fhir/ValueSet/supplyrequest-kind from the FHIR Standard | ||||
SupplyRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
SupplyRequest.item[x] | example | SNOMEDCTSupplyItemhttp://hl7.org/fhir/ValueSet/supply-item from the FHIR Standard | ||||
SupplyRequest.parameter.code | example | |||||
SupplyRequest.reasonCode | example | SupplyRequestReasonhttp://hl7.org/fhir/ValueSet/supplyrequest-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyRequest | 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 | SupplyRequest | 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 | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyRequest | 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() |
This structure is derived from SupplyRequest
Summary
Mandatory: 4 elements
Must-Support: 15 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from SupplyRequest
Key Elements View
Path | Conformance | ValueSet | URI |
SupplyRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
SupplyRequest.status | required | SupplyRequestStatushttp://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.1 from the FHIR Standard | |
SupplyRequest.item[x] | example | SNOMEDCTSupplyItemhttp://hl7.org/fhir/ValueSet/supply-item from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyRequest | 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 | SupplyRequest | 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 | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyRequest | 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |||||
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
date-of-last-order | S | 0..1 | date | Extension for Date Of last Order URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/date-of-last-order | ||||
expected-date-of-next-order | S | 0..1 | date | Extension for Expected Date of Next Order URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/expected-date-of-next-order | ||||
total-population | S | 0..1 | integer | Extension for Total Population URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/total-population | ||||
children | S | 0..1 | integer | Extension for Children URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/children | ||||
pregnant-women | S | 0..1 | integer | Extension for Pregnant women URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/pregnant-women | ||||
doses-in-stock | S | 0..1 | integer | Extension for Doses in stock URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/doses-in-stock | ||||
minimum | S | 0..1 | integer | Extension for Minimum URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/minimum | ||||
maximum | S | 0..1 | integer | Extension for Maximum URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/maximum | ||||
recommended-stock | S | 0..1 | integer | Extension for Recommended Stock URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/recommended-stock | ||||
ordered-amount | S | 0..1 | integer | Extension for Ordered Amount URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/ordered-amount | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..* | Identifier | Business Identifier for SupplyRequest | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
status | ?!Σ | 0..1 | code | draft | active | suspended + Binding: SupplyRequestStatus (required): Status of the supply request. | ||||
category | Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc.) Binding: SupplyType (example): Category of supply request. | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
Slices for item[x] | Σ | 1..1 | Medication, Substance, or Device requested to be supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTSupplyItem (example): The item that was requested. | |||||
itemCodeableConcept | CodeableConcept | |||||||
itemReference | Reference(Medication | Substance | Device) | |||||||
item[x]:itemReference | Σ | 0..1 | Reference(Medication) | Antigen | ||||
quantity | Σ | 1..1 | Quantity | The requested amount of the item indicated | ||||
parameter | 0..* | BackboneElement | Ordered item details | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | CodeableConcept | Item detail Binding Description (No ValueSet): (example): A code that identifies the device detail. | |||||
value[x] | 0..1 | Value of detail | ||||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueBoolean | boolean | |||||||
Slices for occurrence[x] | Σ | 1..1 | dateTime | When the request should be fulfilled Slice: Unordered, Closed by type:$this | ||||
occurrence[x]:occurrenceDateTime | SΣ | 1..1 | dateTime | When the request should be fulfilled | ||||
authoredOn | SΣ | 1..1 | dateTime | When the request was made | ||||
requester | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Individual making the request | ||||
supplier | Σ | 0..* | Reference(Organization | HealthcareService) | Who is intended to fulfill the request | ||||
reasonCode | 0..* | CodeableConcept | The reason why the supply item was requested Binding: SupplyRequestReason (example): The reason why the supply item was requested. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | The reason why the supply item was requested | |||||
deliverFrom | 0..1 | Reference(Organization | Location) | The origin of the supply | |||||
deliverTo | 0..1 | Reference(Organization | Location | Patient) | The destination of the supply | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
SupplyRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
SupplyRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
SupplyRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
SupplyRequest.status | required | SupplyRequestStatushttp://hl7.org/fhir/ValueSet/supplyrequest-status|4.0.1 from the FHIR Standard | ||||
SupplyRequest.category | example | SupplyTypehttp://hl7.org/fhir/ValueSet/supplyrequest-kind from the FHIR Standard | ||||
SupplyRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
SupplyRequest.item[x] | example | SNOMEDCTSupplyItemhttp://hl7.org/fhir/ValueSet/supply-item from the FHIR Standard | ||||
SupplyRequest.parameter.code | example | |||||
SupplyRequest.reasonCode | example | SupplyRequestReasonhttp://hl7.org/fhir/ValueSet/supplyrequest-reason from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyRequest | 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 | SupplyRequest | 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 | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyRequest | 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() |
This structure is derived from SupplyRequest
Summary
Mandatory: 4 elements
Must-Support: 15 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron