Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use International flag

Electronic Medicinal Product Information (ePI) FHIR Implementation Guide, published by HL7 International - Biomedical Research & Regulation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions

Resource Profile: ClinicalUseDefinition Interaction (ePI)

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/ClinicalUseDefinition-interaction-uv-epi Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: ClinicalUseDefinitionInteractionUvEpi

ClinicalUseDefinition Interaction (ePI)

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ClinicalUseDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition 0..* ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
... identifier 0..* Identifier Business identifier for this clinical use.
... type 1..1 code indication | contraindication | interaction | undesirable-effect | warning
Required Pattern: interaction
... subject 1..* Reference(MedicinalProductDefinition (ePI)) The medication, product, substance, device, procedure etc. for which this is an indication
... contraindication 0..0
... indication 0..0
... interaction
.... interactant
..... Slices for item[x] 1..1 Reference(MedicinalProductDefinition | Medication | Substance | NutritionProduct | BiologicallyDerivedProduct | ObservationDefinition), CodeableConcept The specific medication, product, food etc. or laboratory test that interacts
Slice: Unordered, Open by type:$this
...... item[x]:itemCodeableConcept 0..1 CodeableConcept The specific medication, product, food etc. or laboratory test that interacts
Binding: Interactant (example): The specific substance that interacts. see additional bindings in JSON OR XML

Additional BindingsPurpose
Substances Extensible Binding
.... type 0..1 CodeableConcept The type of the interaction e.g. drug-drug, drug-food, drug-lab.
... undesirableEffect 0..0
... warning 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ClinicalUseDefinition.interaction.interactant.item[x]:itemCodeableConceptexampleInteractant
http://hl7.org/fhir/ValueSet/interactant
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C 0..* ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
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: interaction
... subject Σ 1..* Reference(MedicinalProductDefinition (ePI)) The medication, product, substance, device, procedure etc. for which this is an indication
... status Σ 0..1 CodeableConcept Defines whether this clinical use is draft, active or retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.typerequiredPattern: interaction
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
from the FHIR Standard
ClinicalUseDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cud-1errorClinicalUseDefinitionIndication, 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-2errorClinicalUseDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClinicalUseDefinitionIf 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-4errorClinicalUseDefinitionIf 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-5errorClinicalUseDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClinicalUseDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C 0..* ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
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
... 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 clinical use.
... type Σ 1..1 code indication | contraindication | interaction | undesirable-effect | warning
Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition.


Required Pattern: interaction
... 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 Σ 1..* Reference(MedicinalProductDefinition (ePI)) The medication, product, substance, device, procedure etc. for which this is an indication
... status Σ 0..1 CodeableConcept Defines whether this clinical use is draft, active or retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... 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
..... Slices for item[x] Σ 1..1 The specific medication, product, food etc. or laboratory test that interacts
Slice: Unordered, Open by type:$this
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
...... item[x]:itemCodeableConcept Σ 0..1 CodeableConcept The specific medication, product, food etc. or laboratory test that interacts
Binding: Interactant (example): The specific substance that interacts. see additional bindings in JSON OR XML

Additional BindingsPurpose
Substances Extensible Binding
.... type Σ 0..1 CodeableConcept The type of the interaction e.g. drug-drug, drug-food, drug-lab.
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ClinicalUseDefinition.typerequiredPattern: interaction
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
from the FHIR Standard
ClinicalUseDefinition.categorypreferredClinicalUseDefinitionCategory
http://hl7.org/fhir/ValueSet/clinical-use-definition-category
from the FHIR Standard
ClinicalUseDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
from the FHIR Standard
ClinicalUseDefinition.contraindication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.relationshipTypepreferredTherapyRelationshipType
http://hl7.org/fhir/ValueSet/therapy-relationship-type
from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.treatmentexampleTherapy
http://hl7.org/fhir/ValueSet/therapy
from the FHIR Standard
ClinicalUseDefinition.indication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.indication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
from the FHIR Standard
ClinicalUseDefinition.indication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.indication.intendedEffectpreferredProductIntendedUse
http://hl7.org/fhir/ValueSet/product-intended-use
from the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]exampleInteractant
http://hl7.org/fhir/ValueSet/interactant
from the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]:itemCodeableConceptexampleInteractant
http://hl7.org/fhir/ValueSet/interactant
from the FHIR Standard
ClinicalUseDefinition.interaction.typeexampleInteractionType
http://hl7.org/fhir/ValueSet/interaction-type
from the FHIR Standard
ClinicalUseDefinition.interaction.effectexampleInteractionEffect
http://hl7.org/fhir/ValueSet/interaction-effect
from the FHIR Standard
ClinicalUseDefinition.interaction.incidenceexampleInteractionIncidence
http://hl7.org/fhir/ValueSet/interaction-incidence
from the FHIR Standard
ClinicalUseDefinition.interaction.managementexampleInteractionManagement
http://hl7.org/fhir/ValueSet/interaction-management
from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.symptomConditionEffectexampleUndesirableEffectSymptom
http://hl7.org/fhir/ValueSet/undesirable-effect-symptom
from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.classificationexampleUndesirableEffectClassification
http://hl7.org/fhir/ValueSet/undesirable-effect-classification
from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrenceexampleUndesirablEffectFrequency
http://hl7.org/fhir/ValueSet/undesirable-effect-frequency
from the FHIR Standard
ClinicalUseDefinition.warning.codeexampleWarningType
http://hl7.org/fhir/ValueSet/warning-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cud-1errorClinicalUseDefinitionIndication, 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-2errorClinicalUseDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClinicalUseDefinitionIf 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-4errorClinicalUseDefinitionIf 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-5errorClinicalUseDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClinicalUseDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ClinicalUseDefinition

Summary

Mandatory: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ClinicalUseDefinition.interaction.interactant.item[x]

Maturity: 2

Differential View

This structure is derived from ClinicalUseDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition 0..* ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
... identifier 0..* Identifier Business identifier for this clinical use.
... type 1..1 code indication | contraindication | interaction | undesirable-effect | warning
Required Pattern: interaction
... subject 1..* Reference(MedicinalProductDefinition (ePI)) The medication, product, substance, device, procedure etc. for which this is an indication
... contraindication 0..0
... indication 0..0
... interaction
.... interactant
..... Slices for item[x] 1..1 Reference(MedicinalProductDefinition | Medication | Substance | NutritionProduct | BiologicallyDerivedProduct | ObservationDefinition), CodeableConcept The specific medication, product, food etc. or laboratory test that interacts
Slice: Unordered, Open by type:$this
...... item[x]:itemCodeableConcept 0..1 CodeableConcept The specific medication, product, food etc. or laboratory test that interacts
Binding: Interactant (example): The specific substance that interacts. see additional bindings in JSON OR XML

Additional BindingsPurpose
Substances Extensible Binding
.... type 0..1 CodeableConcept The type of the interaction e.g. drug-drug, drug-food, drug-lab.
... undesirableEffect 0..0
... warning 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ClinicalUseDefinition.interaction.interactant.item[x]:itemCodeableConceptexampleInteractant
http://hl7.org/fhir/ValueSet/interactant
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C 0..* ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
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: interaction
... subject Σ 1..* Reference(MedicinalProductDefinition (ePI)) The medication, product, substance, device, procedure etc. for which this is an indication
... status Σ 0..1 CodeableConcept Defines whether this clinical use is draft, active or retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.typerequiredPattern: interaction
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
from the FHIR Standard
ClinicalUseDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cud-1errorClinicalUseDefinitionIndication, 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-2errorClinicalUseDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClinicalUseDefinitionIf 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-4errorClinicalUseDefinitionIf 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-5errorClinicalUseDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClinicalUseDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C 0..* ClinicalUseDefinition A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
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
... 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 clinical use.
... type Σ 1..1 code indication | contraindication | interaction | undesirable-effect | warning
Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition.


Required Pattern: interaction
... 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 Σ 1..* Reference(MedicinalProductDefinition (ePI)) The medication, product, substance, device, procedure etc. for which this is an indication
... status Σ 0..1 CodeableConcept Defines whether this clinical use is draft, active or retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... 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
..... Slices for item[x] Σ 1..1 The specific medication, product, food etc. or laboratory test that interacts
Slice: Unordered, Open by type:$this
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
...... item[x]:itemCodeableConcept Σ 0..1 CodeableConcept The specific medication, product, food etc. or laboratory test that interacts
Binding: Interactant (example): The specific substance that interacts. see additional bindings in JSON OR XML

Additional BindingsPurpose
Substances Extensible Binding
.... type Σ 0..1 CodeableConcept The type of the interaction e.g. drug-drug, drug-food, drug-lab.
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
ClinicalUseDefinition.typerequiredPattern: interaction
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
from the FHIR Standard
ClinicalUseDefinition.categorypreferredClinicalUseDefinitionCategory
http://hl7.org/fhir/ValueSet/clinical-use-definition-category
from the FHIR Standard
ClinicalUseDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
from the FHIR Standard
ClinicalUseDefinition.contraindication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.relationshipTypepreferredTherapyRelationshipType
http://hl7.org/fhir/ValueSet/therapy-relationship-type
from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.treatmentexampleTherapy
http://hl7.org/fhir/ValueSet/therapy
from the FHIR Standard
ClinicalUseDefinition.indication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.indication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
from the FHIR Standard
ClinicalUseDefinition.indication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
from the FHIR Standard
ClinicalUseDefinition.indication.intendedEffectpreferredProductIntendedUse
http://hl7.org/fhir/ValueSet/product-intended-use
from the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]exampleInteractant
http://hl7.org/fhir/ValueSet/interactant
from the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]:itemCodeableConceptexampleInteractant
http://hl7.org/fhir/ValueSet/interactant
from the FHIR Standard
ClinicalUseDefinition.interaction.typeexampleInteractionType
http://hl7.org/fhir/ValueSet/interaction-type
from the FHIR Standard
ClinicalUseDefinition.interaction.effectexampleInteractionEffect
http://hl7.org/fhir/ValueSet/interaction-effect
from the FHIR Standard
ClinicalUseDefinition.interaction.incidenceexampleInteractionIncidence
http://hl7.org/fhir/ValueSet/interaction-incidence
from the FHIR Standard
ClinicalUseDefinition.interaction.managementexampleInteractionManagement
http://hl7.org/fhir/ValueSet/interaction-management
from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.symptomConditionEffectexampleUndesirableEffectSymptom
http://hl7.org/fhir/ValueSet/undesirable-effect-symptom
from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.classificationexampleUndesirableEffectClassification
http://hl7.org/fhir/ValueSet/undesirable-effect-classification
from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrenceexampleUndesirablEffectFrequency
http://hl7.org/fhir/ValueSet/undesirable-effect-frequency
from the FHIR Standard
ClinicalUseDefinition.warning.codeexampleWarningType
http://hl7.org/fhir/ValueSet/warning-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cud-1errorClinicalUseDefinitionIndication, 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-2errorClinicalUseDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorClinicalUseDefinitionIf 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-4errorClinicalUseDefinitionIf 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-5errorClinicalUseDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceClinicalUseDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ClinicalUseDefinition

Summary

Mandatory: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ClinicalUseDefinition.interaction.interactant.item[x]

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron