Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services
1.0.1 - ci-build Ethiopia flag

Ethiopia FHIR Implementation Guide - HIV Treatment & Care Services, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/ethiopia-hiv/ and changes regularly. See the Directory of published versions

Resource Profile: List - History of Past Medication

Official URL: http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history Version: 1.0.1
Draft as of 2024-09-20 Computable Name: MedicationHistory

Documents the medication history of previsouly prescribed (cotrimoxazole, isoniazid and ARV) treatment for the patient.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..* List A list is a curated collection of resources
... status 1..1 code current | retired | entered-in-error
Required Pattern: current
... title 1..1 string Descriptive name for the list
Required Pattern: Medication History
... code 1..1 CodeableConcept What the purpose of this list is
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8677-7
... encounter 1..1 Reference(Encounter - Initiated By The Facility Providing the Service) Context in which list created
... date 1..1 dateTime When the list was prepared
... source 1..1 Reference(Practitioner - General Practitioner) Who and/or what defined the list contents (aka Author)
... Slices for entry C 1..* BackboneElement Entries in the list
Slice: Unordered, Open by value:flag.coding
List-Medical-History-2: The List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
.... entry:Cotrimoxazole S 0..1 BackboneElement Entries in the list
..... flag 1..1 CodeableConcept Status/Workflow information about this item
...... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18998-5
..... item 1..1 Reference(Medication Statement - Opportunisic Infections (OI)) Actual entry
.... entry:Isoniazid S 0..1 BackboneElement Entries in the list
..... flag 1..1 CodeableConcept Status/Workflow information about this item
...... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18934-0
..... item 1..1 Reference(Medication Statement - TB Preventive Therapy (TPT)) Actual entry
.... entry:ARV S 0..* BackboneElement Entries in the list
..... flag 1..1 CodeableConcept Status/Workflow information about this item
...... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47248-0
..... item 1..1 Reference(Observation - HIV Treatment Prior to Enrollment | Medication Statement - ART | Observation - Current HIV Treatment Therapy Duration) Actual entry

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
List-Medical-History-2errorList.entryThe List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
: slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Cotrimoxazole').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Isoniazid').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'ARV').count() > 0
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... title Σ 1..1 string Descriptive name for the list
Required Pattern: Medication History
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8677-7
... subject Σ 1..1 Reference(Patient) If all resources have the same subject
... encounter 1..1 Reference(Encounter - Initiated By The Facility Providing the Service) Context in which list created
... date Σ 1..1 dateTime When the list was prepared
... source Σ 1..1 Reference(Practitioner - General Practitioner) Who and/or what defined the list contents (aka Author)
... Slices for entry C 1..* BackboneElement Entries in the list
Slice: Unordered, Open by value:flag.coding
List-Medical-History-2: The List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Resource) Actual entry
.... entry:Cotrimoxazole SC 0..1 BackboneElement Entries in the list
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18998-5
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Medication Statement - Opportunisic Infections (OI)) Actual entry
.... entry:Isoniazid SC 0..1 BackboneElement Entries in the list
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18934-0
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Medication Statement - TB Preventive Therapy (TPT)) Actual entry
.... entry:ARV SC 0..* BackboneElement Entries in the list
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47248-0
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Observation - HIV Treatment Prior to Enrollment | Medication Statement - ART | Observation - Current HIV Treatment Therapy Duration) Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexamplePattern: LOINC Code 8677-7
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.entry:Cotrimoxazole.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:Isoniazid.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:ARV.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
List-Medical-History-2errorList.entryThe List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
: slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Cotrimoxazole').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Isoniazid').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'ARV').count() > 0
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ 1..1 string Descriptive name for the list
Required Pattern: Medication History
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8677-7
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Patient) If all resources have the same subject
... encounter 1..1 Reference(Encounter - Initiated By The Facility Providing the Service) Context in which list created
... date Σ 1..1 dateTime When the list was prepared
... source Σ 1..1 Reference(Practitioner - General Practitioner) Who and/or what defined the list contents (aka Author)
... orderedBy 0..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..* Annotation Comments about the list
... Slices for entry C 1..* BackboneElement Entries in the list
Slice: Unordered, Open by value:flag.coding
List-Medical-History-2: The List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
.... entry:All Slices Content/Rules for all slices
..... 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
..... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Resource) Actual entry
.... entry:Cotrimoxazole SC 0..1 BackboneElement Entries in the list
..... 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
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18998-5
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Medication Statement - Opportunisic Infections (OI)) Actual entry
.... entry:Isoniazid SC 0..1 BackboneElement Entries in the list
..... 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
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18934-0
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Medication Statement - TB Preventive Therapy (TPT)) Actual entry
.... entry:ARV SC 0..* BackboneElement Entries in the list
..... 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
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47248-0
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Observation - HIV Treatment Prior to Enrollment | Medication Statement - ART | Observation - Current HIV Treatment Therapy Duration) Actual entry
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexamplePattern: LOINC Code 8677-7
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:Cotrimoxazole.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:Isoniazid.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:ARV.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
List-Medical-History-2errorList.entryThe List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
: slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Cotrimoxazole').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Isoniazid').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'ARV').count() > 0
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..* List A list is a curated collection of resources
... status 1..1 code current | retired | entered-in-error
Required Pattern: current
... title 1..1 string Descriptive name for the list
Required Pattern: Medication History
... code 1..1 CodeableConcept What the purpose of this list is
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8677-7
... encounter 1..1 Reference(Encounter - Initiated By The Facility Providing the Service) Context in which list created
... date 1..1 dateTime When the list was prepared
... source 1..1 Reference(Practitioner - General Practitioner) Who and/or what defined the list contents (aka Author)
... Slices for entry C 1..* BackboneElement Entries in the list
Slice: Unordered, Open by value:flag.coding
List-Medical-History-2: The List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
.... entry:Cotrimoxazole S 0..1 BackboneElement Entries in the list
..... flag 1..1 CodeableConcept Status/Workflow information about this item
...... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18998-5
..... item 1..1 Reference(Medication Statement - Opportunisic Infections (OI)) Actual entry
.... entry:Isoniazid S 0..1 BackboneElement Entries in the list
..... flag 1..1 CodeableConcept Status/Workflow information about this item
...... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18934-0
..... item 1..1 Reference(Medication Statement - TB Preventive Therapy (TPT)) Actual entry
.... entry:ARV S 0..* BackboneElement Entries in the list
..... flag 1..1 CodeableConcept Status/Workflow information about this item
...... coding 1..1 Coding Code defined by a terminology system
Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47248-0
..... item 1..1 Reference(Observation - HIV Treatment Prior to Enrollment | Medication Statement - ART | Observation - Current HIV Treatment Therapy Duration) Actual entry

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
List-Medical-History-2errorList.entryThe List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
: slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Cotrimoxazole').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Isoniazid').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'ARV').count() > 0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... title Σ 1..1 string Descriptive name for the list
Required Pattern: Medication History
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.


Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8677-7
... subject Σ 1..1 Reference(Patient) If all resources have the same subject
... encounter 1..1 Reference(Encounter - Initiated By The Facility Providing the Service) Context in which list created
... date Σ 1..1 dateTime When the list was prepared
... source Σ 1..1 Reference(Practitioner - General Practitioner) Who and/or what defined the list contents (aka Author)
... Slices for entry C 1..* BackboneElement Entries in the list
Slice: Unordered, Open by value:flag.coding
List-Medical-History-2: The List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Resource) Actual entry
.... entry:Cotrimoxazole SC 0..1 BackboneElement Entries in the list
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18998-5
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Medication Statement - Opportunisic Infections (OI)) Actual entry
.... entry:Isoniazid SC 0..1 BackboneElement Entries in the list
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18934-0
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Medication Statement - TB Preventive Therapy (TPT)) Actual entry
.... entry:ARV SC 0..* BackboneElement Entries in the list
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47248-0
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... item 1..1 Reference(Observation - HIV Treatment Prior to Enrollment | Medication Statement - ART | Observation - Current HIV Treatment Therapy Duration) Actual entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexamplePattern: LOINC Code 8677-7
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.entry:Cotrimoxazole.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:Isoniazid.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:ARV.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
List-Medical-History-2errorList.entryThe List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
: slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Cotrimoxazole').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Isoniazid').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'ARV').count() > 0
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


Required Pattern: current
... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ 1..1 string Descriptive name for the list
Required Pattern: Medication History
... code Σ 1..1 CodeableConcept What the purpose of this list is
Binding: ExampleUseCodesForList (example): What the purpose of a list is.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 8677-7
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(Patient) If all resources have the same subject
... encounter 1..1 Reference(Encounter - Initiated By The Facility Providing the Service) Context in which list created
... date Σ 1..1 dateTime When the list was prepared
... source Σ 1..1 Reference(Practitioner - General Practitioner) Who and/or what defined the list contents (aka Author)
... orderedBy 0..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..* Annotation Comments about the list
... Slices for entry C 1..* BackboneElement Entries in the list
Slice: Unordered, Open by value:flag.coding
List-Medical-History-2: The List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
.... entry:All Slices Content/Rules for all slices
..... 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
..... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Resource) Actual entry
.... entry:Cotrimoxazole SC 0..1 BackboneElement Entries in the list
..... 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
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18998-5
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Medication Statement - Opportunisic Infections (OI)) Actual entry
.... entry:Isoniazid SC 0..1 BackboneElement Entries in the list
..... 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
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18934-0
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Medication Statement - TB Preventive Therapy (TPT)) Actual entry
.... entry:ARV SC 0..* BackboneElement Entries in the list
..... 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
..... flag 1..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 47248-0
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... deleted ?!C 0..1 boolean If this item is actually marked as deleted
..... date 0..1 dateTime When item added to list
..... item 1..1 Reference(Observation - HIV Treatment Prior to Enrollment | Medication Statement - ART | Observation - Current HIV Treatment Therapy Duration) Actual entry
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
List.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
List.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeexamplePattern: LOINC Code 8677-7
http://hl7.org/fhir/ValueSet/list-example-codes
from the FHIR Standard
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:Cotrimoxazole.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:Isoniazid.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.entry:ARV.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
List-Medical-History-2errorList.entryThe List SHALL have at least one of entry for slice "Cotrimoxazole", "Isoniazid" or "ARV".
: slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Cotrimoxazole').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'Isoniazid').count() + slice('http://moh.gov.et/fhir/hiv/StructureDefinition/medication-history', 'ARV').count() > 0
dom-2errorListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorListIf 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-4errorListIf 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-5errorListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceListA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
lst-1errorListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
lst-2errorListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-3errorListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()

 

Other representations of profile: CSV, Excel, Schematron