Order Catalog Implementation Guide
current - CI Build

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: IndicationDefinition Profile

Defining URL:http://hl7.org/fhir/uv/order-catalog/StructureDefinition/IndicationDefinition
Version:current
Name:IndicationDefinition
Title:ClinicalUseDefinition as a therapeutic indication
Status:Draft as of 2022-05-06 03:37:23+0000
Definition:

This profile constrains the base resource ClinicalUseDefinition to represent an indication associated with a healthcare item (medication, device, test, service ...) described in a catalog

Publisher:HL7 International - Orders and Observations Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/order-catalog/StructureDefinition/IndicationDefinition

Formal Views of Profile Content

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

This structure is derived from ClinicalUseDefinition

Summary

Mandatory: 1 element
Fixed Value: 1 element
Prohibited: 4 elements

This structure is derived from ClinicalUseDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition 0..*ClinicalUseDefinitionA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
... type 1..1codeindication | contraindication | interaction | undesirable-effect | warning
Fixed Value: indication
... contraindication 0..0
... indication 1..1BackboneElementSpecifics for when this is an indication
... undesirableEffect 0..0
... warning 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition I0..*ClinicalUseDefinitionA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this issue
... type Σ1..1codeindication | contraindication | interaction | undesirable-effect | warning
Binding: ClinicalUseIssueType (required): Overall defining type of this clinical use issue.


Fixed Value: indication
... category Σ0..*CodeableConceptA categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines"
... subject Σ0..*Reference(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance)The medication or procedure for which this is an indication
... status Σ0..1CodeableConceptWhether this is a current issue or one that has been retired etc
... indication Σ1..1BackboneElementSpecifics for when this is an indication
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... diseaseSymptomProcedure Σ0..1CodeableReference(ObservationDefinition)The situation that is being documented as an indicaton for this item
.... diseaseStatus Σ0..1CodeableReference(ObservationDefinition)The status of the disease or symptom for the indication
.... comorbidity Σ0..*CodeableReference(ObservationDefinition)A comorbidity (concurrent condition) or coinfection as part of the indication
.... intendedEffect Σ0..1CodeableReference(ObservationDefinition)The intended effect, aim or strategy to be achieved
.... duration Σ0..1QuantityTiming or duration information
.... undesirableEffect Σ0..*Reference(ClinicalUseDefinition)The specific undesirable effects of the medicinal product
.... otherTherapy Σ0..*See otherTherapy (ClinicalUseDefinition)Information about the use of the medicinal product in relation to other therapies described as part of the indication
... population Σ0..*Reference(Group)The population group to which this applies

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition I0..*ClinicalUseDefinitionA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure

doco Documentation for this format

This structure is derived from ClinicalUseDefinition

Summary

Mandatory: 1 element
Fixed Value: 1 element
Prohibited: 4 elements

Differential View

This structure is derived from ClinicalUseDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition 0..*ClinicalUseDefinitionA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
... type 1..1codeindication | contraindication | interaction | undesirable-effect | warning
Fixed Value: indication
... contraindication 0..0
... indication 1..1BackboneElementSpecifics for when this is an indication
... undesirableEffect 0..0
... warning 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition I0..*ClinicalUseDefinitionA single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for this issue
... type Σ1..1codeindication | contraindication | interaction | undesirable-effect | warning
Binding: ClinicalUseIssueType (required): Overall defining type of this clinical use issue.


Fixed Value: indication
... category Σ0..*CodeableConceptA categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines"
... subject Σ0..*Reference(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance)The medication or procedure for which this is an indication
... status Σ0..1CodeableConceptWhether this is a current issue or one that has been retired etc
... indication Σ1..1BackboneElementSpecifics for when this is an indication
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... diseaseSymptomProcedure Σ0..1CodeableReference(ObservationDefinition)The situation that is being documented as an indicaton for this item
.... diseaseStatus Σ0..1CodeableReference(ObservationDefinition)The status of the disease or symptom for the indication
.... comorbidity Σ0..*CodeableReference(ObservationDefinition)A comorbidity (concurrent condition) or coinfection as part of the indication
.... intendedEffect Σ0..1CodeableReference(ObservationDefinition)The intended effect, aim or strategy to be achieved
.... duration Σ0..1QuantityTiming or duration information
.... undesirableEffect Σ0..*Reference(ClinicalUseDefinition)The specific undesirable effects of the medicinal product
.... otherTherapy Σ0..*See otherTherapy (ClinicalUseDefinition)Information about the use of the medicinal product in relation to other therapies described as part of the indication
... population Σ0..*Reference(Group)The population group to which this applies

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ClinicalUseDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
ClinicalUseDefinition.typerequiredFixed Value: indication
ClinicalUseDefinition.contraindication.otherTherapy.relationshipTypepreferredTherapyRelationshipType
ClinicalUseDefinition.warning.codeexampleWarningType

Constraints

IdGradePathDetailsRequirements
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().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-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-1errorClinicalUseDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.contraindication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.contraindication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.contraindication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.contraindication.diseaseSymptomProcedureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.diseaseStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.comorbidityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.indicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.otherTherapyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.otherTherapy.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.contraindication.otherTherapy.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.contraindication.otherTherapy.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.contraindication.otherTherapy.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.contraindication.otherTherapy.relationshipTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.contraindication.otherTherapy.therapyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.indication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.indication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.indication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.indication.diseaseSymptomProcedureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.diseaseStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.comorbidityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.intendedEffectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.durationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.undesirableEffectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.indication.otherTherapyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.interaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.interaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.interaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.interaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.interaction.interactantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.interaction.interactant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.interaction.interactant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.interaction.interactant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.interaction.interactant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.interaction.interactant.item[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.interaction.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.interaction.effectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.interaction.incidenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.interaction.managementAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.populationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.undesirableEffect.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.undesirableEffect.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.undesirableEffect.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.undesirableEffect.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.undesirableEffect.symptomConditionEffectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.undesirableEffect.classificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.undesirableEffect.frequencyOfOccurrenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.warning.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.warning.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.warning.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorClinicalUseDefinition.warning.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorClinicalUseDefinition.warning.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorClinicalUseDefinition.warning.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())