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: WarningDefinition Profile

Defining URL:http://hl7.org/fhir/uv/order-catalog/StructureDefinition/WarningDefinition
Version:current
Name:WarningDefinition
Title:ClinicalUseDefinition as a warning
Status:Draft as of 2022-10-21 03:52:32+0000
Definition:

This profile constrains the base resource ClinicalUseDefinition to represent a warning 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/WarningDefinition

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: warning
... contraindication 0..0
... indication 0..0
... undesirableEffect 0..0
... warning 1..1BackboneElementCritical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C0..*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: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition.


Fixed Value: warning
... category Σ0..*CodeableConceptA 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)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
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... population Σ0..*Reference(Group)The population group to which this applies
... warning Σ1..1BackboneElementCritical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownA textual definition of this warning, with formatting
.... code Σ0..1CodeableConceptA coded or unformatted textual definition of this warning
Binding: WarningType (example): Classification of warning type.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C0..*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: warning
... contraindication 0..0
... indication 0..0
... undesirableEffect 0..0
... warning 1..1BackboneElementCritical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ClinicalUseDefinition C0..*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: ClinicalUseDefinitionType (required): Overall defining type of this clinical use definition.


Fixed Value: warning
... category Σ0..*CodeableConceptA 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)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
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... population Σ0..*Reference(Group)The population group to which this applies
... warning Σ1..1BackboneElementCritical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownA textual definition of this warning, with formatting
.... code Σ0..1CodeableConceptA coded or unformatted textual definition of this warning
Binding: WarningType (example): Classification of warning type.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ClinicalUseDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ClinicalUseDefinition.typerequiredFixed Value: warning
ClinicalUseDefinition.categorypreferredClinicalUseDefinitionCategory
ClinicalUseDefinition.statuspreferredPublicationStatus
ClinicalUseDefinition.contraindication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
ClinicalUseDefinition.contraindication.diseaseStatusexampleDiseaseStatus
ClinicalUseDefinition.contraindication.comorbidityexampleDiseaseSymptomProcedure
ClinicalUseDefinition.contraindication.otherTherapy.relationshipTypepreferredTherapyRelationshipType
ClinicalUseDefinition.contraindication.otherTherapy.treatmentexampleTherapy
ClinicalUseDefinition.indication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
ClinicalUseDefinition.indication.diseaseStatusexampleDiseaseStatus
ClinicalUseDefinition.indication.comorbidityexampleDiseaseSymptomProcedure
ClinicalUseDefinition.indication.intendedEffectpreferredProductIntendedUse
ClinicalUseDefinition.interaction.interactant.item[x]exampleInteractant
ClinicalUseDefinition.interaction.typeexampleInteractionType
ClinicalUseDefinition.interaction.effectexampleInteractionEffect
ClinicalUseDefinition.interaction.incidenceexampleInteractionIncidence
ClinicalUseDefinition.interaction.managementexampleInteractionManagement
ClinicalUseDefinition.undesirableEffect.symptomConditionEffectexampleUndesirableEffectSymptom
ClinicalUseDefinition.undesirableEffect.classificationexampleUndesirableEffectClassification
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrenceexampleUndesirablEffectFrequency
ClinicalUseDefinition.warning.codeexampleWarningType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()