Standard Health Record FHIR Implementation Guide

SHR MedicationUsed Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-MedicationUsed

A record of the use of a medication.

This profile builds on US Core MedicationStatement Profile.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationStatement.medication[x] is sliced based on the value of type:$this

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.medication.MedicationUsed maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationstatement:
  Informant maps to informationSource
  _Entry.CreationTime maps to dateAsserted
  MedicationOrCode maps to medication[x]
  Category maps to category
  fix taken to #y
  constrain reasonNotTaken to 0..0
  constrain dosage to 0..1
  Dosage maps to dosage
  PerformedContext.Reason maps to reasonCode
  PerformedContext.OccurrenceTimeOrPeriod maps to effective[x]
  PerformedContext.Status maps to status

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement SHR MedicationUsed Profile
... medication[x] CodeableConcept, Reference(SHR Medication Profile)Slice: Unordered, Open by type:$this
... medicationCodeableConcept CodeableConceptBinding: Medication Clinical Drug (RxNorm) (extensible)
... informationSource Reference(SHR Patient Profile), Reference(SHR RelatedPerson Profile), Reference(SHR Organization Profile)
... taken Fixed Value: y
... reasonNotTaken 0..0
... dosage 0..1SHR Dosage Profile
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*SHR MedicationUsed Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn Σ0..*Reference(MedicationRequest), Reference(CarePlan), Reference(ProcedureRequest), Reference(ReferralRequest)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration), Reference(MedicationDispense), Reference(MedicationStatement), Reference(Procedure), Reference(Observation)Part of referenced event
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Encounter / Episode associated with MedicationStatement
... status ?!SΣ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold
Binding: MedicationStatementStatus (required)
... category Σ0..1CodeableConceptType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] SΣCodeableConcept, Reference(SHR Medication Profile)What medication was taken
Slice: Unordered, Open by type:$this
Binding: Medication Clinical Drug (RxNorm) (extensible)
... medicationCodeableConcept Σ1..1CodeableConceptWhat medication was taken
Binding: Medication Clinical Drug (RxNorm) (extensible)
... effective[x] SΣ0..1dateTime, PeriodThe date/time or interval when the medication was taken
... dateAsserted SΣ1..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(SHR Patient Profile), Reference(SHR RelatedPerson Profile), Reference(SHR Organization Profile)Person or organization that provided the information about the taking of this medication
... subject SΣ1..1Reference(US Core Patient Profile)Who is/was taking the medication
... derivedFrom S0..*Reference(Resource)Additional supporting information
... taken ?!SΣ1..1codey | n | unk | na
Binding: MedicationStatementTaken (required)
Fixed Value: y
... reasonCode 0..*CodeableConceptReason for why the medication is being/was taken
Binding: Condition/Problem/Diagnosis Codes (example)
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or observation that supports why the medication is being/was taken
... note 0..*AnnotationFurther information about the statement
... dosage 0..1SHR Dosage ProfileDetails of how medication is/was taken or should be taken

doco Documentation for this format

Summary

Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationStatement.medication[x] is sliced based on the value of type:$this

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.medication.MedicationUsed maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationstatement:
  Informant maps to informationSource
  _Entry.CreationTime maps to dateAsserted
  MedicationOrCode maps to medication[x]
  Category maps to category
  fix taken to #y
  constrain reasonNotTaken to 0..0
  constrain dosage to 0..1
  Dosage maps to dosage
  PerformedContext.Reason maps to reasonCode
  PerformedContext.OccurrenceTimeOrPeriod maps to effective[x]
  PerformedContext.Status maps to status

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement SHR MedicationUsed Profile
... medication[x] CodeableConcept, Reference(SHR Medication Profile)Slice: Unordered, Open by type:$this
... medicationCodeableConcept CodeableConceptBinding: Medication Clinical Drug (RxNorm) (extensible)
... informationSource Reference(SHR Patient Profile), Reference(SHR RelatedPerson Profile), Reference(SHR Organization Profile)
... taken Fixed Value: y
... reasonNotTaken 0..0
... dosage 0..1SHR Dosage Profile
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationStatement I0..*SHR MedicationUsed Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifier
... basedOn Σ0..*Reference(MedicationRequest), Reference(CarePlan), Reference(ProcedureRequest), Reference(ReferralRequest)Fulfils plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration), Reference(MedicationDispense), Reference(MedicationStatement), Reference(Procedure), Reference(Observation)Part of referenced event
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Encounter / Episode associated with MedicationStatement
... status ?!SΣ1..1codeactive | completed | entered-in-error | intended | stopped | on-hold
Binding: MedicationStatementStatus (required)
... category Σ0..1CodeableConceptType of medication usage
Binding: MedicationStatementCategory (preferred)
... medication[x] SΣCodeableConcept, Reference(SHR Medication Profile)What medication was taken
Slice: Unordered, Open by type:$this
Binding: Medication Clinical Drug (RxNorm) (extensible)
... medicationCodeableConcept Σ1..1CodeableConceptWhat medication was taken
Binding: Medication Clinical Drug (RxNorm) (extensible)
... effective[x] SΣ0..1dateTime, PeriodThe date/time or interval when the medication was taken
... dateAsserted SΣ1..1dateTimeWhen the statement was asserted?
... informationSource 0..1Reference(SHR Patient Profile), Reference(SHR RelatedPerson Profile), Reference(SHR Organization Profile)Person or organization that provided the information about the taking of this medication
... subject SΣ1..1Reference(US Core Patient Profile)Who is/was taking the medication
... derivedFrom S0..*Reference(Resource)Additional supporting information
... taken ?!SΣ1..1codey | n | unk | na
Binding: MedicationStatementTaken (required)
Fixed Value: y
... reasonCode 0..*CodeableConceptReason for why the medication is being/was taken
Binding: Condition/Problem/Diagnosis Codes (example)
... reasonReference 0..*Reference(Condition), Reference(Observation)Condition or observation that supports why the medication is being/was taken
... note 0..*AnnotationFurther information about the statement
... dosage 0..1SHR Dosage ProfileDetails of how medication is/was taken or should be taken

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
MedicationStatement.languageCommon LanguagesextensibleCommon Languages
MedicationStatement.statusMedicationStatementStatusrequiredMedicationStatementStatus
MedicationStatement.categoryMedicationStatementCategorypreferredMedicationStatementCategory
MedicationStatement.medication[x]Medication Clinical Drug (RxNorm)extensibleMedication Clinical Drug (RxNorm)
MedicationStatement.medicationCodeableConceptMedication Clinical Drug (RxNorm)extensibleMedication Clinical Drug (RxNorm)
MedicationStatement.takenMedicationStatementTakenrequiredMedicationStatementTaken
MedicationStatement.reasonCodeCondition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes

 

Constraints

IdPathDetailsRequirements
dom-2MedicationStatementIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1MedicationStatementIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4MedicationStatementIf 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-3MedicationStatementIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
mst-1MedicationStatementReason not taken is only permitted if Taken is No
: reasonNotTaken.exists().not() or (taken = 'n')