Substance

A homogeneous material with a definite composition.

Columns

Header row
# path type required description
0 resourceType string * Resource type identifier. Must be string "Substance"
1 integer * Number of subrows
2 id string * Logical id of this artifact
3 status code active | inactive | entered-in-error
code CodeableConcept What substance this is
code.coding Coding Code defined by a terminology system
4 code.coding.system uri Identity of the terminology system
5 code.coding.version string Version of the system - if relevant
6 code.coding.code code Symbol in syntax defined by the system
7 code.coding.display string Representation defined by the system
8 code.coding.userSelected boolean If this coding was chosen directly by the user
9 code.text string Plain text representation of the concept
10 description string Textual description of the substance, comments
Row identifier
# path type required description
0 string * Subrow identifier. Must be string "identifier"
identifier Identifier Unique identifier
1 identifier.use code usual | official | temp | secondary | old (If known)
identifier.type CodeableConcept Description of identifier
identifier.type.coding Coding Code defined by a terminology system
2 identifier.type.coding.system uri Identity of the terminology system
3 identifier.type.coding.version string Version of the system - if relevant
4 identifier.type.coding.code code Symbol in syntax defined by the system
5 identifier.type.coding.display string Representation defined by the system
6 identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
7 identifier.type.text string Plain text representation of the concept
8 identifier.system uri The namespace for the identifier value
9 identifier.value string The value that is unique
identifier.period Period Time period when id is/was valid for use
10 identifier.period.start dateTime Starting time with inclusive boundary
11 identifier.period.end dateTime End time with inclusive boundary, if not ongoing
Row category
# path type required description
0 string * Subrow identifier. Must be string "category"
category CodeableConcept What class/type of substance this is
category.coding Coding Code defined by a terminology system
1 category.coding.system uri Identity of the terminology system
2 category.coding.version string Version of the system - if relevant
3 category.coding.code code Symbol in syntax defined by the system
4 category.coding.display string Representation defined by the system
5 category.coding.userSelected boolean If this coding was chosen directly by the user
6 category.text string Plain text representation of the concept
Row instance
# path type required description
0 string * Subrow identifier. Must be string "instance"
instance If this describes a specific package/container of the substance
instance.identifier Identifier Identifier of the package/container
1 instance.identifier.use code usual | official | temp | secondary | old (If known)
instance.identifier.type CodeableConcept Description of identifier
instance.identifier.type.coding Coding Code defined by a terminology system
2 instance.identifier.type.coding.system uri Identity of the terminology system
3 instance.identifier.type.coding.version string Version of the system - if relevant
4 instance.identifier.type.coding.code code Symbol in syntax defined by the system
5 instance.identifier.type.coding.display string Representation defined by the system
6 instance.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
7 instance.identifier.type.text string Plain text representation of the concept
8 instance.identifier.system uri The namespace for the identifier value
9 instance.identifier.value string The value that is unique
instance.identifier.period Period Time period when id is/was valid for use
10 instance.identifier.period.start dateTime Starting time with inclusive boundary
11 instance.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
12 instance.expiry dateTime When no longer valid to use
instance.quantity Quantity Amount of substance in the package
13 instance.quantity.value decimal Numerical value (with implicit precision)
14 instance.quantity.unit string Unit representation
15 instance.quantity.system uri System that defines coded unit form
16 instance.quantity.code code Coded form of the unit
Row ingredient
# path type required description
0 string * Subrow identifier. Must be string "ingredient"
ingredient Composition information about the substance
ingredient.quantity Ratio Optional amount (concentration)
ingredient.quantity.numerator Quantity Numerator value
1 ingredient.quantity.numerator.value decimal Numerical value (with implicit precision)
2 ingredient.quantity.numerator.comparator code < | <= | >= | > - how to understand the value
3 ingredient.quantity.numerator.unit string Unit representation
4 ingredient.quantity.numerator.system uri System that defines coded unit form
5 ingredient.quantity.numerator.code code Coded form of the unit
ingredient.quantity.denominator Quantity Denominator value
6 ingredient.quantity.denominator.value decimal Numerical value (with implicit precision)
7 ingredient.quantity.denominator.comparator code < | <= | >= | > - how to understand the value
8 ingredient.quantity.denominator.unit string Unit representation
9 ingredient.quantity.denominator.system uri System that defines coded unit form
10 ingredient.quantity.denominator.code code Coded form of the unit
ingredient.substance[x] A component of the substance
ingredient.substanceCodeableConcept CodeableConcept
ingredient.substanceCodeableConcept.coding Coding Code defined by a terminology system
11 ingredient.substanceCodeableConcept.coding.system uri Identity of the terminology system
12 ingredient.substanceCodeableConcept.coding.version string Version of the system - if relevant
13 ingredient.substanceCodeableConcept.coding.code code Symbol in syntax defined by the system
14 ingredient.substanceCodeableConcept.coding.display string Representation defined by the system
15 ingredient.substanceCodeableConcept.coding.userSelected boolean If this coding was chosen directly by the user
16 ingredient.substanceCodeableConcept.text string Plain text representation of the concept
ingredient.substanceReference Reference
17 ingredient.substanceReference.reference string Literal reference, Relative, internal or absolute URL
18 ingredient.substanceReference.type uri Type the reference refers to (e.g. "Patient")
ingredient.substanceReference.identifier Identifier Logical reference, when literal reference is not known
19 ingredient.substanceReference.identifier.use code usual | official | temp | secondary | old (If known)
ingredient.substanceReference.identifier.type CodeableConcept Description of identifier
ingredient.substanceReference.identifier.type.coding Coding Code defined by a terminology system
20 ingredient.substanceReference.identifier.type.coding.system uri Identity of the terminology system
21 ingredient.substanceReference.identifier.type.coding.version string Version of the system - if relevant
22 ingredient.substanceReference.identifier.type.coding.code code Symbol in syntax defined by the system
23 ingredient.substanceReference.identifier.type.coding.display string Representation defined by the system
24 ingredient.substanceReference.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
25 ingredient.substanceReference.identifier.type.text string Plain text representation of the concept
26 ingredient.substanceReference.identifier.system uri The namespace for the identifier value
27 ingredient.substanceReference.identifier.value string The value that is unique
ingredient.substanceReference.identifier.period Period Time period when id is/was valid for use
28 ingredient.substanceReference.identifier.period.start dateTime Starting time with inclusive boundary
29 ingredient.substanceReference.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
30 ingredient.substanceReference.display string Text alternative for the resource

Examples

Example #1
Input CSV
Substance,3,"f205",,"http://snomed.info/sct",,"392259005","Amoxicillin + clavulanate potassium 875mg/125mg tablet (product)",,,"Augmentin 875"
category,"http://terminology.hl7.org/CodeSystem/substance-category",,"drug","Drug or Medicament",,
ingredient,875,,"mg","http://unitsofmeasure.org","mg",1000,,"mg","http://unitsofmeasure.org","mg",,,,,,,"#ingr1",,,,,,,,,,,,,
ingredient,125,,"mg","http://unitsofmeasure.org","mg",1000,,"mg","http://unitsofmeasure.org","mg",,,,,,,"#ingr2",,,,,,,,,,,,,
Resulting resource
{
  "resourceType": "Substance",
  "id": "f205",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/substance-category",
          "code": "drug",
          "display": "Drug or Medicament"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "392259005",
        "display": "Amoxicillin + clavulanate potassium 875mg/125mg tablet (product)"
      }
    ]
  },
  "description": "Augmentin 875",
  "ingredient": [
    {
      "quantity": {
        "numerator": {
          "value": 875,
          "unit": "mg",
          "system": "http://unitsofmeasure.org",
          "code": "mg"
        },
        "denominator": {
          "value": 1000,
          "unit": "mg",
          "system": "http://unitsofmeasure.org",
          "code": "mg"
        }
      },
      "substanceReference": {
        "reference": "#ingr1"
      }
    },
    {
      "quantity": {
        "numerator": {
          "value": 125,
          "unit": "mg",
          "system": "http://unitsofmeasure.org",
          "code": "mg"
        },
        "denominator": {
          "value": 1000,
          "unit": "mg",
          "system": "http://unitsofmeasure.org",
          "code": "mg"
        }
      },
      "substanceReference": {
        "reference": "#ingr2"
      }
    }
  ]
}
Example #2
Input CSV
Substance,0,"f201",,"http://snomed.info/sct",,"406466009","House dust allergen",,,
Resulting resource
{
  "resourceType": "Substance",
  "id": "f201",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "406466009",
        "display": "House dust allergen"
      }
    ]
  }
}
Example #3
Input CSV
Substance,0,"f202",,"http://snomed.info/sct",,"3092008","Staphylococcus Aureus",,,
Resulting resource
{
  "resourceType": "Substance",
  "id": "f202",
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "3092008",
        "display": "Staphylococcus Aureus"
      }
    ]
  }
}
Example #4
Input CSV
Substance,2,"f203",,"http://snomed.info/sct",,"88480006","Potassium",,,
identifier,,,,,,,,"http://acme.org/identifiers/substances","1234",,
category,"http://terminology.hl7.org/CodeSystem/substance-category",,"chemical","Chemical",,
Resulting resource
{
  "resourceType": "Substance",
  "id": "f203",
  "identifier": [
    {
      "system": "http://acme.org/identifiers/substances",
      "value": "1234"
    }
  ],
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/substance-category",
          "code": "chemical",
          "display": "Chemical"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "88480006",
        "display": "Potassium"
      }
    ]
  }
}
Example #5
Input CSV
Substance,2,"example","active",,,,,,"apitoxin (Honey Bee Venom)",
identifier,,,,,,,,"http://acme.org/identifiers/substances","1463",,
category,"http://terminology.hl7.org/CodeSystem/substance-category",,"allergen","Allergen",,
Resulting resource
{
  "resourceType": "Substance",
  "id": "example",
  "identifier": [
    {
      "system": "http://acme.org/identifiers/substances",
      "value": "1463"
    }
  ],
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/substance-category",
          "code": "allergen",
          "display": "Allergen"
        }
      ]
    }
  ],
  "code": {
    "text": "apitoxin (Honey Bee Venom)"
  }
}