This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Biomedical Research and Regulation ![]() | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is a representation of the json schema for Substance, which is just a part of the full JSON Schema.
{ "$schema": "http://json-schema.org/draft-06/schema#", "id": "http://hl7.org/fhir/json-schema/Substance", "$ref": "#/definitions/Substance", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "Substance": { "description": "A homogeneous material with a definite composition.", "properties": { "resourceType": { "description": "This is a Substance resource", "const": "Substance" }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "$ref": "id.schema.json#/definitions/id" }, "meta": { "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "$ref": "Meta.schema.json#/definitions/Meta" }, "implicitRules": { "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "$ref": "#/definitions/uri" }, "_implicitRules": { "description": "Extensions for implicitRules", "$ref": "Element.schema.json#/definitions/Element" }, "language": { "description": "The base language in which the resource is written.", "$ref": "#/definitions/code" }, "_language": { "description": "Extensions for language", "$ref": "Element.schema.json#/definitions/Element" }, "text": { "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "$ref": "Narrative.schema.json#/definitions/Narrative" }, "contained": { "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "items": { "$ref": "ResourceList.schema.json#/definitions/ResourceList" }, "type": "array" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "identifier": { "description": "Unique identifier for the substance, often an identifier associated with the package/container of the substance instance (usually a label affixed directly).", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "status": { "description": "A code to indicate if the substance is actively used.", "$ref": "#/definitions/code" }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "category": { "description": "A code that classifies the general type of substance. This is used for searching, sorting and display purposes.", "items": { "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "type": "array" }, "code": { "description": "A code (or set of codes) that identify this substance.", "$ref": "CodeableReference.schema.json#/definitions/CodeableReference" }, "description": { "description": "A description of the substance - its appearance, handling requirements, and other usage notes.", "$ref": "#/definitions/markdown" }, "_description": { "description": "Extensions for description", "$ref": "Element.schema.json#/definitions/Element" }, "expiry": { "description": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.", "$ref": "#/definitions/dateTime" }, "_expiry": { "description": "Extensions for expiry", "$ref": "Element.schema.json#/definitions/Element" }, "quantity": { "description": "The amount of the substance.", "$ref": "Quantity.schema.json#/definitions/Quantity" } }, "type": "object", "additionalProperties": false, "required": [ "code", "resourceType" ] } } }