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

This page is part of the US Standardized Medication Profile (SMP) (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, 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-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: SMPMedicationList

The primary mechanism to group a related set of MedicationStatements together for a point in time list (Current administration, Discharge List, Discontinued list).

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: VSAC 2.16.840.1.113762.1.4.1096.240 . (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.codeextensiblehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
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"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.

... code SΣ 1..1 CodeableConcept Medication list type code
Binding: VSAC 2.16.840.1.113762.1.4.1096.240 . (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)

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.codeextensiblehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
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: VSAC 2.16.840.1.113762.1.4.1096.240 . (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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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.codeextensiblehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
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: VSAC 2.16.840.1.113762.1.4.1096.240 . (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.codeextensiblehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
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
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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code current | retired | entered-in-error
Binding: ListStatus (required): The current state of the list.

... code SΣ 1..1 CodeableConcept Medication list type code
Binding: VSAC 2.16.840.1.113762.1.4.1096.240 . (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)

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.codeextensiblehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
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: VSAC 2.16.840.1.113762.1.4.1096.240 . (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
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
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.codeextensiblehttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240
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