Standardized Medication Profile (SMP) FHIR IG
1.0.0-publication - STU1 Ballot United States of America flag

Standardized Medication Profile (SMP) FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 1.0.0-publication built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smp-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Standardized Medication Profile - Medication List

Official URL: http://hl7.org/fhir/us/smp/StructureDefinition/smp-medication-list Version: 1.0.0-publication
Standards status: Trial-use Maturity Level: 1 Computable Name: SMPMedicationList

A related set of descriptions of individual medications a patient is or has received. May be a currently being administered list, a list of medications for discharge or a list of discontinued medications (with reasons). The list is point in time.

The mechanism to group a related set of MedicationStatement resources together

Usage:

Formal Views of Profile Content

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

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List List
... code S 1..1 CodeableConcept Medication list type code
Binding: Medication Lists . (extensible): The Value Set for the medication list types is maintained at the National Library of Medicine Value Set Authority Center (VSAC).

... subject S 1..1 Reference(US Core Patient Profile) Patient
... source S 1..1 Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) Who and/or what defined the list contents (aka Author)
.... item 1..1 Reference(Standardized Medication Profile - MedicationStatement) Medication details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.codeextensibleMedicationLists .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept Medication list type code
Binding: Medication Lists . (extensible): The Value Set for the medication list types is maintained at the National Library of Medicine Value Set Authority Center (VSAC).


ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Patient
ele-1: All FHIR elements must have a @value or children
... source SΣ 1..1 Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) Who and/or what defined the list contents (aka Author)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeextensibleMedicationLists .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... 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
... 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 Business identifier
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.

... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ 1..1 CodeableConcept Medication list type code
Binding: Medication Lists . (extensible): The Value Set for the medication list types is maintained at the National Library of Medicine Value Set Authority Center (VSAC).

... subject SΣ 1..1 Reference(US Core Patient Profile) Patient
... encounter 0..1 Reference(Encounter) Context in which list created
... date Σ 0..1 dateTime When the list was prepared
... source SΣ 1..1 Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) Who and/or what defined the list contents (aka Author)
... orderedBy 0..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..* Annotation Comments about the list
... entry C 0..* BackboneElement Entries in the list
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?!C 0..1 boolean If this item is actually marked as deleted
.... date 0..1 dateTime When item added to list
.... item 1..1 Reference(Standardized Medication Profile - MedicationStatement) Medication details
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeextensibleMedicationLists .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

Differential View

This structure is derived from List

NameFlagsCard.TypeDescription & Constraintsdoco
.. List List
... code S 1..1 CodeableConcept Medication list type code
Binding: Medication Lists . (extensible): The Value Set for the medication list types is maintained at the National Library of Medicine Value Set Authority Center (VSAC).

... subject S 1..1 Reference(US Core Patient Profile) Patient
... source S 1..1 Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) Who and/or what defined the list contents (aka Author)
.... item 1..1 Reference(Standardized Medication Profile - MedicationStatement) Medication details

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
List.codeextensibleMedicationLists .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.


ele-1: All FHIR elements must have a @value or children
... code SΣ 1..1 CodeableConcept Medication list type code
Binding: Medication Lists . (extensible): The Value Set for the medication list types is maintained at the National Library of Medicine Value Set Authority Center (VSAC).


ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(US Core Patient Profile) Patient
ele-1: All FHIR elements must have a @value or children
... source SΣ 1..1 Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) Who and/or what defined the list contents (aka Author)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeextensibleMedicationLists .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List C 0..* List A list is a curated collection of resources
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"
... 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
... 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 Business identifier
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.

... mode ?!Σ 1..1 code working | snapshot | changes
Binding: ListMode (required): The processing mode that applies to this list.

... title Σ 0..1 string Descriptive name for the list
Example General: Dr. Jane's Patients
... code SΣ 1..1 CodeableConcept Medication list type code
Binding: Medication Lists . (extensible): The Value Set for the medication list types is maintained at the National Library of Medicine Value Set Authority Center (VSAC).

... subject SΣ 1..1 Reference(US Core Patient Profile) Patient
... encounter 0..1 Reference(Encounter) Context in which list created
... date Σ 0..1 dateTime When the list was prepared
... source SΣ 1..1 Reference(US Core Practitioner Profile | US Core PractitionerRole Profile) Who and/or what defined the list contents (aka Author)
... orderedBy 0..1 CodeableConcept What order the list has
Binding: ListOrderCodes (preferred): What order applies to the items in a list.

... note 0..* Annotation Comments about the list
... entry C 0..* BackboneElement Entries in the list
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... flag 0..1 CodeableConcept Status/Workflow information about this item
Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list.

.... deleted ?!C 0..1 boolean If this item is actually marked as deleted
.... date 0..1 dateTime When item added to list
.... item 1..1 Reference(Standardized Medication Profile - MedicationStatement) Medication details
... emptyReason C 0..1 CodeableConcept Why list is empty
Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
List.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
List.statusrequiredListStatus
http://hl7.org/fhir/ValueSet/list-status|4.0.1
from the FHIR Standard
List.moderequiredListMode
http://hl7.org/fhir/ValueSet/list-mode|4.0.1
from the FHIR Standard
List.codeextensibleMedicationLists .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
List.orderedBypreferredListOrderCodes
http://hl7.org/fhir/ValueSet/list-order
from the FHIR Standard
List.entry.flagexamplePatientMedicineChangeTypes
http://hl7.org/fhir/ValueSet/list-item-flag
from the FHIR Standard
List.emptyReasonpreferredListEmptyReasons
http://hl7.org/fhir/ValueSet/list-empty-reason
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron