This page is part of the 臺灣癌症用藥事前審查實作指引(TWPAS IG) (v0.2.0: Releases) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Official URL: https://twcore.mohw.gov.tw/ig/pas/StructureDefinition/Substance-twpas | Version: 0.2.0 | |||
Active as of 2024-09-19 | Computable Name: SubstanceTWPAS |
此放射治療總劑量-Substance TWPAS Profile說明本IG如何進一步定義FHIR的Substance Resource以呈現癌藥事前審查中治療資訊之放射治療總劑量
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Substance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Substance | Substance | |||
code | 1..1 | CodeableConcept | 放射治療項目,伽傌射線、高能量X光、質子治療、碘-123、鎝-99m、碘-131、銦-111等。ICD-PCS。 Binding: 臺灣健保署2021年中文版ICD 10 PCS-放射治療項目值集 (required) | |
ingredient | S | 0..1 | BackboneElement | Composition information about the substance |
quantity | ||||
numerator | ||||
value | S | 0..1 | decimal | 放射治療總劑量 |
unit | S | 0..1 | string | 放射治療總劑量單位 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Substance.code | required | ICD10PCSRadiotherapyhttps://twcore.mohw.gov.tw/ig/pas/ValueSet/icd-10-pcs-radiotherapy from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Substance | 0..* | Substance | A homogeneous material with a definite composition | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
code | Σ | 1..1 | CodeableConcept | 放射治療項目,伽傌射線、高能量X光、質子治療、碘-123、鎝-99m、碘-131、銦-111等。ICD-PCS。 Binding: 臺灣健保署2021年中文版ICD 10 PCS-放射治療項目值集 (required) |
ingredient | SΣ | 0..1 | BackboneElement | Composition information about the substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
quantity | Σ | 0..1 | Ratio | Optional amount (concentration) |
numerator | Σ | 0..1 | Quantity | Numerator value |
value | SΣ | 0..1 | decimal | 放射治療總劑量 |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | 放射治療總劑量單位 |
substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
substanceCodeableConcept | CodeableConcept | |||
substanceReference | Reference(Substance) | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | |
Substance.code | required | ICD10PCSRadiotherapyhttps://twcore.mohw.gov.tw/ig/pas/ValueSet/icd-10-pcs-radiotherapy from this IG | |
Substance.ingredient.quantity.numerator.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Substance | 0..* | Substance | A homogeneous material with a definite composition | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 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 | |||||
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): A code to indicate if the substance is actively used. | ||||
category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | ||||
code | Σ | 1..1 | CodeableConcept | 放射治療項目,伽傌射線、高能量X光、質子治療、碘-123、鎝-99m、碘-131、銦-111等。ICD-PCS。 Binding: 臺灣健保署2021年中文版ICD 10 PCS-放射治療項目值集 (required) | ||||
description | Σ | 0..1 | string | Textual description of the substance, comments | ||||
instance | Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | SΣ | 0..1 | BackboneElement | Composition information about the substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
quantity | Σ | 0..1 | Ratio | Optional amount (concentration) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | Σ | 0..1 | Quantity | Numerator value | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 0..1 | decimal | 放射治療總劑量 | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 0..1 | string | 放射治療總劑量單位 | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
denominator | Σ | 0..1 | Quantity | Denominator value | ||||
substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
substanceCodeableConcept | CodeableConcept | |||||||
substanceReference | Reference(Substance) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Substance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | ||||
Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard | ||||
Substance.code | required | ICD10PCSRadiotherapyhttps://twcore.mohw.gov.tw/ig/pas/ValueSet/icd-10-pcs-radiotherapy from this IG | ||||
Substance.ingredient.quantity.numerator.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Substance
Differential View
This structure is derived from Substance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Substance | Substance | |||
code | 1..1 | CodeableConcept | 放射治療項目,伽傌射線、高能量X光、質子治療、碘-123、鎝-99m、碘-131、銦-111等。ICD-PCS。 Binding: 臺灣健保署2021年中文版ICD 10 PCS-放射治療項目值集 (required) | |
ingredient | S | 0..1 | BackboneElement | Composition information about the substance |
quantity | ||||
numerator | ||||
value | S | 0..1 | decimal | 放射治療總劑量 |
unit | S | 0..1 | string | 放射治療總劑量單位 |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Substance.code | required | ICD10PCSRadiotherapyhttps://twcore.mohw.gov.tw/ig/pas/ValueSet/icd-10-pcs-radiotherapy from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Substance | 0..* | Substance | A homogeneous material with a definite composition | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: FHIRSubstanceStatus (required): A code to indicate if the substance is actively used. |
code | Σ | 1..1 | CodeableConcept | 放射治療項目,伽傌射線、高能量X光、質子治療、碘-123、鎝-99m、碘-131、銦-111等。ICD-PCS。 Binding: 臺灣健保署2021年中文版ICD 10 PCS-放射治療項目值集 (required) |
ingredient | SΣ | 0..1 | BackboneElement | Composition information about the substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
quantity | Σ | 0..1 | Ratio | Optional amount (concentration) |
numerator | Σ | 0..1 | Quantity | Numerator value |
value | SΣ | 0..1 | decimal | 放射治療總劑量 |
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. |
unit | SΣ | 0..1 | string | 放射治療總劑量單位 |
substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |
substanceCodeableConcept | CodeableConcept | |||
substanceReference | Reference(Substance) | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | |
Substance.code | required | ICD10PCSRadiotherapyhttps://twcore.mohw.gov.tw/ig/pas/ValueSet/icd-10-pcs-radiotherapy from this IG | |
Substance.ingredient.quantity.numerator.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | |
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Substance | 0..* | Substance | A homogeneous material with a definite composition | |||||
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: CommonLanguages (preferred): A human language.
| |||||
text | 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 | |||||
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): A code to indicate if the substance is actively used. | ||||
category | Σ | 0..* | CodeableConcept | What class/type of substance this is Binding: SubstanceCategoryCodes (extensible): Category or classification of substance. | ||||
code | Σ | 1..1 | CodeableConcept | 放射治療項目,伽傌射線、高能量X光、質子治療、碘-123、鎝-99m、碘-131、銦-111等。ICD-PCS。 Binding: 臺灣健保署2021年中文版ICD 10 PCS-放射治療項目值集 (required) | ||||
description | Σ | 0..1 | string | Textual description of the substance, comments | ||||
instance | Σ | 0..* | BackboneElement | If this describes a specific package/container of the substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
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 | SΣ | 0..1 | BackboneElement | Composition information about the substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
quantity | Σ | 0..1 | Ratio | Optional amount (concentration) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
numerator | Σ | 0..1 | Quantity | Numerator value | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
value | SΣ | 0..1 | decimal | 放射治療總劑量 | ||||
comparator | ?!Σ | 0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | ||||
unit | SΣ | 0..1 | string | 放射治療總劑量單位 | ||||
system | ΣC | 0..1 | uri | System that defines coded unit form | ||||
code | Σ | 0..1 | code | Coded form of the unit | ||||
denominator | Σ | 0..1 | Quantity | Denominator value | ||||
substance[x] | Σ | 1..1 | A component of the substance Binding: SubstanceCode (example): Substance Ingredient codes. | |||||
substanceCodeableConcept | CodeableConcept | |||||||
substanceReference | Reference(Substance) | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Substance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Substance.status | required | FHIRSubstanceStatushttp://hl7.org/fhir/ValueSet/substance-status|4.0.1 from the FHIR Standard | ||||
Substance.category | extensible | SubstanceCategoryCodeshttp://hl7.org/fhir/ValueSet/substance-category from the FHIR Standard | ||||
Substance.code | required | ICD10PCSRadiotherapyhttps://twcore.mohw.gov.tw/ig/pas/ValueSet/icd-10-pcs-radiotherapy from this IG | ||||
Substance.ingredient.quantity.numerator.comparator | required | QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard | ||||
Substance.ingredient.substance[x] | example | SubstanceCodehttp://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Substance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Substance | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | Substance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Substance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Substance
Other representations of profile: CSV, Excel, Schematron