Substance - FHIR Resource (stu3)

This Substance Resource uses the FHIR API standard for access and structure.

Validate an Substance FHIR Resource (stu3)

Substance Attributes

AttributeField is listTypeDescription

Description: active | inactive | entered-in-error

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "active"

Learn more about the (Substance) status FHIR attribute

Description: What class/type of substance this is

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"category": [
  {
    "coding": [
      {
        "code": "allergen",
        "system": "http://hl7.org.fhir/substance-category",
        "display": "Allergen"
      }
    ]
  }
]

Learn more about the (Substance) category FHIR attribute

Description: What substance this is

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code": {
  "text": "apitoxin (Honey Bee Venom)"
}

Learn more about the (Substance) code FHIR attribute

Description: Textual description of the substance, comments

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (Substance) description FHIR attribute

Description: If this describes a specific package/container of the substance

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"instance":

Learn more about the (Substance) instance FHIR attribute

Description: Unique identifier

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://acme.org/identifiers/substances",
    "value": "1463"
  }
]

Learn more about the (Substance) identifier FHIR attribute

Description: Composition information about the substance

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"ingredient":

Learn more about the (Substance) ingredient FHIR attribute

Substance Example

{
  "status": "active",
  "category": [
    {
      "coding": [
        {
          "code": "allergen",
          "system": "http://hl7.org.fhir/substance-category",
          "display": "Allergen"
        }
      ]
    }
  ],
  "code": {
    "text": "apitoxin (Honey Bee Venom)"
  },
  "resourceType": "Substance",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 1463</p><p><b>status</b>: active</p><p><b>category</b>: Allergen <span>(Details : {http://hl7.org.fhir/substance-category code 'allergen' = 'allergen', given as 'Allergen'})</span></p><p><b>code</b>: apitoxin (Honey Bee Venom) <span>(Details )</span></p></div>"
  },
  "identifier": [
    {
      "system": "http://acme.org/identifiers/substances",
      "value": "1463"
    }
  ],
  "id": "example"
}

Substance Structure


  
{
  "resourceType" : "Substance",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "status" : "<code>", // active | inactive | entered-in-error
  "category" : [{ CodeableConcept }], // What class/type of substance this is
  "code" : { CodeableConcept }, // R!  What substance this is
  "description" : "<string>", // Textual description of the substance, comments
  "instance" : [{ // If this describes a specific package/container of the substance
    "identifier" : { Identifier }, // Identifier of the package/container
    "expiry" : "<dateTime>", // When no longer valid to use
    "quantity" : { Quantity(SimpleQuantity) } // Amount of substance in the package
  }],
  "ingredient" : [{ // Composition information about the substance
    "quantity" : { Ratio }, // Optional amount (concentration)
    // substance[x]: A component of the substance. One of these 2:
    "substanceCodeableConcept" : { CodeableConcept }
    "substanceReference" : { Reference(Substance) }
  }]
}

Substance Search Parameters

The following search parameters can be used to query Substance resources. Just submit them like so:

https://api.1up.health/fhir/stu3/Substance?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`category`	`text`	`category`
`code`	`text`	`code, ingredient.substance.as`
`container-identifier`	`text`	`instance.identifier`
`expiry`	`date`	`instance.expiry`
`identifier`	`text`	`identifier`
`quantity`	`quantity`	`instance.quantity`
`status`	`text`	`status`
`substance-reference`	`reference`	`ingredient.substance.as`