This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
SD.13 StructureDefinition-medication-uv-ips
This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR STU3. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile.
Conformance resource variables defined here
SD.13.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/medication-uv-ips
Published on Wed Feb 21 08:03:08 AEDT 2018 as a draft by HL7 International.
This profile builds on Medication
Summary
Mandatory: 0 element (14 nested mandatory elements)
Must-Support: 7 elements
Fixed Value: 7 elements
Prohibited: 6 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/ratio-uv-ips
Slices
This structure defines the following Slices:
- The element Medication.code.coding is sliced based on the value of value:system
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Medication | ||||
  code | S | ..1 | CodeableConcept-uv-ips | Codes that identify this medication, sliced to support IDMP |
  coding | Slice: Unordered, Open by value:system | |||
| coding | ..1 | Pharmaceutical Product Identifier, Level 1 | ||
 system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l1 | ||
 code | 1.. | |||
| coding | ..1 | Pharmaceutical Product Identifier, Level 2 | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l2 | ||
| code | 1.. | |||
| coding | ..1 | Pharmaceutical Product Identifier, Level 3 | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l3 | ||
| code | 1.. | |||
| coding | ..1 | Pharmaceutical Product Identifier, Level 4 | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l4 | ||
| code | 1.. | |||
| coding | ..1 | Medicinal Product Identifier | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/mpid | ||
| code | 1.. | |||
| coding | ..1 | Packaged Medicinal Product Identifier | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/pcid | ||
| code | 1.. | |||
| coding | ..1 | Product classification or cluster Binding: WHOATC (extensible) | ||
| system | 1.. | Fixed Value: http://www.whocc.no/atc | ||
| code | 1.. | |||
 text | S | |||
| status | ..0 | |||
| isBrand | ..0 | |||
| isOverTheCounter | ..0 | |||
| manufacturer | ..0 | |||
| form | S | CodeableConcept-uv-ips | Binding: IPSDoseForm (example) | |
| ingredient | S | |||
| itemCodeableConcept | CodeableConcept-uv-ips | Binding: IPSActiveSubstances (preferred) | ||
| coding | S | |||
 system | Binding: IPSActiveSubstances (preferred) | |||
| text | S | |||
| isActive | ..0 | |||
| amount | S | Ratio-uv-ips | ||
| package | ..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Medication | I | 0..* | Definition of a Medication dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
 id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
| meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
 contained | 0..* | Resource | Contained, inline Resources | |
| code | SΣI | 0..1 | CodeableConcept-uv-ips | Codes that identify this medication, sliced to support IDMP Binding: SNOMED CT Medication Codes (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | coding-uv-ips | A reference to a code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children | |
| coding | ΣI | 0..1 | coding-uv-ips | Pharmaceutical Product Identifier, Level 1 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l1 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | Pharmaceutical Product Identifier, Level 2 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l2 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | Pharmaceutical Product Identifier, Level 3 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l3 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | Pharmaceutical Product Identifier, Level 4 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l4 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | Medicinal Product Identifier ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/mpid |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | Packaged Medicinal Product Identifier ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/pcid |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | Product classification or cluster Binding: WHOATC (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.whocc.no/atc |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| text | SΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| form | SI | 0..* | CodeableConcept-uv-ips | Concept - reference to a terminology or just text Binding: IPSDoseForm (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system Binding: IPSDoseForm (required) ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| ingredient | SI | 0..* | BackboneElement | Active or inactive ingredient ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 modifierExtension | ?!ΣI | 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 |
| itemCodeableConcept | I | 0..* | CodeableConcept-uv-ips | Concept - reference to a terminology or just text Binding: IPSActiveSubstances (preferred) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | SΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | Identity of the terminology system Binding: IPSActiveSubstances (preferred) ele-1: All FHIR elements must have a @value or children |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| text | SΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| amount | SI | 0..* | Ratio-uv-ips | A ratio of two Quantity values - a numerator and a denominator ele-1: All FHIR elements must have a @value or children rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present |
| image | I | 0..* | Attachment | Picture of the medication ele-1: All FHIR elements must have a @value or children att-1: It the Attachment has data, it SHALL have a contentType |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
