Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-SubstanceDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_SubstanceDefinition_R4B | ||
This cross-version profile allows R5 SubstanceDefinition content to be represented via FHIR R4B SubstanceDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SubstanceDefinition.implicitRules, SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SubstanceDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition(4.3.0) | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: General specifications for this substance (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.characterization Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstanceReferenceInformation for use in FHIR R4B(0.1.0) | Basic) | R5: General information detailing this substance (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.referenceInformation Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstanceNucleicAcid for use in FHIR R4B(0.1.0) | Basic) | R5: Data items specific to nucleic acids (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.nucleicAcid Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstancePolymer for use in FHIR R4B(0.1.0) | Basic) | R5: Data items specific to polymers (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.polymer Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstanceProtein for use in FHIR R4B(0.1.0) | Basic) | R5: Data items specific to proteins (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.protein Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier by which this substance is known | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | R5: identifier URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | A business level version identifier of the substance | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | R5: version URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | R5: status URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies | ||||
![]() ![]() |
Σ | 0..1 | markdown | Textual description of the substance | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | R5: description URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | markdown | Primitive value for markdown | |||||
![]() ![]() |
Σ | 0..* | Reference(Citation) | Supporting literature | ||||
![]() ![]() |
Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | ||||
![]() ![]() |
Σ | 0..* | Reference(Organization) | The entity that creates, makes, produces or fabricates the substance | ||||
![]() ![]() |
Σ | 0..* | Reference(Organization) | An entity that is the source for the substance. It may be different from the manufacturer | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Moiety, for structural modifications | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Role that the moiety is playing | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Textual name for this moiety substance | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantitative value for this moiety | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | General specifications for this substance | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: product-characteristic-codes (??) (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. | ||||
![]() ![]() ![]() |
Σ | 0..1 | A value for the property | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | The molecular weight or weight range | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: WeightMethod (example): The method by which the substance weight was measured. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: WeightType (example): The type of substance weight measurement. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | Structural information | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Molecular formula (e.g. using the Hill system) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Specified per moiety according to the Hill system | ||||
![]() ![]() ![]() |
Σ | 0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The method used to find the structure e.g. X-ray, NMR Binding: StructureTechnique (example): The method used to elucidate the structure or characterization of the drug substance. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: sourceDocument additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | A depiction of the structure or characterization of the substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: SubstanceRepresentationType (example): A format of a substance representation. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The structural representation or characterization as a text string in a standard format | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: document additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Codes associated with the substance | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The specific code | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
![]() ![]() ![]() |
Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Names applicable to this substance | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | string | R5: name URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | The actual name | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If this is the preferred name for this substance | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (preferred): IETF language tag
| ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: Jurisdiction ValueSet (example): Jurisdiction codes | ||||
![]() ![]() ![]() |
Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
![]() ![]() ![]() |
Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date of official name change | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | A link between this substance and another | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | A pointer to another substance, as a resource or a representational code | |||||
![]() ![]() ![]() ![]() |
Reference(SubstanceDefinition) | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | ||||
![]() ![]() ![]() |
Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: SourceMaterialType (example): A classification that provides the origin of the substance raw material. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: SourceMaterialGenus (example): The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: SourceMaterialSpecies (example): A species of origin a substance raw material. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: Country ValueSet (required): Jurisdiction codes | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SubstanceDefinition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.domain | Base | example | MedicinalProductDomain | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.grade | Base | example | SubstanceGrade | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.moiety.stereochemistry | Base | example | Stereochemistry | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.moiety.opticalActivity | Base | example | OpticalActivity | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.moiety.measurementType | Base | example | SubstanceAmountType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.property.type | Base | example | http://hl7.org/fhir/ValueSet/product-characteristic-codes | Not State | Unknown |
| SubstanceDefinition.molecularWeight.method | Base | example | WeightMethod | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.molecularWeight.type | Base | example | WeightType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.stereochemistry | Base | example | Stereochemistry | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.opticalActivity | Base | example | OpticalActivity | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.technique | Base | example | StructureTechnique | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.sourceDocument.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.representation.type | Base | example | SubstanceRepresentationType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.representation.format | Base | example | SubstanceRepresentationFormat | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.representation.document.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.code.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.code.source.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.type | Base | example | SubstanceNameType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.domain | Base | example | SubstanceNameDomain | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.jurisdiction | Base | example | Jurisdiction | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.official.authority | Base | preferred | SubstanceNameAuthority | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.official.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.source.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.relationship.type | Base | example | SubstanceRelationshipType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.relationship.comparator | Base | example | SubstanceAmountType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.relationship.source.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.type | Base | example | SourceMaterialType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.genus | Base | example | SourceMaterialGenus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.species | Base | example | SourceMaterialSpecies | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.part | Base | example | SourceMaterialPart | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.countryOfOrigin | Base | required | Country | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | SubstanceDefinition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | SubstanceDefinition.meta, SubstanceDefinition.implicitRules, SubstanceDefinition.language, SubstanceDefinition.text, SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension, SubstanceDefinition.identifier, SubstanceDefinition.identifier.extension, SubstanceDefinition.identifier.extension:identifier, SubstanceDefinition.identifier.use, SubstanceDefinition.identifier.type, SubstanceDefinition.identifier.system, SubstanceDefinition.identifier.value, SubstanceDefinition.identifier.period, SubstanceDefinition.identifier.assigner, SubstanceDefinition.version, SubstanceDefinition.version.extension, SubstanceDefinition.version.extension:version, SubstanceDefinition.status, SubstanceDefinition.status.extension, SubstanceDefinition.status.extension:status, SubstanceDefinition.status.coding, SubstanceDefinition.status.text, SubstanceDefinition.classification, SubstanceDefinition.domain, SubstanceDefinition.grade, SubstanceDefinition.description, SubstanceDefinition.description.extension, SubstanceDefinition.description.extension:description, SubstanceDefinition.informationSource, SubstanceDefinition.note, SubstanceDefinition.manufacturer, SubstanceDefinition.supplier, SubstanceDefinition.moiety, SubstanceDefinition.moiety.extension, SubstanceDefinition.moiety.modifierExtension, SubstanceDefinition.moiety.role, SubstanceDefinition.moiety.identifier, SubstanceDefinition.moiety.name, SubstanceDefinition.moiety.stereochemistry, SubstanceDefinition.moiety.opticalActivity, SubstanceDefinition.moiety.molecularFormula, SubstanceDefinition.moiety.amount[x], SubstanceDefinition.moiety.measurementType, SubstanceDefinition.property, SubstanceDefinition.property.extension, SubstanceDefinition.property.modifierExtension, SubstanceDefinition.property.type, SubstanceDefinition.property.value[x], SubstanceDefinition.molecularWeight, SubstanceDefinition.molecularWeight.extension, SubstanceDefinition.molecularWeight.modifierExtension, SubstanceDefinition.molecularWeight.method, SubstanceDefinition.molecularWeight.type, SubstanceDefinition.molecularWeight.amount, SubstanceDefinition.structure, SubstanceDefinition.structure.extension, SubstanceDefinition.structure.modifierExtension, SubstanceDefinition.structure.stereochemistry, SubstanceDefinition.structure.opticalActivity, SubstanceDefinition.structure.molecularFormula, SubstanceDefinition.structure.molecularFormulaByMoiety, SubstanceDefinition.structure.molecularWeight, SubstanceDefinition.structure.technique, SubstanceDefinition.structure.sourceDocument, SubstanceDefinition.structure.sourceDocument.extension, SubstanceDefinition.structure.sourceDocument.extension:sourceDocument, SubstanceDefinition.structure.sourceDocument.reference, SubstanceDefinition.structure.sourceDocument.type, SubstanceDefinition.structure.sourceDocument.identifier, SubstanceDefinition.structure.sourceDocument.display, SubstanceDefinition.structure.representation, SubstanceDefinition.structure.representation.extension, SubstanceDefinition.structure.representation.modifierExtension, SubstanceDefinition.structure.representation.type, SubstanceDefinition.structure.representation.representation, SubstanceDefinition.structure.representation.format, SubstanceDefinition.structure.representation.document, SubstanceDefinition.structure.representation.document.extension, SubstanceDefinition.structure.representation.document.extension:document, SubstanceDefinition.structure.representation.document.reference, SubstanceDefinition.structure.representation.document.type, SubstanceDefinition.structure.representation.document.identifier, SubstanceDefinition.structure.representation.document.display, SubstanceDefinition.code, SubstanceDefinition.code.extension, SubstanceDefinition.code.modifierExtension, SubstanceDefinition.code.code, SubstanceDefinition.code.status, SubstanceDefinition.code.statusDate, SubstanceDefinition.code.note, SubstanceDefinition.code.source, SubstanceDefinition.code.source.extension, SubstanceDefinition.code.source.extension:source, SubstanceDefinition.code.source.reference, SubstanceDefinition.code.source.type, SubstanceDefinition.code.source.identifier, SubstanceDefinition.code.source.display, SubstanceDefinition.name, SubstanceDefinition.name.extension, SubstanceDefinition.name.extension:name, SubstanceDefinition.name.modifierExtension, SubstanceDefinition.name.name, SubstanceDefinition.name.type, SubstanceDefinition.name.status, SubstanceDefinition.name.preferred, SubstanceDefinition.name.language, SubstanceDefinition.name.domain, SubstanceDefinition.name.jurisdiction, SubstanceDefinition.name.synonym, SubstanceDefinition.name.translation, SubstanceDefinition.name.official, SubstanceDefinition.name.official.extension, SubstanceDefinition.name.official.modifierExtension, SubstanceDefinition.name.official.authority, SubstanceDefinition.name.official.status, SubstanceDefinition.name.official.date, SubstanceDefinition.name.source, SubstanceDefinition.name.source.extension, SubstanceDefinition.name.source.extension:source, SubstanceDefinition.name.source.reference, SubstanceDefinition.name.source.type, SubstanceDefinition.name.source.identifier, SubstanceDefinition.name.source.display, SubstanceDefinition.relationship, SubstanceDefinition.relationship.extension, SubstanceDefinition.relationship.modifierExtension, SubstanceDefinition.relationship.substanceDefinition[x], SubstanceDefinition.relationship.type, SubstanceDefinition.relationship.isDefining, SubstanceDefinition.relationship.amount[x], SubstanceDefinition.relationship.ratioHighLimitAmount, SubstanceDefinition.relationship.comparator, SubstanceDefinition.relationship.source, SubstanceDefinition.relationship.source.extension, SubstanceDefinition.relationship.source.extension:source, SubstanceDefinition.relationship.source.reference, SubstanceDefinition.relationship.source.type, SubstanceDefinition.relationship.source.identifier, SubstanceDefinition.relationship.source.display, SubstanceDefinition.sourceMaterial, SubstanceDefinition.sourceMaterial.extension, SubstanceDefinition.sourceMaterial.modifierExtension, SubstanceDefinition.sourceMaterial.type, SubstanceDefinition.sourceMaterial.genus, SubstanceDefinition.sourceMaterial.species, SubstanceDefinition.sourceMaterial.part, SubstanceDefinition.sourceMaterial.countryOfOrigin | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension, SubstanceDefinition.identifier.extension, SubstanceDefinition.identifier.extension:identifier, SubstanceDefinition.version.extension, SubstanceDefinition.version.extension:version, SubstanceDefinition.status.extension, SubstanceDefinition.status.extension:status, SubstanceDefinition.description.extension, SubstanceDefinition.description.extension:description, SubstanceDefinition.moiety.extension, SubstanceDefinition.moiety.modifierExtension, SubstanceDefinition.property.extension, SubstanceDefinition.property.modifierExtension, SubstanceDefinition.molecularWeight.extension, SubstanceDefinition.molecularWeight.modifierExtension, SubstanceDefinition.structure.extension, SubstanceDefinition.structure.modifierExtension, SubstanceDefinition.structure.sourceDocument.extension, SubstanceDefinition.structure.sourceDocument.extension:sourceDocument, SubstanceDefinition.structure.representation.extension, SubstanceDefinition.structure.representation.modifierExtension, SubstanceDefinition.structure.representation.document.extension, SubstanceDefinition.structure.representation.document.extension:document, SubstanceDefinition.code.extension, SubstanceDefinition.code.modifierExtension, SubstanceDefinition.code.source.extension, SubstanceDefinition.code.source.extension:source, SubstanceDefinition.name.extension, SubstanceDefinition.name.extension:name, SubstanceDefinition.name.modifierExtension, SubstanceDefinition.name.official.extension, SubstanceDefinition.name.official.modifierExtension, SubstanceDefinition.name.source.extension, SubstanceDefinition.name.source.extension:source, SubstanceDefinition.relationship.extension, SubstanceDefinition.relationship.modifierExtension, SubstanceDefinition.relationship.source.extension, SubstanceDefinition.relationship.source.extension:source, SubstanceDefinition.sourceMaterial.extension, SubstanceDefinition.sourceMaterial.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SubstanceDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SubstanceDefinition.implicitRules, SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from SubstanceDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition(4.3.0) | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | R5: General specifications for this substance (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.characterization Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstanceReferenceInformation for use in FHIR R4B(0.1.0) | Basic) | R5: General information detailing this substance (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.referenceInformation Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstanceNucleicAcid for use in FHIR R4B(0.1.0) | Basic) | R5: Data items specific to nucleic acids (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.nucleicAcid Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstancePolymer for use in FHIR R4B(0.1.0) | Basic) | R5: Data items specific to polymers (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.polymer Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | Reference(Cross-version Profile for R5.SubstanceProtein for use in FHIR R4B(0.1.0) | Basic) | R5: Data items specific to proteins (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SubstanceDefinition.protein Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier by which this substance is known | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | R5: identifier URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | string | A business level version identifier of the substance | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | R5: version URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | R5: status URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies | ||||
![]() ![]() |
Σ | 0..1 | markdown | Textual description of the substance | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | R5: description URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | markdown | Primitive value for markdown | |||||
![]() ![]() |
Σ | 0..* | Reference(Citation) | Supporting literature | ||||
![]() ![]() |
Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | ||||
![]() ![]() |
Σ | 0..* | Reference(Organization) | The entity that creates, makes, produces or fabricates the substance | ||||
![]() ![]() |
Σ | 0..* | Reference(Organization) | An entity that is the source for the substance. It may be different from the manufacturer | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Moiety, for structural modifications | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Role that the moiety is playing | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Textual name for this moiety substance | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Quantitative value for this moiety | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | General specifications for this substance | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: product-characteristic-codes (??) (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. | ||||
![]() ![]() ![]() |
Σ | 0..1 | A value for the property | |||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() |
Σ | 0..* | BackboneElement | The molecular weight or weight range | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: WeightMethod (example): The method by which the substance weight was measured. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: WeightType (example): The type of substance weight measurement. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | Structural information | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Molecular formula (e.g. using the Hill system) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Specified per moiety according to the Hill system | ||||
![]() ![]() ![]() |
Σ | 0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The method used to find the structure e.g. X-ray, NMR Binding: StructureTechnique (example): The method used to elucidate the structure or characterization of the drug substance. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: sourceDocument additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | A depiction of the structure or characterization of the substance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: SubstanceRepresentationType (example): A format of a substance representation. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The structural representation or characterization as a text string in a standard format | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: document additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Codes associated with the substance | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The specific code | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
![]() ![]() ![]() |
Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Names applicable to this substance | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | string | R5: name URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | The actual name | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | If this is the preferred name for this substance | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (preferred): IETF language tag
| ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: Jurisdiction ValueSet (example): Jurisdiction codes | ||||
![]() ![]() ![]() |
Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
![]() ![]() ![]() |
Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date of official name change | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | A link between this substance and another | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | A pointer to another substance, as a resource or a representational code | |||||
![]() ![]() ![]() ![]() |
Reference(SubstanceDefinition) | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | ||||
![]() ![]() ![]() |
Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | |||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | R5: source additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: SourceMaterialType (example): A classification that provides the origin of the substance raw material. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: SourceMaterialGenus (example): The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: SourceMaterialSpecies (example): A species of origin a substance raw material. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: Country ValueSet (required): Jurisdiction codes | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SubstanceDefinition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.domain | Base | example | MedicinalProductDomain | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.grade | Base | example | SubstanceGrade | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.moiety.stereochemistry | Base | example | Stereochemistry | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.moiety.opticalActivity | Base | example | OpticalActivity | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.moiety.measurementType | Base | example | SubstanceAmountType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.property.type | Base | example | http://hl7.org/fhir/ValueSet/product-characteristic-codes | Not State | Unknown |
| SubstanceDefinition.molecularWeight.method | Base | example | WeightMethod | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.molecularWeight.type | Base | example | WeightType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.stereochemistry | Base | example | Stereochemistry | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.opticalActivity | Base | example | OpticalActivity | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.technique | Base | example | StructureTechnique | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.sourceDocument.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.representation.type | Base | example | SubstanceRepresentationType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.representation.format | Base | example | SubstanceRepresentationFormat | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.structure.representation.document.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.code.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.code.source.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.type | Base | example | SubstanceNameType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.domain | Base | example | SubstanceNameDomain | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.jurisdiction | Base | example | Jurisdiction | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.official.authority | Base | preferred | SubstanceNameAuthority | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.official.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.name.source.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.relationship.type | Base | example | SubstanceRelationshipType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.relationship.comparator | Base | example | SubstanceAmountType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.relationship.source.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.type | Base | example | SourceMaterialType | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.genus | Base | example | SourceMaterialGenus | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.species | Base | example | SourceMaterialSpecies | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.part | Base | example | SourceMaterialPart | 📍4.3.0 | FHIR Std. |
| SubstanceDefinition.sourceMaterial.countryOfOrigin | Base | required | Country | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | SubstanceDefinition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | SubstanceDefinition.meta, SubstanceDefinition.implicitRules, SubstanceDefinition.language, SubstanceDefinition.text, SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension, SubstanceDefinition.identifier, SubstanceDefinition.identifier.extension, SubstanceDefinition.identifier.extension:identifier, SubstanceDefinition.identifier.use, SubstanceDefinition.identifier.type, SubstanceDefinition.identifier.system, SubstanceDefinition.identifier.value, SubstanceDefinition.identifier.period, SubstanceDefinition.identifier.assigner, SubstanceDefinition.version, SubstanceDefinition.version.extension, SubstanceDefinition.version.extension:version, SubstanceDefinition.status, SubstanceDefinition.status.extension, SubstanceDefinition.status.extension:status, SubstanceDefinition.status.coding, SubstanceDefinition.status.text, SubstanceDefinition.classification, SubstanceDefinition.domain, SubstanceDefinition.grade, SubstanceDefinition.description, SubstanceDefinition.description.extension, SubstanceDefinition.description.extension:description, SubstanceDefinition.informationSource, SubstanceDefinition.note, SubstanceDefinition.manufacturer, SubstanceDefinition.supplier, SubstanceDefinition.moiety, SubstanceDefinition.moiety.extension, SubstanceDefinition.moiety.modifierExtension, SubstanceDefinition.moiety.role, SubstanceDefinition.moiety.identifier, SubstanceDefinition.moiety.name, SubstanceDefinition.moiety.stereochemistry, SubstanceDefinition.moiety.opticalActivity, SubstanceDefinition.moiety.molecularFormula, SubstanceDefinition.moiety.amount[x], SubstanceDefinition.moiety.measurementType, SubstanceDefinition.property, SubstanceDefinition.property.extension, SubstanceDefinition.property.modifierExtension, SubstanceDefinition.property.type, SubstanceDefinition.property.value[x], SubstanceDefinition.molecularWeight, SubstanceDefinition.molecularWeight.extension, SubstanceDefinition.molecularWeight.modifierExtension, SubstanceDefinition.molecularWeight.method, SubstanceDefinition.molecularWeight.type, SubstanceDefinition.molecularWeight.amount, SubstanceDefinition.structure, SubstanceDefinition.structure.extension, SubstanceDefinition.structure.modifierExtension, SubstanceDefinition.structure.stereochemistry, SubstanceDefinition.structure.opticalActivity, SubstanceDefinition.structure.molecularFormula, SubstanceDefinition.structure.molecularFormulaByMoiety, SubstanceDefinition.structure.molecularWeight, SubstanceDefinition.structure.technique, SubstanceDefinition.structure.sourceDocument, SubstanceDefinition.structure.sourceDocument.extension, SubstanceDefinition.structure.sourceDocument.extension:sourceDocument, SubstanceDefinition.structure.sourceDocument.reference, SubstanceDefinition.structure.sourceDocument.type, SubstanceDefinition.structure.sourceDocument.identifier, SubstanceDefinition.structure.sourceDocument.display, SubstanceDefinition.structure.representation, SubstanceDefinition.structure.representation.extension, SubstanceDefinition.structure.representation.modifierExtension, SubstanceDefinition.structure.representation.type, SubstanceDefinition.structure.representation.representation, SubstanceDefinition.structure.representation.format, SubstanceDefinition.structure.representation.document, SubstanceDefinition.structure.representation.document.extension, SubstanceDefinition.structure.representation.document.extension:document, SubstanceDefinition.structure.representation.document.reference, SubstanceDefinition.structure.representation.document.type, SubstanceDefinition.structure.representation.document.identifier, SubstanceDefinition.structure.representation.document.display, SubstanceDefinition.code, SubstanceDefinition.code.extension, SubstanceDefinition.code.modifierExtension, SubstanceDefinition.code.code, SubstanceDefinition.code.status, SubstanceDefinition.code.statusDate, SubstanceDefinition.code.note, SubstanceDefinition.code.source, SubstanceDefinition.code.source.extension, SubstanceDefinition.code.source.extension:source, SubstanceDefinition.code.source.reference, SubstanceDefinition.code.source.type, SubstanceDefinition.code.source.identifier, SubstanceDefinition.code.source.display, SubstanceDefinition.name, SubstanceDefinition.name.extension, SubstanceDefinition.name.extension:name, SubstanceDefinition.name.modifierExtension, SubstanceDefinition.name.name, SubstanceDefinition.name.type, SubstanceDefinition.name.status, SubstanceDefinition.name.preferred, SubstanceDefinition.name.language, SubstanceDefinition.name.domain, SubstanceDefinition.name.jurisdiction, SubstanceDefinition.name.synonym, SubstanceDefinition.name.translation, SubstanceDefinition.name.official, SubstanceDefinition.name.official.extension, SubstanceDefinition.name.official.modifierExtension, SubstanceDefinition.name.official.authority, SubstanceDefinition.name.official.status, SubstanceDefinition.name.official.date, SubstanceDefinition.name.source, SubstanceDefinition.name.source.extension, SubstanceDefinition.name.source.extension:source, SubstanceDefinition.name.source.reference, SubstanceDefinition.name.source.type, SubstanceDefinition.name.source.identifier, SubstanceDefinition.name.source.display, SubstanceDefinition.relationship, SubstanceDefinition.relationship.extension, SubstanceDefinition.relationship.modifierExtension, SubstanceDefinition.relationship.substanceDefinition[x], SubstanceDefinition.relationship.type, SubstanceDefinition.relationship.isDefining, SubstanceDefinition.relationship.amount[x], SubstanceDefinition.relationship.ratioHighLimitAmount, SubstanceDefinition.relationship.comparator, SubstanceDefinition.relationship.source, SubstanceDefinition.relationship.source.extension, SubstanceDefinition.relationship.source.extension:source, SubstanceDefinition.relationship.source.reference, SubstanceDefinition.relationship.source.type, SubstanceDefinition.relationship.source.identifier, SubstanceDefinition.relationship.source.display, SubstanceDefinition.sourceMaterial, SubstanceDefinition.sourceMaterial.extension, SubstanceDefinition.sourceMaterial.modifierExtension, SubstanceDefinition.sourceMaterial.type, SubstanceDefinition.sourceMaterial.genus, SubstanceDefinition.sourceMaterial.species, SubstanceDefinition.sourceMaterial.part, SubstanceDefinition.sourceMaterial.countryOfOrigin | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SubstanceDefinition.extension, SubstanceDefinition.extension:characterization, SubstanceDefinition.extension:referenceInformation, SubstanceDefinition.extension:nucleicAcid, SubstanceDefinition.extension:polymer, SubstanceDefinition.extension:protein, SubstanceDefinition.modifierExtension, SubstanceDefinition.identifier.extension, SubstanceDefinition.identifier.extension:identifier, SubstanceDefinition.version.extension, SubstanceDefinition.version.extension:version, SubstanceDefinition.status.extension, SubstanceDefinition.status.extension:status, SubstanceDefinition.description.extension, SubstanceDefinition.description.extension:description, SubstanceDefinition.moiety.extension, SubstanceDefinition.moiety.modifierExtension, SubstanceDefinition.property.extension, SubstanceDefinition.property.modifierExtension, SubstanceDefinition.molecularWeight.extension, SubstanceDefinition.molecularWeight.modifierExtension, SubstanceDefinition.structure.extension, SubstanceDefinition.structure.modifierExtension, SubstanceDefinition.structure.sourceDocument.extension, SubstanceDefinition.structure.sourceDocument.extension:sourceDocument, SubstanceDefinition.structure.representation.extension, SubstanceDefinition.structure.representation.modifierExtension, SubstanceDefinition.structure.representation.document.extension, SubstanceDefinition.structure.representation.document.extension:document, SubstanceDefinition.code.extension, SubstanceDefinition.code.modifierExtension, SubstanceDefinition.code.source.extension, SubstanceDefinition.code.source.extension:source, SubstanceDefinition.name.extension, SubstanceDefinition.name.extension:name, SubstanceDefinition.name.modifierExtension, SubstanceDefinition.name.official.extension, SubstanceDefinition.name.official.modifierExtension, SubstanceDefinition.name.source.extension, SubstanceDefinition.name.source.extension:source, SubstanceDefinition.relationship.extension, SubstanceDefinition.relationship.modifierExtension, SubstanceDefinition.relationship.source.extension, SubstanceDefinition.relationship.source.extension:source, SubstanceDefinition.sourceMaterial.extension, SubstanceDefinition.sourceMaterial.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SubstanceDefinition
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron