International Patient Summary Implementation Guide Implementation Guide: STU2 Ballot

This page is part of the International Patient Summary Implementation Guide (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. 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 R4. 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 07:03:08 AEST 2018 as a draft by HL7 International.

This profile builds on Medication

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Medication.code.coding is sliced based on the value of value:binding.valueSet (Open at End)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..*
... code S0..1CodeableConcept-uv-ipsCodes that identify this medication, sliced to support IDMP
.... coding coding-uv-ipsSlice: Unordered, Open At End by value:binding.valueSet
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 1
Binding: PhPID Active Substance Stratum Level 1 (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Pharmaceutical Product [Substance(s)]
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 2
Binding: PhPID Active Substance Stratum Level 2 (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Pharmaceutical Product [Substance(s) + Strength + reference strength]
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 3
Binding: PhPID Active Substance Stratum Level 3 (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Pharmaceutical Product [Substance(s) + administrable dose form]
.... coding 0..*coding-uv-ipsPharmaceutical Product Identifier, Level 4
Binding: PhPID Active Substance Stratum Level 4 (example)
..... system 0..1uri
..... code 0..1code
..... display S0..1stringName of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]
.... coding S0..*coding-uv-ipsMedicinal Product Identifier
Binding: Medicinal Product (example)
..... system 0..1uri
..... code 0..1code
..... display 0..1stringName of the Medicinal Product
.... coding S0..*coding-uv-ipsPackaged Medicinal Product Identifier
Binding: Packaged Medicinal Product (example)
..... system 0..1uri
..... code 0..1code
..... display S0..1stringName of the Packaged Medicinal Product
.... coding 0..1coding-uv-ipsWHO ATC classification
Binding: WHO ATC (required)
..... system 1..1uriFixed Value: http://www.whocc.no/atc
..... code 1..1code
.... text S0..1string
... status 0..0
... manufacturer 0..0
... form S0..1CodeableConcept-uv-ipsBinding: Medicine Doseform (example)
... ingredient S0..*BackboneElement
.... itemCodeableConcept 1..1CodeableConcept-uv-ipsBinding: Medicine Active Substances (preferred)
..... coding S0..*coding-uv-ips
...... system 0..1uriBinding: Medicine Active Substances (preferred)
..... text S0..1string
.... isActive 0..0
.... amount S0..1Ratio-uv-ips

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication I0..*Definition of a Medication
... 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 (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SI0..1CodeableConcept-uv-ipsCodes that identify this medication, sliced to support IDMP
Binding: SNOMEDCTMedicationCodes (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σcoding-uv-ipsCode defined by a terminology system
Slice: Unordered, Open At End by value:binding.valueSet
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 1
Binding: PhPID Active Substance Stratum Level 1 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Pharmaceutical Product [Substance(s)]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 2
Binding: PhPID Active Substance Stratum Level 2 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Pharmaceutical Product [Substance(s) + Strength + reference strength]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 3
Binding: PhPID Active Substance Stratum Level 3 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Pharmaceutical Product [Substance(s) + administrable dose form]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..*coding-uv-ipsPharmaceutical Product Identifier, Level 4
Binding: PhPID Active Substance Stratum Level 4 (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringName of the Pharmaceutical Product [Substance(s) + strength + reference strength + administrable dose form]
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding SI0..*coding-uv-ipsMedicinal Product Identifier
Binding: Medicinal Product (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringName of the Medicinal Product
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding SI0..*coding-uv-ipsPackaged Medicinal Product Identifier
Binding: Packaged Medicinal Product (example)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringName of the Packaged Medicinal Product
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... coding I0..1coding-uv-ipsWHO ATC classification
Binding: WHO ATC (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.whocc.no/atc
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... text SΣ0..1stringPlain text representation of the concept
... form SI0..1CodeableConcept-uv-ipspowder | tablets | capsule +
Binding: Medicine Doseform (example)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*coding-uv-ipsCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ0..1uriIdentity of the terminology system
Binding: Medicine Doseform (required)
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
...... value 0..1Primitive value for string
Max Length: 1048576
.... text Σ0..1stringPlain text representation of the concept
... amount Σ0..1SimpleQuantityAmount of drug in package
... ingredient SI0..*BackboneElementActive or inactive ingredient
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... itemCodeableConcept I1..1CodeableConcept-uv-ipsConcept - reference to a terminology or just text
Binding: Medicine Active Substances (preferred)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ0..*coding-uv-ipsCode defined by a terminology system
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Binding: Medicine Active Substances (preferred)
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
....... id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
....... translation I0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
....... value 0..1Primitive value for string
Max Length: 1048576
..... text SΣ0..1stringPlain text representation of the concept
.... amount S0..1Ratio-uv-ipsQuantity of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire
.... serialNumber 0..1stringIdentifier assigned to a drug at the time of manufacture

doco Documentation for this format

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