HL7 FHIR Implementation Guide - New Zealand Formulary/NZULM IG, published by New Zealand Medicines Formulary LP. 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/HL7NZ/nzf/ and changes regularly. See the Directory of published versions
Resource Profile: Interaction Clincial Use Definition resource for NZ Formulary
| Official URL: http://hl7.org.nz/fhir/StructureDefinition/nzf-interaction-clinical-use-definition | Version: 1.0.0 | |||
| Active as of 2025-11-10 | Computable Name: NzfInteractionClinicalUseDefinition | |||
Interaction Clincial Use Definition resource for NZ Formulary
Usages:
- This Profile is not used by any profiles in this Implementation Guide
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.type | Base | required | ClinicalUseDefinitionType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.interactant.item[x] | Base | example | Interactant | 📍4.3.0 | FHIR Std. |
Constraints
| 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.exists() and ('#'+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(uri) = '#').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
Slices for extension| 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: CommonLanguages (preferred): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
 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. | ||||
  subject |
Σ | 1..1 | Reference(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance) | The medication or procedure for which this is an indication | ||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
  extension:route |
1..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
 display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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. | ||||
| interaction |
Σ | 1..1 | BackboneElement | Specifics for when this is an interaction | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 extension:severity |
1..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-severity-code Binding: https://pharmaceuticalpress.com/ns/stockleys-interaction-severity-code/vs (required) | |||||
| extension:warning |
1..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-warning-code Binding: https://pharmaceuticalpress.com/ns/stockleys-interaction-warning-code/vs (required) | |||||
| extension:evidence |
1..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-evidence-code Binding: https://pharmaceuticalpress.com/ns/stockleys-interaction-evidence-code/vs (required) | |||||
| extension:modificationDate |
1..1 | date | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-modification-date | |||||
| extension:reviewDate |
1..1 | date | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-review-date | |||||
| extension:textLink |
1..1 | string | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-text-link | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| interactant |
Σ | 1..1 | BackboneElement | The specific medication, food, substance or laboratory test that interacts | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:route |
1..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
  item[x] |
Σ | 1..1 | The specific medication, food or laboratory test that interacts Binding: Interactant (example): An interactant - a substance that may have an clinically significant effect on another. | |||||
 itemReference |
Reference(MedicinalProductDefinition | Medication | Substance | ObservationDefinition) | |||||||
| itemCodeableConcept |
CodeableConcept | |||||||
| 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. | ||||
| 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 | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.type | Base | required | ClinicalUseDefinitionType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseSymptomProcedure | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseStatus | Base | example | DiseaseStatus | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.comorbidity | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.relationshipType | Base | preferred | TherapyRelationshipType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.therapy | Base | example | Therapy | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseSymptomProcedure | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseStatus | Base | example | DiseaseStatus | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.comorbidity | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.intendedEffect | Base | preferred | ProductIntendedUse | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.interactant.item[x] | Base | example | Interactant | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.effect | Base | example | InteractionEffect | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.management | Base | example | InteractionManagement | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.symptomConditionEffect | Base | example | UndesirableEffectSymptom | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.classification | Base | example | UndesirableEffectClassification | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence | Base | example | UndesirablEffectFrequency | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.warning.code | Base | example | WarningType | 📍4.3.0 | FHIR Std. |
Constraints
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | ClinicalUseDefinition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ClinicalUseDefinition
Summary
Mandatory: 13 elements
Prohibited: 7 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-severity-code
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-warning-code
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-evidence-code
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-modification-date
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-review-date
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-text-link
Key Elements View
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.type | Base | required | ClinicalUseDefinitionType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.interactant.item[x] | Base | example | Interactant | 📍4.3.0 | FHIR Std. |
Constraints
| 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.exists() and ('#'+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(uri) = '#').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
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: CommonLanguages (preferred): IETF language tag
| |||||
| 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 Constraints: dom-r4b | |||||
| 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. | ||||
| subject |
Σ | 1..1 | Reference(MedicinalProductDefinition | Medication | ActivityDefinition | PlanDefinition | Device | DeviceDefinition | Substance) | The medication or procedure for which this is an indication | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:route |
1..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| 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. | ||||
| interaction |
Σ | 1..1 | BackboneElement | Specifics for when this is an interaction | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
6..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:severity |
1..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-severity-code Binding: https://pharmaceuticalpress.com/ns/stockleys-interaction-severity-code/vs (required) | |||||
| extension:warning |
1..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-warning-code Binding: https://pharmaceuticalpress.com/ns/stockleys-interaction-warning-code/vs (required) | |||||
| extension:evidence |
1..1 | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-evidence-code Binding: https://pharmaceuticalpress.com/ns/stockleys-interaction-evidence-code/vs (required) | |||||
| extension:modificationDate |
1..1 | date | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-modification-date | |||||
| extension:reviewDate |
1..1 | date | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-review-date | |||||
| extension:textLink |
1..1 | string | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-text-link | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| interactant |
Σ | 1..1 | BackboneElement | The specific medication, food, substance or laboratory test that interacts | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:route |
1..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| item[x] |
Σ | 1..1 | The specific medication, food or laboratory test that interacts Binding: Interactant (example): An interactant - a substance that may have an clinically significant effect on another. | |||||
| itemReference |
Reference(MedicinalProductDefinition | Medication | Substance | ObservationDefinition) | |||||||
| itemCodeableConcept |
CodeableConcept | |||||||
| 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. | ||||
| 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 | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| ClinicalUseDefinition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.type | Base | required | ClinicalUseDefinitionType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.status | Base | preferred | PublicationStatus | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseSymptomProcedure | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.diseaseStatus | Base | example | DiseaseStatus | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.comorbidity | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.relationshipType | Base | preferred | TherapyRelationshipType | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.contraindication.otherTherapy.therapy | Base | example | Therapy | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseSymptomProcedure | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.diseaseStatus | Base | example | DiseaseStatus | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.comorbidity | Base | example | DiseaseSymptomProcedure | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.indication.intendedEffect | Base | preferred | ProductIntendedUse | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.interactant.item[x] | Base | example | Interactant | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.effect | Base | example | InteractionEffect | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.interaction.management | Base | example | InteractionManagement | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.symptomConditionEffect | Base | example | UndesirableEffectSymptom | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.classification | Base | example | UndesirableEffectClassification | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence | Base | example | UndesirablEffectFrequency | 📍4.3.0 | FHIR Std. |
| ClinicalUseDefinition.warning.code | Base | example | WarningType | 📍4.3.0 | FHIR Std. |
Constraints
| 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.exists() and ('#'+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(uri) = '#').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()
|
| dom-r4b | warning | ClinicalUseDefinition.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from ClinicalUseDefinition
Summary
Mandatory: 13 elements
Prohibited: 7 elements
Extensions
This structure refers to these extensions:
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-route
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-severity-code
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-warning-code
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-evidence-code
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-modification-date
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-review-date
- http://hl7.org.nz/fhir/StructureDefinition/stockleys-interaction-text-link
Other representations of profile: CSV, Excel, Schematron