Substance - FHIR Resource (dstu2)


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

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

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

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