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/SupplyDeliveryProfile | Version: 0.1.0 | |||
Draft as of 2024-11-08 | Computable Name: SupplyDeliveryProfile |
Record of delivery of what is supplied.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SupplyDelivery
Path | Conformance | ValueSet | URI |
SupplyDelivery.status | required | SupplyDeliveryStatushttp://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1 from the FHIR Standard | |
SupplyDelivery.type | required | SupplyItemTypehttp://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyDelivery | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyDelivery | 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 | SupplyDelivery | 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 | SupplyDelivery | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyDelivery | 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() |
Path | Conformance | ValueSet | URI | |||
SupplyDelivery.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
SupplyDelivery.status | required | SupplyDeliveryStatushttp://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1 from the FHIR Standard | ||||
SupplyDelivery.type | required | SupplyItemTypehttp://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyDelivery | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyDelivery | 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 | SupplyDelivery | 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 | SupplyDelivery | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyDelivery | 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 SupplyDelivery
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 24 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from SupplyDelivery
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SupplyDelivery | 0..* | SupplyDelivery | Delivery of bulk Supplies | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dateReceived | S | 0..1 | date | Extension for Date Received URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/date-received |
origin | S | 0..1 | string | Extension for Origin URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/origin |
orderNumber | S | 0..1 | integer | Extension for Order number URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/order-number |
vaccine | S | 0..1 | code | Extension for Vaccine URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vaccine |
expiryDate | S | 0..1 | date | Extension for ExpiryDate URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/expiry-date |
stockQuantity | S | 0..1 | integer | Extension for Stock Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-quantity |
manufacturerDetails | S | 0..1 | string | Extension for Manufacturer Details URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/manufacturer-details |
allocatedQuantity | S | 0..1 | integer | Extension for Allocated Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/allocated-quantity |
remainingQuantity | S | 0..1 | integer | Extension for Remaining Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/remaining-quantity |
issueDate | S | 0..1 | date | Extension for Issue Date URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/issue-date |
stockLocation | S | 0..1 | string | Extension for Stock Location URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-location |
batchNumber | S | 0..1 | string | Extension for Batch Number URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/batch-number |
quantityIssued | S | 0..1 | integer | Extension for Quantity Issued URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/quantity-issued |
vvmStatus | S | 0..1 | string | Extension for VVM Status URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vvm-status |
reasonForAdjustment | S | 0..1 | string | Extension for Reason For Adjustment URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/reason-for-adjustment |
stockOrigin | S | 0..1 | string | Extension for Reason For Stock Origin URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-origin |
previousVVM | S | 0..1 | string | Extension for Reason For Previous VVM URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/previous-vvm |
newVVM | S | 0..1 | string | Extension for Reason For New VVM URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/new-vvm |
physicalCount | S | 0..1 | integer | Extension for Physical Count URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/physical-count |
stockAdjustmentDate | S | 0..1 | date | Extension for Stock Adjustment Date URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-adjustment-date |
identifier | S | 1..1 | Identifier | External identifier |
type | S | 1..1 | CodeableConcept | VVM Status |
suppliedItem | ||||
quantity | S | 1..1 | SimpleQuantity | Amount dispensed |
item[x] | S | 1..1 | Reference(Medication) | Medication, Substance, or Device supplied |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SupplyDelivery | 0..* | SupplyDelivery | Delivery of bulk Supplies | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
dateReceived | S | 0..1 | date | Extension for Date Received URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/date-received |
origin | S | 0..1 | string | Extension for Origin URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/origin |
orderNumber | S | 0..1 | integer | Extension for Order number URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/order-number |
vaccine | S | 0..1 | code | Extension for Vaccine URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vaccine |
expiryDate | S | 0..1 | date | Extension for ExpiryDate URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/expiry-date |
stockQuantity | S | 0..1 | integer | Extension for Stock Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-quantity |
manufacturerDetails | S | 0..1 | string | Extension for Manufacturer Details URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/manufacturer-details |
allocatedQuantity | S | 0..1 | integer | Extension for Allocated Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/allocated-quantity |
remainingQuantity | S | 0..1 | integer | Extension for Remaining Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/remaining-quantity |
issueDate | S | 0..1 | date | Extension for Issue Date URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/issue-date |
stockLocation | S | 0..1 | string | Extension for Stock Location URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-location |
batchNumber | S | 0..1 | string | Extension for Batch Number URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/batch-number |
quantityIssued | S | 0..1 | integer | Extension for Quantity Issued URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/quantity-issued |
vvmStatus | S | 0..1 | string | Extension for VVM Status URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vvm-status |
reasonForAdjustment | S | 0..1 | string | Extension for Reason For Adjustment URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/reason-for-adjustment |
stockOrigin | S | 0..1 | string | Extension for Reason For Stock Origin URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-origin |
previousVVM | S | 0..1 | string | Extension for Reason For Previous VVM URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/previous-vvm |
newVVM | S | 0..1 | string | Extension for Reason For New VVM URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/new-vvm |
physicalCount | S | 0..1 | integer | Extension for Physical Count URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/physical-count |
stockAdjustmentDate | S | 0..1 | date | Extension for Stock Adjustment Date URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-adjustment-date |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | S | 1..1 | Identifier | External identifier |
status | ?!Σ | 0..1 | code | in-progress | completed | abandoned | entered-in-error Binding: SupplyDeliveryStatus (required): Status of the supply delivery. |
type | S | 1..1 | CodeableConcept | VVM Status Binding: SupplyItemType (required): The type of supply dispense. |
suppliedItem | 0..1 | BackboneElement | The item that is delivered or supplied | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
quantity | S | 1..1 | SimpleQuantity | Amount dispensed |
item[x] | S | 1..1 | Reference(Medication) | Medication, Substance, or Device supplied |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SupplyDelivery.status | required | SupplyDeliveryStatushttp://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1 from the FHIR Standard | |
SupplyDelivery.type | required | SupplyItemTypehttp://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyDelivery | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyDelivery | 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 | SupplyDelivery | 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 | SupplyDelivery | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyDelivery | 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 | ||||
---|---|---|---|---|---|---|---|---|
SupplyDelivery | 0..* | SupplyDelivery | Delivery of bulk Supplies | |||||
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 | |||||
dateReceived | S | 0..1 | date | Extension for Date Received URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/date-received | ||||
origin | S | 0..1 | string | Extension for Origin URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/origin | ||||
orderNumber | S | 0..1 | integer | Extension for Order number URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/order-number | ||||
vaccine | S | 0..1 | code | Extension for Vaccine URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vaccine | ||||
expiryDate | S | 0..1 | date | Extension for ExpiryDate URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/expiry-date | ||||
stockQuantity | S | 0..1 | integer | Extension for Stock Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-quantity | ||||
manufacturerDetails | S | 0..1 | string | Extension for Manufacturer Details URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/manufacturer-details | ||||
allocatedQuantity | S | 0..1 | integer | Extension for Allocated Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/allocated-quantity | ||||
remainingQuantity | S | 0..1 | integer | Extension for Remaining Quantity URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/remaining-quantity | ||||
issueDate | S | 0..1 | date | Extension for Issue Date URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/issue-date | ||||
stockLocation | S | 0..1 | string | Extension for Stock Location URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-location | ||||
batchNumber | S | 0..1 | string | Extension for Batch Number URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/batch-number | ||||
quantityIssued | S | 0..1 | integer | Extension for Quantity Issued URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/quantity-issued | ||||
vvmStatus | S | 0..1 | string | Extension for VVM Status URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/vvm-status | ||||
reasonForAdjustment | S | 0..1 | string | Extension for Reason For Adjustment URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/reason-for-adjustment | ||||
stockOrigin | S | 0..1 | string | Extension for Reason For Stock Origin URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-origin | ||||
previousVVM | S | 0..1 | string | Extension for Reason For Previous VVM URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/previous-vvm | ||||
newVVM | S | 0..1 | string | Extension for Reason For New VVM URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/new-vvm | ||||
physicalCount | S | 0..1 | integer | Extension for Physical Count URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/physical-count | ||||
stockAdjustmentDate | S | 0..1 | date | Extension for Stock Adjustment Date URL: https://chanjoke.intellisoftkenya.com/fhir/StructureDefinition/stock-adjustment-date | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | S | 1..1 | Identifier | External identifier | ||||
basedOn | Σ | 0..* | Reference(SupplyRequest) | Fulfills plan, proposal or order | ||||
partOf | Σ | 0..* | Reference(SupplyDelivery | Contract) | Part of referenced event | ||||
status | ?!Σ | 0..1 | code | in-progress | completed | abandoned | entered-in-error Binding: SupplyDeliveryStatus (required): Status of the supply delivery. | ||||
patient | 0..1 | Reference(Patient) | Patient for whom the item is supplied | |||||
type | S | 1..1 | CodeableConcept | VVM Status Binding: SupplyItemType (required): The type of supply dispense. | ||||
suppliedItem | 0..1 | BackboneElement | The item that is delivered or supplied | |||||
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 | ||||
quantity | S | 1..1 | SimpleQuantity | Amount dispensed | ||||
item[x] | S | 1..1 | Reference(Medication) | Medication, Substance, or Device supplied | ||||
occurrence[x] | Σ | 0..1 | When event occurred | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
supplier | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Dispenser | |||||
destination | 0..1 | Reference(Location) | Where the Supply was sent | |||||
receiver | 0..* | Reference(Practitioner | PractitionerRole) | Who collected the Supply | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
SupplyDelivery.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
SupplyDelivery.status | required | SupplyDeliveryStatushttp://hl7.org/fhir/ValueSet/supplydelivery-status|4.0.1 from the FHIR Standard | ||||
SupplyDelivery.type | required | SupplyItemTypehttp://hl7.org/fhir/ValueSet/supplydelivery-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | SupplyDelivery | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SupplyDelivery | 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 | SupplyDelivery | 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 | SupplyDelivery | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SupplyDelivery | 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 SupplyDelivery
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 24 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron