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: DAFMedicationStatement

The official URL for this profile is: 

http://hl7.org/fhir/Profile/medicationstatement-daf-dafmedicationstatement

. Defines constraints and extensions on the MedicationStatement resource for use in querying and retrieving patient's medication information. : U.S. Data Access Framework (DAF) MedicationStatement Profile

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

Summary

Required/Prohibited Elements

  • The element MedicationStatement is required
  • The element MedicationStatement.patient is required
  • The element MedicationStatement.wasNotGiven is prohibited
  • The element MedicationStatement.reasonNotGiven is prohibited
  • The element MedicationStatement.medication is required

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 is/was actively taken by a patient.
... identifier 0..*Identifier
... patient S1..1patient-daf-dafpatient
... wasNotGiven 0..0boolean
... reasonNotGiven 0..0CodeableConcept
... effectivePeriod S0..1Period
... medication S1..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 is/was actively taken by a patient.
... 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..1patient-daf-dafpatientWho 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 1..1codein-progress | completed | entered-in-error
Binding: MedicationStatementStatus (required, not extensible)
... reasonForUse[x] I0..1CodeableConcept, ConditionA reason for why the medication is being/was taken.
mst-2: Reason for use is only permitted if wasNotGiven is false
... effectivePeriod S0..1PeriodOver what period was medication consumed?
... note 0..1stringFurther information about the statement
... medication S1..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 is/was actively taken by a patient.
... identifier 0..*Identifier
... patient S1..1patient-daf-dafpatient
... wasNotGiven 0..0boolean
... reasonNotGiven 0..0CodeableConcept
... effectivePeriod S0..1Period
... medication S1..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 is/was actively taken by a patient.
... 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..1patient-daf-dafpatientWho 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 1..1codein-progress | completed | entered-in-error
Binding: MedicationStatementStatus (required, not extensible)
... reasonForUse[x] I0..1CodeableConcept, ConditionA reason for why the medication is being/was taken.
mst-2: Reason for use is only permitted if wasNotGiven is false
... effectivePeriod S0..1PeriodOver what period was medication consumed?
... note 0..1stringFurther information about the statement
... medication S1..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')
.