Order Catalog Implementation Guide
1.0.0-ballot - CI Build
Order Catalog Implementation Guide
1.0.0-ballot - CI Build
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
| Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ContraindicationDefinition | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: ContraindicationDefinition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.9 | ||||
This profile constrains the base resource ClinicalUseDefinition to represent a contraindication associated with a healthcare item (medication, device, test, service …) described in a catalog
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  ClinicalUseDefinition |
C | 0..* | ClinicalUseDefinition | A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure Constraints: cud-1 |
  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. Fixed Value: contraindication |
  contraindication |
ΣC | 1..1 | BackboneElement | Specifics for when this is a contraindication |
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.type | Base | required | Clinical Use Definition Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Specifics for when this is an indication | ||
| interaction |
0..0 | Specifics for when this is an interaction | ||
| undesirableEffect |
0..0 | A possible negative outcome from the use of this treatment | ||
| warning |
0..0 | Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ClinicalUseDefinition |
C | 0..* | ClinicalUseDefinition | A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure Constraints: cud-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.type | Base | required | Clinical Use Definition Type | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.category | Base | preferred | Clinical Use Definition Category | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.status | Base | preferred | PublicationStatus | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseSymptomProcedure | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseStatus | Base | example | Disease Status | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.comorbidity | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.relationshipType | Base | preferred | Therapy Relationship Type | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.treatment | Base | example | Therapy | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseSymptomProcedure | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseStatus | Base | example | Disease Status | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.comorbidity | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.intendedEffect | Base | preferred | Product Intended Use | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.interactant.item[x] | Base | example | Interactant | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.type | Base | example | Interaction Type | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.effect | Base | example | Interaction Effect | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.incidence | Base | example | Interaction Incidence | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.management | Base | example | Interaction Management | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.symptomConditionEffect | Base | example | Undesirable Effect Symptom | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.classification | Base | example | Undesirable Effect Classification | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence | Base | example | Undesirabl Effect Frequency | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.warning.code | Base | example | Warning Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ClinicalUseDefinition |
C | 0..* | ClinicalUseDefinition | A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure Constraints: cud-1 |
| 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. Fixed Value: contraindication |
| contraindication |
ΣC | 1..1 | BackboneElement | Specifics for when this is a contraindication |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.type | Base | required | Clinical Use Definition Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from ClinicalUseDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | Specifics for when this is an indication | ||
| interaction |
0..0 | Specifics for when this is an interaction | ||
| undesirableEffect |
0..0 | A possible negative outcome from the use of this treatment | ||
| warning |
0..0 | Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness' | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ClinicalUseDefinition |
C | 0..* | ClinicalUseDefinition | A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure Constraints: cud-1 | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.type | Base | required | Clinical Use Definition Type | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.category | Base | preferred | Clinical Use Definition Category | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.status | Base | preferred | PublicationStatus | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseSymptomProcedure | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseStatus | Base | example | Disease Status | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.comorbidity | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.relationshipType | Base | preferred | Therapy Relationship Type | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.treatment | Base | example | Therapy | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseSymptomProcedure | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseStatus | Base | example | Disease Status | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.comorbidity | Base | example | Disease Symptom Procedure | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.indication.intendedEffect | Base | preferred | Product Intended Use | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.interactant.item[x] | Base | example | Interactant | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.type | Base | example | Interaction Type | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.effect | Base | example | Interaction Effect | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.incidence | Base | example | Interaction Incidence | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.management | Base | example | Interaction Management | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.symptomConditionEffect | Base | example | Undesirable Effect Symptom | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.classification | Base | example | Undesirable Effect Classification | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence | Base | example | Undesirabl Effect Frequency | 📍5.0.0 | FHIR Std. |
| ClinicalUseDefinition.warning.code | Base | example | Warning Type | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Orders and Observations. Package hl7.fhir.uv.order-catalog#1.0.0-ballot based on FHIR 5.0.0. Generated 2025-11-07
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change