Substance - FHIR Resource (stu3)


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

Validate an Substance FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
categorytrueCodeableConcept# What class/type of substance this is
codefalseCodeableConcept# What substance this is
descriptionfalsestring# Textual description of the substance, comments
identifiertrueIdentifier# Unique identifier
ingredienttrueData Type# Composition information about the substance
instancetrueData Type# If this describes a specific package/container of the substance
statusfalsecode# active | inactive | entered-in-error

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 the like so:

https://api.1up.health/fhir/stu3/Substance?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
categorytextcategory
codetextcode, ingredient.substance.as
container-identifiertextinstance.identifier
expirydateinstance.expiry
identifiertextidentifier
quantityquantityinstance.quantity
statustextstatus
substance-referencereferenceingredient.substance.as