Diagnostic Data Services

DDS-Report-Substance-1

A medication is a substance that is packaged and used as an administered medication. The medication resource uses the substance resource to represent the actual ingredients of a medication. For substances in Diagnostic Data Services, it would be used for medication that the patient is / has been prescribed or for substances used for/during processing of a specimen.

NameCard.TypeDescription & Constraints
..SubstanceSubstanceA homogeneous material with a definite composition

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...identifier0..1IdentifierUnique identifier

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required
Example Value official

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..1CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system

......display1..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept
Example Value Identifier allocated by manufacturing pharmaceutical company.

....system1..1UriThe namespace for the identifier
Example Value http://www.pharm.com/Id/substance-id

....value1..1StringThe value that is unique
Example Value AEB22D1D-0DBF-426C-B86C-3F47DCA4A4E8

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start1..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (Organization)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference1..1StringRelative URL reference
Example Value Organization/0A6F71A7-161D-4A84-8573-AB55DBB19340

.....display0..1StringText alternative for the resource
Example Value Pharm Pharmaceuticals Limited

...category0..*CodeableConceptWhat class/type of substance this is
Binding Category or classification of substance (http://hl7.org/fhir/ValueSet/substance-category)
Binding Strength Extensible

....id0..1Idxml:id (or equivalent in JSON)

....coding0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....system1..1UriIdentity of the terminology system
Fixed Value http://hl7.org.fhir/substance-category

.....version0..1StringVersion of the system - if relevant

.....code1..1CodeSymbol in syntax defined by the system
Example Value drug

.....display1..1StringRepresentation defined by the system
Example Value Drug or Medicament

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...code1..1CodeableConceptWhat substance this is
Binding Substance codes (http://snomed.info/sct)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....system1..1UriIdentity of the terminology system
Fixed Value http://snomed.info/sct

.....version0..1StringVersion of the system - if relevant

.....code1..1CodeSymbol in syntax defined by the system
Example Value 392259005

.....display1..1StringRepresentation defined by the system
Example Value co-amoxiclav 875mg/125mg tablet

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...description0..1StringTextual description of the substance, comments
Example Value Augmentin 875

...instance0..1BackboneElementIf this describes a specific package/container of the substance

....id0..1Idxml:id (or equivalent in JSON)

....identifier0..1IdentifierIdentifier of the package/container

.....id0..1Idxml:id (or equivalent in JSON)

.....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known. (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required
Example Value official

.....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

......id0..1Idxml:id (or equivalent in JSON)

......coding0..1CodingCode defined by a terminology system

.......id0..1Idxml:id (or equivalent in JSON)

.......system1..1UriIdentity of the terminology system

.......version0..1StringVersion of the system - if relevant

.......code1..1CodeSymbol in syntax defined by the system

.......display1..1StringRepresentation defined by the system

.......userSelected0..1BooleanIf this coding was chosen directly by the user

......text0..1StringPlain text representation of the concept
Example Value Identifier for the package containing the tablets allocated by manufacturing pharmaceutical company.

.....system1..1UriThe namespace for the identifier
Example Value http://www.pharm.com/Id/package-id

.....value1..1StringThe value that is unique
Example Value D8BF142A-525E-4107-BB4D-67516DF492DA

.....period0..1PeriodTime period when id is/was valid for use

......id0..1Idxml:id (or equivalent in JSON)

......start1..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

.....assigner0..1Reference (Organization)Organization that issued id (may be just text)

......id0..1Idxml:id (or equivalent in JSON)

......reference1..1StringRelative, internal or absolute URL reference
Example Value Organization/0A6F71A7-161D-4A84-8573-AB55DBB19340

......display0..1StringText alternative for the resource
Example Value Pharm Pharmaceuticals Limited

....expiry0..1DateTimeWhen no longer valid to use

....quantity (SimpleQuantity)0..1SimpleQuantityAmount of substance in the package

.....id0..1Idxml:id (or equivalent in JSON)

.....value1..1DecimalNumerical value (with implicit precision)

.....unit1..1StringUnit representation

.....system1..1UriSystem that defines coded unit form

.....code0..1CodeCoded form of the unit

...ingredient0..*BackboneElementComposition information about the substance

....id0..1Idxml:id (or equivalent in JSON)

....quantity1..1RatioOptional amount (concentration)

.....id0..1Idxml:id (or equivalent in JSON)

.....numerator1..1QuantityNumerator value

......id0..1Idxml:id (or equivalent in JSON)

......value1..1DecimalNumerical value (with implicit precision)
Example Value 875

......comparator0..1Code< | <= | >= | > - how to understand the value
Binding How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator)
Binding Strength Required

......unit1..1StringUnit representation
Example Value milligram

......system1..1UriSystem that defines coded unit form
Example Value http://unitsofmeasure.org

......code1..1CodeCoded form of the unit
Example Value mg

.....denominator1..1QuantityDenominator value

......id0..1Idxml:id (or equivalent in JSON)

......value1..1DecimalNumerical value (with implicit precision)
Example Value 1000

......comparator0..1Code< | <= | >= | > - how to understand the value
Binding How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator)
Binding Strength Required

......unit1..1StringUnit representation
Example Value milligram

......system1..1UriSystem that defines coded unit form
Example Value http://unitsofmeasure.org

......code1..1CodeCoded form of the unit
Example Value mg

....substance1..1Reference (Substance)A component of the substance

.....id0..1Idxml:id (or equivalent in JSON)

.....reference1..1StringInternal URL reference
Example Value #ingr1

.....display0..1StringText alternative for the resource
Example Value Amoxicillin

Path Name Binding Strength ValueSet
.Substance.language language Required http://tools.ietf.org/html/bcp47
.Substance.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.Substance.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.Substance.category category Extensible http://hl7.org/fhir/ValueSet/substance-category
.Substance.code code Example http://snomed.info/sct
.Substance.ingredient.quantity.numerator.comparator comparator Required http://hl7.org/fhir/ValueSet/quantity-comparator

DDS-Report-Substance-1

Examples Description XML File
DDS-Report-Substance-1-Ex01 Substance example for Diagnostic Data Services