Standardized Medication Profile (SMP) FHIR IG
1.0.0 - STU 1

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

- Use this Resource Profile: Standardized Medication Profile - Bundle Medication List Maintenance and Standardized Medication Profile - Bundle Medication List
- Examples for this Resource Profile: List/smp-medlist-1
- CapabilityStatements using this Resource Profile: SMP_Client and SMP_Server

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
List.status | required | ListStatus `http://hl7.org/fhir/ValueSet/list-status|4.0.1` from the FHIR Standard
List.mode | required | ListMode `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` from the FHIR Standard
List.code | extensible | MedicationLists `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240` from https://vsac.nlm.nih.gov

This structure is derived from List

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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)
entry |  |  |  |
item |  | 1..1 | Reference(Standardized Medication Profile - MedicationStatement) | Medication details
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
List.code | extensible | MedicationLists `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240` from https://vsac.nlm.nih.gov

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
List.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
List.status | required | ListStatus `http://hl7.org/fhir/ValueSet/list-status|4.0.1` from the FHIR Standard
List.mode | required | ListMode `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` from the FHIR Standard
List.code | extensible | MedicationLists `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240` from https://vsac.nlm.nih.gov
List.orderedBy | preferred | ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
List.entry.flag | example | PatientMedicineChangeTypes `http://hl7.org/fhir/ValueSet/list-item-flag` from the FHIR Standard
List.emptyReason | preferred | ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard

This structure is derived from List

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

- US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)
- US Core PractitionerRole Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole)
- Standardized Medication Profile - MedicationStatement (http://hl7.org/fhir/us/smp/StructureDefinition/smp-medicationstatement)

Maturity: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this 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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
List.status | required | ListStatus `http://hl7.org/fhir/ValueSet/list-status|4.0.1` from the FHIR Standard
List.mode | required | ListMode `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` from the FHIR Standard
List.code | extensible | MedicationLists `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240` from https://vsac.nlm.nih.gov

Differential View

This structure is derived from List

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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)
entry |  |  |  |
item |  | 1..1 | Reference(Standardized Medication Profile - MedicationStatement) | Medication details
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
List.code | extensible | MedicationLists `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240` from https://vsac.nlm.nih.gov

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
List.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
List.status | required | ListStatus `http://hl7.org/fhir/ValueSet/list-status|4.0.1` from the FHIR Standard
List.mode | required | ListMode `http://hl7.org/fhir/ValueSet/list-mode|4.0.1` from the FHIR Standard
List.code | extensible | MedicationLists `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1096.240` from https://vsac.nlm.nih.gov
List.orderedBy | preferred | ListOrderCodes `http://hl7.org/fhir/ValueSet/list-order` from the FHIR Standard
List.entry.flag | example | PatientMedicineChangeTypes `http://hl7.org/fhir/ValueSet/list-item-flag` from the FHIR Standard
List.emptyReason | preferred | ListEmptyReasons `http://hl7.org/fhir/ValueSet/list-empty-reason` from the FHIR Standard

This structure is derived from List

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

- US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
- US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)
- US Core PractitionerRole Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole)
- Standardized Medication Profile - MedicationStatement (http://hl7.org/fhir/us/smp/StructureDefinition/smp-medicationstatement)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron