Health Care Surveys Content Implementation Guide (IG)
1.0.1 - CI Build
Health Care Surveys Content Implementation Guide (IG)
1.0.1 - CI Build
Health Care Surveys Content Implementation Guide (IG), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.1). This version is based on the current content of https://github.com/HL7/fhir-health-care-surveys-reporting-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/health-care-surveys-reporting/StructureDefinition/hcs-medicationstatement | Version: 1.0.1 | |||
| Active as of 2023-06-01 | Computable Name: HcsMedicationStatement | |||
This is the MedicationStatement Resource profile for the IG.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationStatement | 0..* | MedicationStatement | HCS Medication Statement | |
  status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
| medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What medication was taken |
 subject | S | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication |
| context | S | 0..1 | Reference(US Core Encounter Profile) | Encounter / Episode associated with MedicationStatement |
| effective[x] | S | 1..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken |
| dateAsserted | S | 0..1 | dateTime | When the statement was asserted? |
 dosage | S | 0..1 | 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 | HCS Medication Statement | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 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. |
  medication[x] | SΣ | 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 | SΣ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication |
| context | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter / Episode associated with MedicationStatement |
| effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? |
| dosage | S | 0..1 | Dosage | Details of how medication is/was taken or should be taken |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationStatement.status | required | Medication Status Codes |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | 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 | **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 | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | HCS Medication Statement | |||||
| 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 | |||||
 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 | ?!SΣ | 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] | SΣ | 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 | SΣ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication | ||||
| context | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter / Episode associated with MedicationStatement | ||||
| effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| dateAsserted | SΣ | 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 | S | 0..1 | Dosage | Details of how medication is/was taken or should be taken | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| MedicationStatement.language | preferred | CommonLanguages
| ||||
| 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(s) | 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 | **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 MedicationStatement
Differential View
This structure is derived from MedicationStatement
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | HCS Medication Statement | |
| status | S | 1..1 | code | active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
| medication[x] | S | 1..1 | CodeableConcept, Reference(Medication) | What medication was taken |
| subject | S | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication |
| context | S | 0..1 | Reference(US Core Encounter Profile) | Encounter / Episode associated with MedicationStatement |
| effective[x] | S | 1..1 | dateTime, Period | The date/time or interval when the medication is/was/will be taken |
| dateAsserted | S | 0..1 | dateTime | When the statement was asserted? |
| dosage | S | 0..1 | Dosage | Details of how medication is/was taken or should be taken |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | HCS Medication Statement | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 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. |
| medication[x] | SΣ | 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 | SΣ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication |
| context | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter / Episode associated with MedicationStatement |
| effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |
| effectiveDateTime | dateTime | |||
| effectivePeriod | Period | |||
| dateAsserted | SΣ | 0..1 | dateTime | When the statement was asserted? |
| dosage | S | 0..1 | Dosage | Details of how medication is/was taken or should be taken |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MedicationStatement.status | required | Medication Status Codes |
| MedicationStatement.medication[x] | example | SNOMEDCTMedicationCodes |
| Id | Grade | Path(s) | 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 | **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 | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationStatement | 0..* | MedicationStatement | HCS Medication Statement | |||||
| 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 | |||||
| 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 | ?!SΣ | 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] | SΣ | 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 | SΣ | 1..1 | Reference(US Core Patient Profile) | Who is/was taking the medication | ||||
| context | SΣ | 0..1 | Reference(US Core Encounter Profile) | Encounter / Episode associated with MedicationStatement | ||||
| effective[x] | SΣ | 1..1 | The date/time or interval when the medication is/was/will be taken | |||||
| effectiveDateTime | dateTime | |||||||
| effectivePeriod | Period | |||||||
| dateAsserted | SΣ | 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 | S | 0..1 | Dosage | Details of how medication is/was taken or should be taken | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| MedicationStatement.language | preferred | CommonLanguages
| ||||
| 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(s) | 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 | **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 MedicationStatement
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International - Public Health Work Group. Package hl7.fhir.us.health-care-surveys-reporting#1.0.1 based on FHIR 4.0.1. Generated 2023-09-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change