HIV Case-reporting for Vietnam - candidate draft
0.1.0-test - CI Build
HIV Case-reporting for Vietnam - candidate draft
0.1.0-test - CI Build
HIV Case-reporting for Vietnam - candidate draft - Local Development build (v0.1.0-test). See the Directory of published versions
| Official URL: http://openhie.org/fhir/openhie.vn.case-reporting.hiv/StructureDefinition/arv-therapy-summary | Version: 0.1.0-test | |||
| Active as of 2022-03-29 | Responsible: OpenHIE |
Realm: 
|
Computable Name: ARVTherapySummary | |
ART therapy summary.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatement
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
  id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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 | External identifier |
 basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |
| category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
  medication[x] | Σ | 1..1 | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
 medicationCodeableConcept | CodeableConcept | |||
 medicationReference | Reference(Medication) | |||
| subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
| effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
| informationSource | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |
| derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
| reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |
| note | 0..* | Annotation | Further information about the statement | |
| dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
| Documentation for this format | ||||
This structure is derived from MedicationStatement
Differential View
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | Record of medication being taken by a patient | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| 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 | External identifier |
| basedOn | Σ | 0..* | Reference(MedicationRequest | CarePlan | ServiceRequest) | Fulfils plan, proposal or order |
| partOf | Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) | Part of referenced event |
| status | ?!Σ | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken Binding: Medication Status Codes (required): A coded concept indicating the current status of a MedicationStatement. |
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: SNOMEDCTDrugTherapyStatusCodes (example): A coded concept indicating the reason for the status of the statement. | |
| category | Σ | 0..1 | CodeableConcept | Type of medication usage Binding: Medication usage category codes (preferred): A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
| medication[x] | Σ | 1..1 | What medication was taken Binding: SNOMEDCTMedicationCodes (example): A coded concept identifying the substance or product being taken. | |
| medicationCodeableConcept | CodeableConcept | |||
| medicationReference | Reference(Medication) | |||
| subject | Σ | 1..1 | Reference(Patient | Group) | Who is/was taking the medication |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter / Episode associated with MedicationStatement |
| effective[x] | Σ | 0..1 | The date/time or interval when the medication is/was/will be taken | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| dateAsserted | Σ | 0..1 | dateTime | When the statement was asserted? |
| informationSource | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Person or organization that provided the information about the taking of this medication | |
| derivedFrom | 0..* | Reference(Resource) | Additional supporting information | |
| reasonCode | 0..* | CodeableConcept | Reason for why the medication is being/was taken Binding: Condition/Problem/DiagnosisCodes (example): A coded concept identifying why the medication is being taken. | |
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Condition or observation that supports why the medication is being/was taken | |
| note | 0..* | Annotation | Further information about the statement | |
| dosage | 0..* | Dosage | Details of how medication is/was taken or should be taken | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| MedicationStatement.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MedicationStatement.status | required | Medication Status Codes |
| MedicationStatement.statusReason | example | SNOMEDCTDrugTherapyStatusCodes |
| MedicationStatement.category | preferred | Medication usage category codes |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
| MedicationStatement.reasonCode | example | Condition/Problem/DiagnosisCodes |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | MedicationStatement | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationStatement | 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 | MedicationStatement | 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 | MedicationStatement | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | MedicationStatement | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | MedicationStatement.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MedicationStatement.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MedicationStatement.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MedicationStatement.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MedicationStatement.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.medication[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.context | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.effective[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.dateAsserted | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.informationSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.derivedFrom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MedicationStatement.dosage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ OpenHIE. Package openhie.vn.case-reporting.hiv#0.1.0-test based on FHIR 4.0.1. Generated 2022-03-29
Links: Table of Contents |
QA Report |
Issues |
Version History |
|