Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: ContraindicationDefinition Profile

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

Usage:

• Examples for this Resource Profile: ClinicalUseDefinition/example-allergy-contraindication

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ClinicalUseDefinition

Name	Flags	Card.	Type	Description & Constraints
ClinicalUseDefinition		0..*	ClinicalUseDefinition	A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
type		1..1	code	indication | contraindication | interaction | undesirable-effect | warning Fixed Value: contraindication
contraindication		1..1	BackboneElement	Specifics for when this is a contraindication
indication		0..0
interaction		0..0
undesirableEffect		0..0
warning		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	1..1	code	indication | contraindication | interaction | undesirable-effect | warning Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition. ele-1: All FHIR elements must have a @value or children Fixed Value: contraindication
contraindication	ΣC	1..1	BackboneElement	Specifics for when this is a contraindication ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ClinicalUseDefinition.type	required	Fixed Value: contraindication http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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. Fixed Value: contraindication
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(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance | NutritionProduct | BiologicallyDerivedProduct)	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	1..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.
population	Σ	0..*	Reference(Group)	The population group to which this applies
library	Σ	0..*	canonical(Library)	Logic used by the clinical use definition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ClinicalUseDefinition.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
ClinicalUseDefinition.type	required	Fixed Value: contraindication http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard
ClinicalUseDefinition.category	preferred	ClinicalUseDefinitionCategory http://hl7.org/fhir/ValueSet/clinical-use-definition-category from the FHIR Standard
ClinicalUseDefinition.status	preferred	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseSymptomProcedure	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseStatus	example	DiseaseStatus http://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard
ClinicalUseDefinition.contraindication.comorbidity	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.relationshipType	preferred	TherapyRelationshipType http://hl7.org/fhir/ValueSet/therapy-relationship-type from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.treatment	example	Therapy http://hl7.org/fhir/ValueSet/therapy from the FHIR Standard
ClinicalUseDefinition.indication.diseaseSymptomProcedure	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.indication.diseaseStatus	example	DiseaseStatus http://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard
ClinicalUseDefinition.indication.comorbidity	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.indication.intendedEffect	preferred	ProductIntendedUse http://hl7.org/fhir/ValueSet/product-intended-use from the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]	example	Interactant http://hl7.org/fhir/ValueSet/interactant from the FHIR Standard
ClinicalUseDefinition.interaction.type	example	InteractionType http://hl7.org/fhir/ValueSet/interaction-type from the FHIR Standard
ClinicalUseDefinition.interaction.effect	example	InteractionEffect http://hl7.org/fhir/ValueSet/interaction-effect from the FHIR Standard
ClinicalUseDefinition.interaction.incidence	example	InteractionIncidence http://hl7.org/fhir/ValueSet/interaction-incidence from the FHIR Standard
ClinicalUseDefinition.interaction.management	example	InteractionManagement http://hl7.org/fhir/ValueSet/interaction-management from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.symptomConditionEffect	example	UndesirableEffectSymptom http://hl7.org/fhir/ValueSet/undesirable-effect-symptom from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.classification	example	UndesirableEffectClassification http://hl7.org/fhir/ValueSet/undesirable-effect-classification from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence	example	UndesirablEffectFrequency http://hl7.org/fhir/ValueSet/undesirable-effect-frequency from the FHIR Standard
ClinicalUseDefinition.warning.code	example	WarningType http://hl7.org/fhir/ValueSet/warning-type from the FHIR Standard

This structure is derived from ClinicalUseDefinition

Summary

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

Maturity: 2

Differential View

This structure is derived from ClinicalUseDefinition

Name	Flags	Card.	Type	Description & Constraints
ClinicalUseDefinition		0..*	ClinicalUseDefinition	A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
type		1..1	code	indication | contraindication | interaction | undesirable-effect | warning Fixed Value: contraindication
contraindication		1..1	BackboneElement	Specifics for when this is a contraindication
indication		0..0
interaction		0..0
undesirableEffect		0..0
warning		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	1..1	code	indication | contraindication | interaction | undesirable-effect | warning Binding: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition. ele-1: All FHIR elements must have a @value or children Fixed Value: contraindication
contraindication	ΣC	1..1	BackboneElement	Specifics for when this is a contraindication ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ClinicalUseDefinition.type	required	Fixed Value: contraindication http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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. Fixed Value: contraindication
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(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance | NutritionProduct | BiologicallyDerivedProduct)	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	1..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.
population	Σ	0..*	Reference(Group)	The population group to which this applies
library	Σ	0..*	canonical(Library)	Logic used by the clinical use definition
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
ClinicalUseDefinition.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard
ClinicalUseDefinition.type	required	Fixed Value: contraindication http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0 from the FHIR Standard
ClinicalUseDefinition.category	preferred	ClinicalUseDefinitionCategory http://hl7.org/fhir/ValueSet/clinical-use-definition-category from the FHIR Standard
ClinicalUseDefinition.status	preferred	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseSymptomProcedure	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseStatus	example	DiseaseStatus http://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard
ClinicalUseDefinition.contraindication.comorbidity	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.relationshipType	preferred	TherapyRelationshipType http://hl7.org/fhir/ValueSet/therapy-relationship-type from the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.treatment	example	Therapy http://hl7.org/fhir/ValueSet/therapy from the FHIR Standard
ClinicalUseDefinition.indication.diseaseSymptomProcedure	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.indication.diseaseStatus	example	DiseaseStatus http://hl7.org/fhir/ValueSet/disease-status from the FHIR Standard
ClinicalUseDefinition.indication.comorbidity	example	DiseaseSymptomProcedure http://hl7.org/fhir/ValueSet/disease-symptom-procedure from the FHIR Standard
ClinicalUseDefinition.indication.intendedEffect	preferred	ProductIntendedUse http://hl7.org/fhir/ValueSet/product-intended-use from the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]	example	Interactant http://hl7.org/fhir/ValueSet/interactant from the FHIR Standard
ClinicalUseDefinition.interaction.type	example	InteractionType http://hl7.org/fhir/ValueSet/interaction-type from the FHIR Standard
ClinicalUseDefinition.interaction.effect	example	InteractionEffect http://hl7.org/fhir/ValueSet/interaction-effect from the FHIR Standard
ClinicalUseDefinition.interaction.incidence	example	InteractionIncidence http://hl7.org/fhir/ValueSet/interaction-incidence from the FHIR Standard
ClinicalUseDefinition.interaction.management	example	InteractionManagement http://hl7.org/fhir/ValueSet/interaction-management from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.symptomConditionEffect	example	UndesirableEffectSymptom http://hl7.org/fhir/ValueSet/undesirable-effect-symptom from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.classification	example	UndesirableEffectClassification http://hl7.org/fhir/ValueSet/undesirable-effect-classification from the FHIR Standard
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence	example	UndesirablEffectFrequency http://hl7.org/fhir/ValueSet/undesirable-effect-frequency from the FHIR Standard
ClinicalUseDefinition.warning.code	example	WarningType http://hl7.org/fhir/ValueSet/warning-type from the FHIR Standard

This structure is derived from ClinicalUseDefinition

Summary

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

Maturity: 2

Other representations of profile: CSV, Excel, Schematron