International Patient Summary Implementation Guide (Release 0.3.0 STU1 Ballot)

This page is part of the International Patient Summary Implementation Guide (v0.3.0: STU 1 (FHIR R4) Ballot 1) based on FHIR R4. 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.12 StructureDefinition-Medication-uv-ips

SD.12.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 Tue Feb 20 16:03:08 EST 2018 as a draft by HL7 International.

This profile builds on Medication

Summary

Mandatory: 2 elements
Must-Support: 10 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 pattern:$this

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication S0..*
... id S0..1id
... meta S0..1Meta
... code S1..1CodeableConceptIPSMedication that was administered or was to be administered. Several kinds of product coding could be provided as: the IDMP Pharmaceutical Product Identifiers (PhPID), the IDMP Medicinal Product Identifier (MPID), the IDMP Packaged Medicinal Product Identifier (PCID), when they will be available; the WHO ATC code; or any other kind of code that identifies, classifies or clusters the administered product (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jurisdiction code systems, or any other classification).
Binding: Medications (example) (example)
.... coding S(Slice Definition)Slice: Unordered, Open by pattern:$this
..... atcClass S0..1CodingIPSWHO ATC classification
Binding: WHO ATC (required)
... form S0..1CodeableConceptIPSBinding: Medicine Doseform (preferred)
... amount S0..1RatioUvIps
... ingredient S0..*BackboneElement
.... itemCodeableConcept S1..1CodeableConceptIPSBinding: Medicine Active Substances (preferred)
..... text S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication SI0..*Definition of a Medication
... id SΣ0..1idLogical id of this artifact
... meta SΣ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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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
... identifier Σ0..*IdentifierBusiness identifier for this medication
... code SI1..1CodeableConceptIPSMedication that was administered or was to be administered. Several kinds of product coding could be provided as: the IDMP Pharmaceutical Product Identifiers (PhPID), the IDMP Medicinal Product Identifier (MPID), the IDMP Packaged Medicinal Product Identifier (PCID), when they will be available; the WHO ATC code; or any other kind of code that identifies, classifies or clusters the administered product (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jurisdiction code systems, or any other classification).
Binding: Medications (example) (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SI(Slice Definition)A reference to a code defined by a terminology system
Slice: Unordered, Open by pattern:$this
..... atcClass SI0..1CodingIPSWHO ATC classification
Binding: WHO ATC (required)
.... text Σ0..1stringPlain text representation of the concept
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: Medication Status Codes (required)
... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... form SI0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Doseform (preferred)
... amount SI0..1RatioUvIpsA ratio of two Quantity values - a numerator and a denominator
... ingredient SI0..*BackboneElementActive or inactive ingredient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] (Slice Definition)The actual ingredient or content
Slice: Unordered, Closed by type:$this
..... itemCodeableConcept SI1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Active Substances (preferred)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SI0..*CodingIPSA reference to a code defined by a terminology system
...... text SΣ0..1stringPlain text representation of the concept
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... batch I0..1BackboneElementDetails about packaged medications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... lotNumber 0..1stringIdentifier assigned to batch
.... expirationDate 0..1dateTimeWhen batch will expire

doco Documentation for this format

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