HL7 FHIR Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment 2)
This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.2.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-Substance
Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.
This profile builds on Substance.
This profile was published on Fri Aug 17 00:00:00 AEST 2018 as a draft by The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC).
View the corresponding SubstanceModel logical model.
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.entity.Substance maps to Substance: Type maps to code Ingredient maps to ingredient Ingredient.IngredientAmount maps to ingredient.quantity Ingredient.CodeableConcept maps to ingredient.substance[x] Ingredient.Substance maps to ingredient.substance[x]
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Substance | BC Substance Profile | |||
  shr-core-Category-extension | 0..* | CodeableConcept | BC Category Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-extension | |
  valueCodeableConcept | Binding: Substance Category Codes (extensible) | |||
| cimi-entity-ActiveFlagAsaCodeableConcept-extension | 0..1 | CodeableConcept | BC ActiveFlagAsaCodeableConcept Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension | |
| valueCodeableConcept | Binding: FHIRSubstanceStatus (required) | |||
| shr-core-Details-extension | 0..1 | string | BC Details Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Details-extension | |
| code | Binding: Substance Code (preferred) | |||
 ingredient | ||||
  quantity | RatioProfile | |||
 substance[x] | CodeableConcept, Reference(BC Substance Profile) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | I | 0..* | BC Substance Profile | |
 id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| shr-core-Category-extension | 0..* | CodeableConcept | BC Category Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-extension | |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-extension" | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Substance Category Codes (extensible) | |
| cimi-entity-ActiveFlagAsaCodeableConcept-extension | 0..1 | CodeableConcept | BC ActiveFlagAsaCodeableConcept Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension" | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: FHIRSubstanceStatus (required) | |
| shr-core-Details-extension | 0..1 | string | BC Details Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Details-extension | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique identifier |
| status | Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required) |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (extensible) |
| code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substance Code (preferred) |
| description | Σ | 0..1 | string | Textual description of the substance, comments |
| instance | ΣI | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier of the package/container |
| expiry | Σ | 0..1 | dateTime | When no longer valid to use |
| quantity | Σ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ΣI | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| quantity | Σ | 0..1 | RatioProfile | Optional amount (concentration) |
| substance[x] | Σ | 1..1 | CodeableConcept, Reference(BC Substance Profile) | A component of the substance Binding: Substance Code (example) |
| Documentation for this format | ||||
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
BC Mapping Source
This structure represents the following BC mapping definition:
cimi.entity.Substance maps to Substance: Type maps to code Ingredient maps to ingredient Ingredient.IngredientAmount maps to ingredient.quantity Ingredient.CodeableConcept maps to ingredient.substance[x] Ingredient.Substance maps to ingredient.substance[x]
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | BC Substance Profile | |||
| shr-core-Category-extension | 0..* | CodeableConcept | BC Category Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-extension | |
| valueCodeableConcept | Binding: Substance Category Codes (extensible) | |||
| cimi-entity-ActiveFlagAsaCodeableConcept-extension | 0..1 | CodeableConcept | BC ActiveFlagAsaCodeableConcept Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension | |
| valueCodeableConcept | Binding: FHIRSubstanceStatus (required) | |||
| shr-core-Details-extension | 0..1 | string | BC Details Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Details-extension | |
| code | Binding: Substance Code (preferred) | |||
| ingredient | ||||
| quantity | RatioProfile | |||
| substance[x] | CodeableConcept, Reference(BC Substance Profile) | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Substance | I | 0..* | BC Substance Profile | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| shr-core-Category-extension | 0..* | CodeableConcept | BC Category Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-extension | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Category-extension" | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: Substance Category Codes (extensible) | |
| cimi-entity-ActiveFlagAsaCodeableConcept-extension | 0..1 | CodeableConcept | BC ActiveFlagAsaCodeableConcept Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| url | 1..1 | uri | "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-entity-ActiveFlagAsaCodeableConcept-extension" | |
| valueCodeableConcept | 1..1 | CodeableConcept | Value of extension Binding: FHIRSubstanceStatus (required) | |
| shr-core-Details-extension | 0..1 | string | BC Details Extension URL: http://hl7.org/fhir/us/breastcancer/StructureDefinition/shr-core-Details-extension | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | Unique identifier |
| status | Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required) |
| category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: Substance Category Codes (extensible) |
| code | Σ | 1..1 | CodeableConcept | What substance this is Binding: Substance Code (preferred) |
| description | Σ | 0..1 | string | Textual description of the substance, comments |
| instance | ΣI | 0..* | BackboneElement | If this describes a specific package/container of the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Identifier of the package/container |
| expiry | Σ | 0..1 | dateTime | When no longer valid to use |
| quantity | Σ | 0..1 | SimpleQuantity | Amount of substance in the package |
| ingredient | ΣI | 0..* | BackboneElement | Composition information about the substance |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| quantity | Σ | 0..1 | RatioProfile | Optional amount (concentration) |
| substance[x] | Σ | 1..1 | CodeableConcept, Reference(BC Substance Profile) | A component of the substance Binding: Substance Code (example) |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Name | Conformance | ValueSet |
| Substance.language | Common Languages | extensible | Common Languages |
| Substance.extension.valueCodeableConcept | FHIRSubstanceStatus | required | FHIRSubstanceStatus |
| Substance.extension.valueCodeableConcept | FHIRSubstanceStatus | required | FHIRSubstanceStatus |
| Substance.status | FHIRSubstanceStatus | required | FHIRSubstanceStatus |
| Substance.category | Substance Category Codes | extensible | Substance Category Codes |
| Substance.code | Substance Code | preferred | Substance Code |
| Substance.ingredient.substance[x] | Substance Code | example | Substance Code |
| Id | Path | Details | Requirements |
| dom-2 | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Substance | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Substance | 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-3 | Substance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Substance.instance | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Substance.ingredient | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |