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-ma-notgiven

The official URL for this profile is: 

http://hl7.org/fhir/Profile/cqf-medicationadministration-notgiven-cqf-ma-notgiven

. Profile of medication administration for decision support/quality metrics, representing the case where a prescribed medication was not given to the patient. Indicates which elements must be supported by CQF rules and measure engines. : Clinical Quality Framework (CQF) Medication Administration Not Given Profile

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

Summary

Terminology Bindings

  • MedicationAdministration.status must come from A set of codes indicating the current status of a CQF MedicationAdministration

Required/Prohibited Elements

  • The element MedicationAdministration is required
  • The element MedicationAdministration.status is required
  • The element MedicationAdministration.patient is required
  • The element MedicationAdministration.practitioner is required
  • The element MedicationAdministration.prescription is required
  • The element MedicationAdministration.wasNotGiven is required
  • The element MedicationAdministration.reasonGiven is prohibited
  • The element MedicationAdministration.effectiveTime[x] is required

Fixed Values

  • The element MedicationAdministration.wasNotGiven value has been fixed to true

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 MedicationAdministration.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1Profile of MedicationAdministration for clinical quality rules and measures for medications that were NOT administered. Includes a reason the medication was not given.
... status S1..1codeon-hold | entered-in-error | stopped
Binding: CQFMedicationAdministrationStatusNotGiven (required, not extensible)
... patient S1..1Patient
... practitioner S1..1Practitioner
... encounter S0..1Encounter
... prescription S1..1MedicationPrescription
... wasNotGiven 1..1booleanFixed Value: true
... reasonNotGiven S0..*CodeableConcept
... reasonGiven 0..0CodeableConcept
... effectiveTime[x] S1..1dateTime, Period
... medication S0..1Medication
... device S0..*Device
... dosage S0..1
.... site S0..1CodeableConcept
.... route S0..1CodeableConcept
.... method S0..1CodeableConcept
.... quantity S0..1Quantity
.... rate S0..1Ratio

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1Profile of MedicationAdministration for clinical quality rules and measures for medications that were NOT administered. Includes a reason the medication was not given.
... 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
... status S1..1codeon-hold | entered-in-error | stopped
Binding: CQFMedicationAdministrationStatusNotGiven (required, not extensible)
... patient S1..1PatientWho received medication?
... practitioner S1..1PractitionerWho administered substance?
... encounter S0..1EncounterEncounter administered as part of
... prescription S1..1MedicationPrescriptionOrder administration performed against
... wasNotGiven M1..1booleanTrue if medication not administered
Fixed Value: true
... reasonNotGiven S I0..*CodeableConceptReason administration not performed
Binding: MedicationAdministrationNegationReason (example, extensible)
mad-2: Reason not given is only permitted if wasNotGiven is true
... effectiveTime[x] S1..1dateTime, PeriodStart and end time of administration
... medication S0..1MedicationWhat was administered?
... device S0..*DeviceDevice used to administer
... note 0..1stringInformation about the administration
... dosage S I0..1Details of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate
.... 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
.... site S0..1CodeableConceptBody site administered to
Binding: MedicationAdministrationSite (example, extensible)
.... route S0..1CodeableConceptPath of substance into body
Binding: RouteOfAdministration (example, extensible)
.... method S0..1CodeableConceptHow drug was administered
Binding: MedicationAdministrationMethod (example, extensible)
.... quantity S0..1QuantityAmount administered in one dose
.... rate S0..1RatioDose quantity per unit of time

XML Template

JSON Template

todo

Differential View

This structure is derived from MedicationAdministration.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1Profile of MedicationAdministration for clinical quality rules and measures for medications that were NOT administered. Includes a reason the medication was not given.
... status S1..1codeon-hold | entered-in-error | stopped
Binding: CQFMedicationAdministrationStatusNotGiven (required, not extensible)
... patient S1..1Patient
... practitioner S1..1Practitioner
... encounter S0..1Encounter
... prescription S1..1MedicationPrescription
... wasNotGiven 1..1booleanFixed Value: true
... reasonNotGiven S0..*CodeableConcept
... reasonGiven 0..0CodeableConcept
... effectiveTime[x] S1..1dateTime, Period
... medication S0..1Medication
... device S0..*Device
... dosage S0..1
.... site S0..1CodeableConcept
.... route S0..1CodeableConcept
.... method S0..1CodeableConcept
.... quantity S0..1Quantity
.... rate S0..1Ratio

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1Profile of MedicationAdministration for clinical quality rules and measures for medications that were NOT administered. Includes a reason the medication was not given.
... 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
... status S1..1codeon-hold | entered-in-error | stopped
Binding: CQFMedicationAdministrationStatusNotGiven (required, not extensible)
... patient S1..1PatientWho received medication?
... practitioner S1..1PractitionerWho administered substance?
... encounter S0..1EncounterEncounter administered as part of
... prescription S1..1MedicationPrescriptionOrder administration performed against
... wasNotGiven M1..1booleanTrue if medication not administered
Fixed Value: true
... reasonNotGiven S I0..*CodeableConceptReason administration not performed
Binding: MedicationAdministrationNegationReason (example, extensible)
mad-2: Reason not given is only permitted if wasNotGiven is true
... effectiveTime[x] S1..1dateTime, PeriodStart and end time of administration
... medication S0..1MedicationWhat was administered?
... device S0..*DeviceDevice used to administer
... note 0..1stringInformation about the administration
... dosage S I0..1Details of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate
.... 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
.... site S0..1CodeableConceptBody site administered to
Binding: MedicationAdministrationSite (example, extensible)
.... route S0..1CodeableConceptPath of substance into body
Binding: RouteOfAdministration (example, extensible)
.... method S0..1CodeableConceptHow drug was administered
Binding: MedicationAdministrationMethod (example, extensible)
.... quantity S0..1QuantityAmount administered in one dose
.... rate S0..1RatioDose quantity per unit of time

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
MedicationAdministration.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
MedicationAdministration.statusCQFMedicationAdministrationStatusNotGivenrequiredCQFMedicationAdministrationStatusNotGiven
MedicationAdministration.reasonNotGivenMedicationAdministrationNegationReasonexample (extensible)Reason Medication Not Given Codes
MedicationAdministration.reasonGivenMedicationAdministrationReasonexample (extensible)Reason Medication Given Codes
MedicationAdministration.dosage.siteMedicationAdministrationSiteexample (extensible)SNOMED CT Anatomical Structure for Administration Site Codes
MedicationAdministration.dosage.routeRouteOfAdministrationexample (extensible)SNOMED CT Route Codes
MedicationAdministration.dosage.methodMedicationAdministrationMethodexample (extensible)SNOMED CT Introduction (procedure) for Administration Method Codes

Constraints

IdPathNameDetails
mad-2MedicationAdministration.reasonNotGivenNot given reasonReason not given is only permitted if wasNotGiven is true
XPath: not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')
mad-3MedicationAdministration.reasonGivenGiven reasonReason given is only permitted if wasNotGiven is false
XPath: not(exists(f:reasonGiven) and f:wasNotGiven/@value='true')
mad-1MedicationAdministration.dosageDoseSHALL have at least one of dosage.quantity and dosage.rate
XPath: exists(f:quantity) or exists(f:rate)
.