Substance - FHIR Resource (dstu2)

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

Validate an Substance FHIR Resource (dstu2)

Substance Attributes

AttributeField is listTypeDescription

Description: What class/type of substance this is

FHIR Version: dstu2

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"category":

Learn more about the (Substance) category FHIR attribute

Description: What substance this is

FHIR Version: dstu2

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code":

Learn more about the (Substance) code FHIR attribute

Description: Textual description of the substance, comments

FHIR Version: dstu2

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: dstu2

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: dstu2

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (Substance) identifier FHIR attribute

Description: Composition information about the substance

FHIR Version: dstu2

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 Structure


  
{
  "resourceType" : "Substance",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Unique identifier
  "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" : { Reference(Substance) } // R!  A component of the 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/dstu2/Substance?query-param=queryvalue

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