CH EPL (R5)
0.1.0 - ci-build
CH EPL (R5), published by Federal Office of Public Health FOPH. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/bag-epl/bag-epl-fhir/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-epl/StructureDefinition/ch-idmp-clinicalusedefinition-indication | Version: 0.1.0 | |||
Active as of 2024-11-06 | Computable Name: CHIDMPClinicalUseDefinitionIndication | |||
Copyright/Legal: CC0-1.0 |
Profile of the ClinicalUseDefinition resource for representing an indication.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ClinicalUseDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalUseDefinition | 0..* | ClinicalUseDefinition | CH IDMP ClincalUseDefinition Indication | |
type | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Required Pattern: indication | |
subject | 0..* | Reference(IDMP MedicinalProductDefinition) | The medication, product, substance, device, procedure etc. for which this is an indication | |
indication | 1..1 | BackboneElement | Specifics for when this is an indication | |
diseaseSymptomProcedure | ||||
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SMC | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | |
code | 1..1 | code | Symbol in syntax defined by the system | |
coding:FOPH | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
comorbidity | ||||
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SMC | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | |
code | 1..1 | code | Symbol in syntax defined by the system | |
coding:FOPH | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
intendedEffect | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: EMA - Intended Effect (required) | |
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SMC | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://spor.ema.europa.eu/v1/lists/200000003186 | |
code | 1..1 | code | Symbol in syntax defined by the system | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ClinicalUseDefinition.indication.intendedEffect | required | EMAIntendedEffectVS (a valid code from EMA - Intended Effect)http://fhir.ch/ig/ch-epl/ValueSet/ema-intended-effect from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalUseDefinition | C | 0..* | ClinicalUseDefinition | CH IDMP ClincalUseDefinition Indication cud-1: Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition. Required Pattern: indication |
subject | Σ | 0..* | Reference(IDMP MedicinalProductDefinition) | The medication, product, substance, device, procedure etc. for which this is an indication |
indication | ΣC | 1..1 | BackboneElement | Specifics for when this is an indication |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
intendedEffect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: EMA - Intended Effect (required) |
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://spor.ema.europa.eu/v1/lists/200000003186 |
code | ΣC | 1..1 | code | Symbol in syntax defined by the system |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClinicalUseDefinition.type | required | Pattern: indicationhttp://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard | |
ClinicalUseDefinition.indication.intendedEffect | required | EMAIntendedEffectVS (a valid code from EMA - Intended Effect)http://fhir.ch/ig/ch-epl/ValueSet/ema-intended-effect from this IG |
Id | Grade | Path(s) | Details | Requirements |
cud-1 | error | ClinicalUseDefinition | Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance : (ClinicalUseDefinition.indication.count() + ClinicalUseDefinition.contraindication.count() + ClinicalUseDefinition.interaction.count() + ClinicalUseDefinition.undesirableEffect.count() + ClinicalUseDefinition.warning.count()) < 2 | |
dom-2 | error | ClinicalUseDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ClinicalUseDefinition | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ClinicalUseDefinition | 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 | ClinicalUseDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ClinicalUseDefinition | 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 | ||||
---|---|---|---|---|---|---|---|---|
ClinicalUseDefinition | C | 0..* | ClinicalUseDefinition | CH IDMP ClincalUseDefinition Indication cud-1: Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance | ||||
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: AllLanguages (required): IETF language tag for 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 | Business identifier for this issue | ||||
type | Σ | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition. Required Pattern: indication | ||||
category | Σ | 0..* | CodeableConcept | A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" Binding: ClinicalUseDefinitionCategory (preferred): A categorisation for a clinical use information item. | ||||
subject | Σ | 0..* | Reference(IDMP MedicinalProductDefinition) | The medication, product, substance, device, procedure etc. for which this is an indication | ||||
status | Σ | 0..1 | CodeableConcept | Whether this is a current issue or one that has been retired etc Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
contraindication | ΣC | 0..1 | BackboneElement | Specifics for when this is a contraindication | ||||
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 | ||||
diseaseSymptomProcedure | Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation that is being documented as contraindicating against this item Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
diseaseStatus | Σ | 0..1 | CodeableReference(ObservationDefinition) | The status of the disease or symptom for the contraindication Binding: DiseaseStatus (example): The status of a disease or symptom. | ||||
comorbidity | Σ | 0..* | CodeableReference(ObservationDefinition) | A comorbidity (concurrent condition) or coinfection Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
indication | Σ | 0..* | Reference(ClinicalUseDefinition) | The indication which this is a contraidication for | ||||
applicability | 0..1 | Expression | An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements | |||||
otherTherapy | Σ | 0..* | BackboneElement | Information about use of the product in relation to other therapies described as part of the contraindication | ||||
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 | ||||
relationshipType | Σ | 1..1 | CodeableConcept | The type of relationship between the product indication/contraindication and another therapy Binding: TherapyRelationshipType (preferred): Classification of relationship between a therapy and a contraindication or an indication. | ||||
treatment | Σ | 1..1 | CodeableReference(MedicinalProductDefinition | Medication | Substance | SubstanceDefinition | NutritionProduct | BiologicallyDerivedProduct | ActivityDefinition) | Reference to a specific medication, substance etc. as part of an indication or contraindication Binding: Therapy (example): A therapy. | ||||
indication | ΣC | 1..1 | BackboneElement | Specifics for when this is an indication | ||||
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 | ||||
diseaseSymptomProcedure | Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation that is being documented as an indicaton for this item Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:FOPH | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
diseaseStatus | Σ | 0..1 | CodeableReference(ObservationDefinition) | The status of the disease or symptom for the indication Binding: DiseaseStatus (example): The status of a disease or symptom. | ||||
comorbidity | Σ | 0..* | CodeableReference(ObservationDefinition) | A comorbidity or coinfection as part of the indication Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:FOPH | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
intendedEffect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: EMA - Intended Effect (required) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://spor.ema.europa.eu/v1/lists/200000003186 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
duration[x] | Σ | 0..1 | Timing or duration information | |||||
durationRange | Range | |||||||
durationString | string | |||||||
undesirableEffect | Σ | 0..* | Reference(ClinicalUseDefinition) | An unwanted side effect or negative outcome of the subject of this resource when being used for this indication | ||||
applicability | 0..1 | Expression | An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements | |||||
otherTherapy | Σ | 0..* | See otherTherapy (ClinicalUseDefinition) | The use of the medicinal product in relation to other therapies described as part of the indication | ||||
interaction | ΣC | 0..1 | BackboneElement | Specifics for when this is an interaction | ||||
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 | ||||
interactant | Σ | 0..* | BackboneElement | The specific medication, product, food etc. or laboratory test that interacts | ||||
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 | ||||
item[x] | Σ | 1..1 | The specific medication, product, food etc. or laboratory test that interacts Binding: Interactant (example): An interactant - a substance that may have a clinically significant effect on another. | |||||
itemReference | Reference(MedicinalProductDefinition | Medication | Substance | NutritionProduct | BiologicallyDerivedProduct | ObservationDefinition) | |||||||
itemCodeableConcept | CodeableConcept | |||||||
type | Σ | 0..1 | CodeableConcept | The type of the interaction e.g. drug-drug interaction, drug-lab test interaction Binding: InteractionType (example): A categorisation for an interaction between two substances. | ||||
effect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The effect of the interaction, for example "reduced gastric absorption of primary medication" Binding: InteractionEffect (example): A interaction effect of clinical use of a medication or other substance. | ||||
incidence | Σ | 0..1 | CodeableConcept | The incidence of the interaction, e.g. theoretical, observed Binding: InteractionIncidence (example): A categorisation for incidence of occurence of an interaction. | ||||
management | Σ | 0..* | CodeableConcept | Actions for managing the interaction Binding: InteractionManagement (example): A type of management for an interaction of a medication or other substance. | ||||
population | Σ | 0..* | Reference(Group) | The population group to which this applies | ||||
library | Σ | 0..* | canonical(Library) | Logic used by the clinical use definition | ||||
undesirableEffect | ΣC | 0..1 | BackboneElement | A possible negative outcome from the use of this treatment | ||||
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 | ||||
symptomConditionEffect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation in which the undesirable effect may manifest Binding: UndesirableEffectSymptom (example): An undesirable effect of clinical use. | ||||
classification | Σ | 0..1 | CodeableConcept | High level classification of the effect Binding: UndesirableEffectClassification (example): A categorisation for an undesirable effect. | ||||
frequencyOfOccurrence | Σ | 0..1 | CodeableConcept | How often the effect is seen Binding: UndesirablEffectFrequency (example): A categorisation for a frequency of occurence of an undesirable effect. | ||||
warning | ΣC | 0..1 | BackboneElement | Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' | ||||
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 | ||||
description | Σ | 0..1 | markdown | A textual definition of this warning, with formatting | ||||
code | Σ | 0..1 | CodeableConcept | A coded or unformatted textual definition of this warning Binding: WarningType (example): Classification of warning type. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClinicalUseDefinition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ClinicalUseDefinition.type | required | Pattern: indicationhttp://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard | |
ClinicalUseDefinition.category | preferred | ClinicalUseDefinitionCategoryhttp://hl7.org/fhir/ValueSet/clinical-use-definition-category from the FHIR Standard | |
ClinicalUseDefinition.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
ClinicalUseDefinition.contraindication.diseaseSymptomProcedure | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.contraindication.diseaseStatus | example | DiseaseStatushttp://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard | |
ClinicalUseDefinition.contraindication.comorbidity | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.contraindication.otherTherapy.relationshipType | preferred | TherapyRelationshipTypehttp://hl7.org/fhir/ValueSet/therapy-relationship-type from the FHIR Standard | |
ClinicalUseDefinition.contraindication.otherTherapy.treatment | example | Therapyhttp://hl7.org/fhir/ValueSet/therapy from the FHIR Standard | |
ClinicalUseDefinition.indication.diseaseSymptomProcedure | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.indication.diseaseStatus | example | DiseaseStatushttp://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard | |
ClinicalUseDefinition.indication.comorbidity | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.indication.intendedEffect | required | EMAIntendedEffectVS (a valid code from EMA - Intended Effect)http://fhir.ch/ig/ch-epl/ValueSet/ema-intended-effect from this IG | |
ClinicalUseDefinition.interaction.interactant.item[x] | example | Interactanthttp://hl7.org/fhir/ValueSet/interactant from the FHIR Standard | |
ClinicalUseDefinition.interaction.type | example | InteractionTypehttp://hl7.org/fhir/ValueSet/interaction-type from the FHIR Standard | |
ClinicalUseDefinition.interaction.effect | example | InteractionEffecthttp://hl7.org/fhir/ValueSet/interaction-effect from the FHIR Standard | |
ClinicalUseDefinition.interaction.incidence | example | InteractionIncidencehttp://hl7.org/fhir/ValueSet/interaction-incidence from the FHIR Standard | |
ClinicalUseDefinition.interaction.management | example | InteractionManagementhttp://hl7.org/fhir/ValueSet/interaction-management from the FHIR Standard | |
ClinicalUseDefinition.undesirableEffect.symptomConditionEffect | example | UndesirableEffectSymptomhttp://hl7.org/fhir/ValueSet/undesirable-effect-symptom from the FHIR Standard | |
ClinicalUseDefinition.undesirableEffect.classification | example | UndesirableEffectClassificationhttp://hl7.org/fhir/ValueSet/undesirable-effect-classification from the FHIR Standard | |
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence | example | UndesirablEffectFrequencyhttp://hl7.org/fhir/ValueSet/undesirable-effect-frequency from the FHIR Standard | |
ClinicalUseDefinition.warning.code | example | WarningTypehttp://hl7.org/fhir/ValueSet/warning-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cud-1 | error | ClinicalUseDefinition | Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance : (ClinicalUseDefinition.indication.count() + ClinicalUseDefinition.contraindication.count() + ClinicalUseDefinition.interaction.count() + ClinicalUseDefinition.undesirableEffect.count() + ClinicalUseDefinition.warning.count()) < 2 | |
dom-2 | error | ClinicalUseDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ClinicalUseDefinition | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ClinicalUseDefinition | 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 | ClinicalUseDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ClinicalUseDefinition | 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 ClinicalUseDefinition
Summary
Mandatory: 1 element(16 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ClinicalUseDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalUseDefinition | 0..* | ClinicalUseDefinition | CH IDMP ClincalUseDefinition Indication | |
type | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Required Pattern: indication | |
subject | 0..* | Reference(IDMP MedicinalProductDefinition) | The medication, product, substance, device, procedure etc. for which this is an indication | |
indication | 1..1 | BackboneElement | Specifics for when this is an indication | |
diseaseSymptomProcedure | ||||
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SMC | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | |
code | 1..1 | code | Symbol in syntax defined by the system | |
coding:FOPH | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
comorbidity | ||||
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SMC | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | |
code | 1..1 | code | Symbol in syntax defined by the system | |
coding:FOPH | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system | |
intendedEffect | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: EMA - Intended Effect (required) | |
concept | 1..1 | CodeableConcept | Reference to a concept (by class) | |
Slices for coding | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |
coding:SMC | 0..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Required Pattern: http://spor.ema.europa.eu/v1/lists/200000003186 | |
code | 1..1 | code | Symbol in syntax defined by the system | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ClinicalUseDefinition.indication.intendedEffect | required | EMAIntendedEffectVS (a valid code from EMA - Intended Effect)http://fhir.ch/ig/ch-epl/ValueSet/ema-intended-effect from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ClinicalUseDefinition | C | 0..* | ClinicalUseDefinition | CH IDMP ClincalUseDefinition Indication cud-1: Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition. Required Pattern: indication |
subject | Σ | 0..* | Reference(IDMP MedicinalProductDefinition) | The medication, product, substance, device, procedure etc. for which this is an indication |
indication | ΣC | 1..1 | BackboneElement | Specifics for when this is an indication |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
intendedEffect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: EMA - Intended Effect (required) |
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) |
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://spor.ema.europa.eu/v1/lists/200000003186 |
code | ΣC | 1..1 | code | Symbol in syntax defined by the system |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClinicalUseDefinition.type | required | Pattern: indicationhttp://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard | |
ClinicalUseDefinition.indication.intendedEffect | required | EMAIntendedEffectVS (a valid code from EMA - Intended Effect)http://fhir.ch/ig/ch-epl/ValueSet/ema-intended-effect from this IG |
Id | Grade | Path(s) | Details | Requirements |
cud-1 | error | ClinicalUseDefinition | Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance : (ClinicalUseDefinition.indication.count() + ClinicalUseDefinition.contraindication.count() + ClinicalUseDefinition.interaction.count() + ClinicalUseDefinition.undesirableEffect.count() + ClinicalUseDefinition.warning.count()) < 2 | |
dom-2 | error | ClinicalUseDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ClinicalUseDefinition | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ClinicalUseDefinition | 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 | ClinicalUseDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ClinicalUseDefinition | 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 | ||||
---|---|---|---|---|---|---|---|---|
ClinicalUseDefinition | C | 0..* | ClinicalUseDefinition | CH IDMP ClincalUseDefinition Indication cud-1: Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance | ||||
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: AllLanguages (required): IETF language tag for 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 | Business identifier for this issue | ||||
type | Σ | 1..1 | code | indication | contraindication | interaction | undesirable-effect | warning Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition. Required Pattern: indication | ||||
category | Σ | 0..* | CodeableConcept | A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose" Binding: ClinicalUseDefinitionCategory (preferred): A categorisation for a clinical use information item. | ||||
subject | Σ | 0..* | Reference(IDMP MedicinalProductDefinition) | The medication, product, substance, device, procedure etc. for which this is an indication | ||||
status | Σ | 0..1 | CodeableConcept | Whether this is a current issue or one that has been retired etc Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
contraindication | ΣC | 0..1 | BackboneElement | Specifics for when this is a contraindication | ||||
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 | ||||
diseaseSymptomProcedure | Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation that is being documented as contraindicating against this item Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
diseaseStatus | Σ | 0..1 | CodeableReference(ObservationDefinition) | The status of the disease or symptom for the contraindication Binding: DiseaseStatus (example): The status of a disease or symptom. | ||||
comorbidity | Σ | 0..* | CodeableReference(ObservationDefinition) | A comorbidity (concurrent condition) or coinfection Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
indication | Σ | 0..* | Reference(ClinicalUseDefinition) | The indication which this is a contraidication for | ||||
applicability | 0..1 | Expression | An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements | |||||
otherTherapy | Σ | 0..* | BackboneElement | Information about use of the product in relation to other therapies described as part of the contraindication | ||||
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 | ||||
relationshipType | Σ | 1..1 | CodeableConcept | The type of relationship between the product indication/contraindication and another therapy Binding: TherapyRelationshipType (preferred): Classification of relationship between a therapy and a contraindication or an indication. | ||||
treatment | Σ | 1..1 | CodeableReference(MedicinalProductDefinition | Medication | Substance | SubstanceDefinition | NutritionProduct | BiologicallyDerivedProduct | ActivityDefinition) | Reference to a specific medication, substance etc. as part of an indication or contraindication Binding: Therapy (example): A therapy. | ||||
indication | ΣC | 1..1 | BackboneElement | Specifics for when this is an indication | ||||
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 | ||||
diseaseSymptomProcedure | Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation that is being documented as an indicaton for this item Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:FOPH | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
diseaseStatus | Σ | 0..1 | CodeableReference(ObservationDefinition) | The status of the disease or symptom for the indication Binding: DiseaseStatus (example): The status of a disease or symptom. | ||||
comorbidity | Σ | 0..* | CodeableReference(ObservationDefinition) | A comorbidity or coinfection as part of the indication Binding: DiseaseSymptomProcedure (example): A symptom, disease or procedure. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.meddra.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:FOPH | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
intendedEffect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The intended effect, aim or strategy to be achieved Binding: EMA - Intended Effect (required) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
concept | Σ | 1..1 | CodeableConcept | Reference to a concept (by class) | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
coding:SMC | Σ | 0..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://spor.ema.europa.eu/v1/lists/200000003186 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 1..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
reference | Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
duration[x] | Σ | 0..1 | Timing or duration information | |||||
durationRange | Range | |||||||
durationString | string | |||||||
undesirableEffect | Σ | 0..* | Reference(ClinicalUseDefinition) | An unwanted side effect or negative outcome of the subject of this resource when being used for this indication | ||||
applicability | 0..1 | Expression | An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements | |||||
otherTherapy | Σ | 0..* | See otherTherapy (ClinicalUseDefinition) | The use of the medicinal product in relation to other therapies described as part of the indication | ||||
interaction | ΣC | 0..1 | BackboneElement | Specifics for when this is an interaction | ||||
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 | ||||
interactant | Σ | 0..* | BackboneElement | The specific medication, product, food etc. or laboratory test that interacts | ||||
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 | ||||
item[x] | Σ | 1..1 | The specific medication, product, food etc. or laboratory test that interacts Binding: Interactant (example): An interactant - a substance that may have a clinically significant effect on another. | |||||
itemReference | Reference(MedicinalProductDefinition | Medication | Substance | NutritionProduct | BiologicallyDerivedProduct | ObservationDefinition) | |||||||
itemCodeableConcept | CodeableConcept | |||||||
type | Σ | 0..1 | CodeableConcept | The type of the interaction e.g. drug-drug interaction, drug-lab test interaction Binding: InteractionType (example): A categorisation for an interaction between two substances. | ||||
effect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The effect of the interaction, for example "reduced gastric absorption of primary medication" Binding: InteractionEffect (example): A interaction effect of clinical use of a medication or other substance. | ||||
incidence | Σ | 0..1 | CodeableConcept | The incidence of the interaction, e.g. theoretical, observed Binding: InteractionIncidence (example): A categorisation for incidence of occurence of an interaction. | ||||
management | Σ | 0..* | CodeableConcept | Actions for managing the interaction Binding: InteractionManagement (example): A type of management for an interaction of a medication or other substance. | ||||
population | Σ | 0..* | Reference(Group) | The population group to which this applies | ||||
library | Σ | 0..* | canonical(Library) | Logic used by the clinical use definition | ||||
undesirableEffect | ΣC | 0..1 | BackboneElement | A possible negative outcome from the use of this treatment | ||||
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 | ||||
symptomConditionEffect | Σ | 0..1 | CodeableReference(ObservationDefinition) | The situation in which the undesirable effect may manifest Binding: UndesirableEffectSymptom (example): An undesirable effect of clinical use. | ||||
classification | Σ | 0..1 | CodeableConcept | High level classification of the effect Binding: UndesirableEffectClassification (example): A categorisation for an undesirable effect. | ||||
frequencyOfOccurrence | Σ | 0..1 | CodeableConcept | How often the effect is seen Binding: UndesirablEffectFrequency (example): A categorisation for a frequency of occurence of an undesirable effect. | ||||
warning | ΣC | 0..1 | BackboneElement | Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' | ||||
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 | ||||
description | Σ | 0..1 | markdown | A textual definition of this warning, with formatting | ||||
code | Σ | 0..1 | CodeableConcept | A coded or unformatted textual definition of this warning Binding: WarningType (example): Classification of warning type. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
ClinicalUseDefinition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ClinicalUseDefinition.type | required | Pattern: indicationhttp://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard | |
ClinicalUseDefinition.category | preferred | ClinicalUseDefinitionCategoryhttp://hl7.org/fhir/ValueSet/clinical-use-definition-category from the FHIR Standard | |
ClinicalUseDefinition.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
ClinicalUseDefinition.contraindication.diseaseSymptomProcedure | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.contraindication.diseaseStatus | example | DiseaseStatushttp://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard | |
ClinicalUseDefinition.contraindication.comorbidity | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.contraindication.otherTherapy.relationshipType | preferred | TherapyRelationshipTypehttp://hl7.org/fhir/ValueSet/therapy-relationship-type from the FHIR Standard | |
ClinicalUseDefinition.contraindication.otherTherapy.treatment | example | Therapyhttp://hl7.org/fhir/ValueSet/therapy from the FHIR Standard | |
ClinicalUseDefinition.indication.diseaseSymptomProcedure | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.indication.diseaseStatus | example | DiseaseStatushttp://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard | |
ClinicalUseDefinition.indication.comorbidity | example | DiseaseSymptomProcedurehttp://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard | |
ClinicalUseDefinition.indication.intendedEffect | required | EMAIntendedEffectVS (a valid code from EMA - Intended Effect)http://fhir.ch/ig/ch-epl/ValueSet/ema-intended-effect from this IG | |
ClinicalUseDefinition.interaction.interactant.item[x] | example | Interactanthttp://hl7.org/fhir/ValueSet/interactant from the FHIR Standard | |
ClinicalUseDefinition.interaction.type | example | InteractionTypehttp://hl7.org/fhir/ValueSet/interaction-type from the FHIR Standard | |
ClinicalUseDefinition.interaction.effect | example | InteractionEffecthttp://hl7.org/fhir/ValueSet/interaction-effect from the FHIR Standard | |
ClinicalUseDefinition.interaction.incidence | example | InteractionIncidencehttp://hl7.org/fhir/ValueSet/interaction-incidence from the FHIR Standard | |
ClinicalUseDefinition.interaction.management | example | InteractionManagementhttp://hl7.org/fhir/ValueSet/interaction-management from the FHIR Standard | |
ClinicalUseDefinition.undesirableEffect.symptomConditionEffect | example | UndesirableEffectSymptomhttp://hl7.org/fhir/ValueSet/undesirable-effect-symptom from the FHIR Standard | |
ClinicalUseDefinition.undesirableEffect.classification | example | UndesirableEffectClassificationhttp://hl7.org/fhir/ValueSet/undesirable-effect-classification from the FHIR Standard | |
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence | example | UndesirablEffectFrequencyhttp://hl7.org/fhir/ValueSet/undesirable-effect-frequency from the FHIR Standard | |
ClinicalUseDefinition.warning.code | example | WarningTypehttp://hl7.org/fhir/ValueSet/warning-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cud-1 | error | ClinicalUseDefinition | Indication, Contraindication, Interaction, UndesirableEffect and Warning cannot be used in the same instance : (ClinicalUseDefinition.indication.count() + ClinicalUseDefinition.contraindication.count() + ClinicalUseDefinition.interaction.count() + ClinicalUseDefinition.undesirableEffect.count() + ClinicalUseDefinition.warning.count()) < 2 | |
dom-2 | error | ClinicalUseDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ClinicalUseDefinition | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | ClinicalUseDefinition | 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 | ClinicalUseDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ClinicalUseDefinition | 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 ClinicalUseDefinition
Summary
Mandatory: 1 element(16 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron