2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: cqf-medicationstatement

The official URL for this profile is: 

http://hl7.org/fhir/Profile/cqf-medicationstatement-cqf-medicationstatement

. Profile of medication statement for decision support/quality metrics. Indicates which elements must be supported by CQF rules and measure engines. Removes modifying attributes. : Clinical Quality Framework (CQF) Medication Statement Profile

This profile was published on Tue, Oct 28, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.

Summary

Required/Prohibited Elements

  • The element MedicationStatement is required
  • The element MedicationStatement.patient is required
  • The element MedicationStatement.status is required

Fixed Values

  • The element MedicationStatement.wasNotGiven value has been fixed to false

Formal Views of Profile Content

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

Differential View

This structure is derived from MedicationStatement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 1..1Statement that a medication was given to a patient. The wasNotGiven and reasonNotGiven elements have been removed. See cqf-medicationstatement-notgiven to express the concept of nonoccurrence.
... patient S1..1Patient
... status S1..1code
... wasNotGiven 0..1booleanFixed Value: false
... reasonForUse[x] S0..1
... effective[x] S0..1
... medication S0..1Medication
... dosage S0..*
.... schedule S0..1Timing
.... asNeeded[x] S0..1boolean, CodeableConcept
.... site S0..1CodeableConcept
.... route S0..1CodeableConcept
.... method S0..1CodeableConcept
.... quantity S0..1Quantity
.... rate S0..1Ratio
.... maxDosePerPeriod S0..1Ratio

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 1..1Statement that a medication was given to a patient. The wasNotGiven and reasonNotGiven elements have been removed. See cqf-medicationstatement-notgiven to express the concept of nonoccurrence.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Identifier
... patient S1..1PatientWho was/is taking medication
... informationSource 0..1Patient, Practitioner, RelatedPersonThe person who provided the information about the taking of this medication.
... dateAsserted 0..1dateTimeWhen the statement was asserted?
... status S1..1codein-progress | completed | entered-in-error
Binding: MedicationStatementStatus (required, not extensible)
... wasNotGiven M0..1booleanTrue if medication is/was not being taken
Fixed Value: false
... reasonNotGiven I0..*CodeableConceptTrue if asserting medication was not given
Binding: MedicationAdministrationNegationReason (example, extensible)
mst-1: Reason not given is only permitted if wasNotGiven is true
... reasonForUse[x] S I0..1CodeableConcept, ConditionA reason for why the medication is being/was taken.
mst-2: Reason for use is only permitted if wasNotGiven is false
... effective[x] S0..1dateTime, PeriodOver what period was medication consumed?
... note 0..1stringFurther information about the statement
... medication S0..1MedicationWhat medication was taken?
... dosage S0..*Details of how medication was taken
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringDosage Instructions
.... schedule S0..1TimingWhen/how often was medication taken?
.... asNeeded[x] S0..1boolean, CodeableConceptTake "as needed" f(or x)
Binding: MedicationAsNeededReason (preferred, extensible)
.... site S0..1CodeableConceptWhere on body was medication administered?
Binding: MedicationAdministrationSite (example, extensible)
.... route S0..1CodeableConceptHow did the medication enter the body?
Binding: RouteOfAdministration (example, extensible)
.... method S0..1CodeableConceptTechnique used to administer medication
Binding: MedicationAdministrationMethod (example, extensible)
.... quantity S0..1QuantityAmount administered in one dose
.... rate S0..1RatioDose quantity per unit of time
.... maxDosePerPeriod S0..1RatioMaximum dose that was consumed per unit of time

XML Template

JSON Template

todo

Differential View

This structure is derived from MedicationStatement.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 1..1Statement that a medication was given to a patient. The wasNotGiven and reasonNotGiven elements have been removed. See cqf-medicationstatement-notgiven to express the concept of nonoccurrence.
... patient S1..1Patient
... status S1..1code
... wasNotGiven 0..1booleanFixed Value: false
... reasonForUse[x] S0..1
... effective[x] S0..1
... medication S0..1Medication
... dosage S0..*
.... schedule S0..1Timing
.... asNeeded[x] S0..1boolean, CodeableConcept
.... site S0..1CodeableConcept
.... route S0..1CodeableConcept
.... method S0..1CodeableConcept
.... quantity S0..1Quantity
.... rate S0..1Ratio
.... maxDosePerPeriod S0..1Ratio

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement 1..1Statement that a medication was given to a patient. The wasNotGiven and reasonNotGiven elements have been removed. See cqf-medicationstatement-notgiven to express the concept of nonoccurrence.
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Identifier
... patient S1..1PatientWho was/is taking medication
... informationSource 0..1Patient, Practitioner, RelatedPersonThe person who provided the information about the taking of this medication.
... dateAsserted 0..1dateTimeWhen the statement was asserted?
... status S1..1codein-progress | completed | entered-in-error
Binding: MedicationStatementStatus (required, not extensible)
... wasNotGiven M0..1booleanTrue if medication is/was not being taken
Fixed Value: false
... reasonNotGiven I0..*CodeableConceptTrue if asserting medication was not given
Binding: MedicationAdministrationNegationReason (example, extensible)
mst-1: Reason not given is only permitted if wasNotGiven is true
... reasonForUse[x] S I0..1CodeableConcept, ConditionA reason for why the medication is being/was taken.
mst-2: Reason for use is only permitted if wasNotGiven is false
... effective[x] S0..1dateTime, PeriodOver what period was medication consumed?
... note 0..1stringFurther information about the statement
... medication S0..1MedicationWhat medication was taken?
... dosage S0..*Details of how medication was taken
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... text 0..1stringDosage Instructions
.... schedule S0..1TimingWhen/how often was medication taken?
.... asNeeded[x] S0..1boolean, CodeableConceptTake "as needed" f(or x)
Binding: MedicationAsNeededReason (preferred, extensible)
.... site S0..1CodeableConceptWhere on body was medication administered?
Binding: MedicationAdministrationSite (example, extensible)
.... route S0..1CodeableConceptHow did the medication enter the body?
Binding: RouteOfAdministration (example, extensible)
.... method S0..1CodeableConceptTechnique used to administer medication
Binding: MedicationAdministrationMethod (example, extensible)
.... quantity S0..1QuantityAmount administered in one dose
.... rate S0..1RatioDose quantity per unit of time
.... maxDosePerPeriod S0..1RatioMaximum dose that was consumed per unit of time

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
MedicationStatement.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
MedicationStatement.statusMedicationStatementStatusrequiredMedicationStatementStatus
MedicationStatement.reasonNotGivenMedicationAdministrationNegationReasonexample (extensible)Reason Medication Not Given Codes
MedicationStatement.dosage.asNeeded[x]MedicationAsNeededReasonpreferred (extensible)
MedicationStatement.dosage.siteMedicationAdministrationSiteexample (extensible)SNOMED CT Anatomical Structure for Administration Site Codes
MedicationStatement.dosage.routeRouteOfAdministrationexample (extensible)SNOMED CT Route Codes
MedicationStatement.dosage.methodMedicationAdministrationMethodexample (extensible)SNOMED CT Introduction (procedure) for Administration Method Codes

Constraints

IdPathNameDetails
mst-1MedicationStatement.reasonNotGivenNot given reasonReason not given is only permitted if wasNotGiven is true
XPath: not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')
mst-2MedicationStatement.reasonForUse[x]Reason for useReason for use is only permitted if wasNotGiven is false
XPath: not(exists(f:reasonForUse[x]) and f:wasNotGiven/@value='true')
.