Order Catalog Implementation Guide
1.0.0-ballot - CI Build International flag

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

Resource Profile: WarningDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/WarningDefinition Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: WarningDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.28

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

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from ClinicalUseDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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: warning
... contraindication 0..0
... indication 0..0
... undesirableEffect 0..0
... warning 1..1 BackboneElement Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... warning ΣC 1..1 BackboneElement Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.typerequiredFixed Value: warning
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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: warning
... 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.
... population Σ 0..* Reference(Group) The population group to which this applies
... library Σ 0..* canonical(Library) Logic used by the clinical use definition
... warning ΣC 1..1 BackboneElement Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
.... 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
.... description Σ 0..1 markdown A textual definition of this warning, with formatting
.... code Σ 0..1 CodeableConcept A coded or unformatted textual definition of this warning
Binding: WarningType (example): Classification of warning type.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ClinicalUseDefinition.typerequiredFixed Value: warning
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
From the FHIR Standard
ClinicalUseDefinition.categorypreferredClinicalUseDefinitionCategory
http://hl7.org/fhir/ValueSet/clinical-use-definition-category
From the FHIR Standard
ClinicalUseDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
From the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
From the FHIR Standard
ClinicalUseDefinition.contraindication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.relationshipTypepreferredTherapyRelationshipType
http://hl7.org/fhir/ValueSet/therapy-relationship-type
From the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.treatmentexampleTherapy
http://hl7.org/fhir/ValueSet/therapy
From the FHIR Standard
ClinicalUseDefinition.indication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.indication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
From the FHIR Standard
ClinicalUseDefinition.indication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.indication.intendedEffectpreferredProductIntendedUse
http://hl7.org/fhir/ValueSet/product-intended-use
From the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]exampleInteractant
http://hl7.org/fhir/ValueSet/interactant
From the FHIR Standard
ClinicalUseDefinition.interaction.typeexampleInteractionType
http://hl7.org/fhir/ValueSet/interaction-type
From the FHIR Standard
ClinicalUseDefinition.interaction.effectexampleInteractionEffect
http://hl7.org/fhir/ValueSet/interaction-effect
From the FHIR Standard
ClinicalUseDefinition.interaction.incidenceexampleInteractionIncidence
http://hl7.org/fhir/ValueSet/interaction-incidence
From the FHIR Standard
ClinicalUseDefinition.interaction.managementexampleInteractionManagement
http://hl7.org/fhir/ValueSet/interaction-management
From the FHIR Standard
ClinicalUseDefinition.undesirableEffect.symptomConditionEffectexampleUndesirableEffectSymptom
http://hl7.org/fhir/ValueSet/undesirable-effect-symptom
From the FHIR Standard
ClinicalUseDefinition.undesirableEffect.classificationexampleUndesirableEffectClassification
http://hl7.org/fhir/ValueSet/undesirable-effect-classification
From the FHIR Standard
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrenceexampleUndesirablEffectFrequency
http://hl7.org/fhir/ValueSet/undesirable-effect-frequency
From the FHIR Standard
ClinicalUseDefinition.warning.codeexampleWarningType
http://hl7.org/fhir/ValueSet/warning-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-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()

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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: warning
... contraindication 0..0
... indication 0..0
... undesirableEffect 0..0
... warning 1..1 BackboneElement Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... warning ΣC 1..1 BackboneElement Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.typerequiredFixed Value: warning
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... 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: warning
... 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.
... population Σ 0..* Reference(Group) The population group to which this applies
... library Σ 0..* canonical(Library) Logic used by the clinical use definition
... warning ΣC 1..1 BackboneElement Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
.... 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
.... description Σ 0..1 markdown A textual definition of this warning, with formatting
.... code Σ 0..1 CodeableConcept A coded or unformatted textual definition of this warning
Binding: WarningType (example): Classification of warning type.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ClinicalUseDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ClinicalUseDefinition.typerequiredFixed Value: warning
http://hl7.org/fhir/ValueSet/clinical-use-definition-type|5.0.0
From the FHIR Standard
ClinicalUseDefinition.categorypreferredClinicalUseDefinitionCategory
http://hl7.org/fhir/ValueSet/clinical-use-definition-category
From the FHIR Standard
ClinicalUseDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
From the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.contraindication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
From the FHIR Standard
ClinicalUseDefinition.contraindication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.relationshipTypepreferredTherapyRelationshipType
http://hl7.org/fhir/ValueSet/therapy-relationship-type
From the FHIR Standard
ClinicalUseDefinition.contraindication.otherTherapy.treatmentexampleTherapy
http://hl7.org/fhir/ValueSet/therapy
From the FHIR Standard
ClinicalUseDefinition.indication.diseaseSymptomProcedureexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.indication.diseaseStatusexampleDiseaseStatus
http://hl7.org/fhir/ValueSet/disease-status
From the FHIR Standard
ClinicalUseDefinition.indication.comorbidityexampleDiseaseSymptomProcedure
http://hl7.org/fhir/ValueSet/disease-symptom-procedure
From the FHIR Standard
ClinicalUseDefinition.indication.intendedEffectpreferredProductIntendedUse
http://hl7.org/fhir/ValueSet/product-intended-use
From the FHIR Standard
ClinicalUseDefinition.interaction.interactant.item[x]exampleInteractant
http://hl7.org/fhir/ValueSet/interactant
From the FHIR Standard
ClinicalUseDefinition.interaction.typeexampleInteractionType
http://hl7.org/fhir/ValueSet/interaction-type
From the FHIR Standard
ClinicalUseDefinition.interaction.effectexampleInteractionEffect
http://hl7.org/fhir/ValueSet/interaction-effect
From the FHIR Standard
ClinicalUseDefinition.interaction.incidenceexampleInteractionIncidence
http://hl7.org/fhir/ValueSet/interaction-incidence
From the FHIR Standard
ClinicalUseDefinition.interaction.managementexampleInteractionManagement
http://hl7.org/fhir/ValueSet/interaction-management
From the FHIR Standard
ClinicalUseDefinition.undesirableEffect.symptomConditionEffectexampleUndesirableEffectSymptom
http://hl7.org/fhir/ValueSet/undesirable-effect-symptom
From the FHIR Standard
ClinicalUseDefinition.undesirableEffect.classificationexampleUndesirableEffectClassification
http://hl7.org/fhir/ValueSet/undesirable-effect-classification
From the FHIR Standard
ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrenceexampleUndesirablEffectFrequency
http://hl7.org/fhir/ValueSet/undesirable-effect-frequency
From the FHIR Standard
ClinicalUseDefinition.warning.codeexampleWarningType
http://hl7.org/fhir/ValueSet/warning-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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().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-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-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()

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