[go: up one dir, main page]

Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

14.9 Resource ConditionDefinition - Content

Patient Care icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

A definition of a condition and information relevant to managing it.

A condition definition defines a set of system properties for a particular condition.

It is important to understand the condition definition resource is not intended to be used to define the underlying biological or ontological basis for the condition; instead the focus is on how the condition is identified, managed, and treated.

  • Conditions may have a matching condition definition, but need not do so
  • Condition definitions may identify observations and signs (including, but not limited to) lab tests that are indicative of the condition
  • Condition definitions often identify ongoing observations to prioritize when viewing the chart of patients with the conditions
  • Condition definitions may identify applicable care plans

One frequent criticism of information systems in healthcare is that they do not adapt well to changing context, particularly the context of what is specifically wrong. A typical institution will have 20-30,000 different kinds of observational data, but only a small portion of these are relevant to any particular condition. Information systems supporting clinical care provision are increasingly investigating the use of AI, but ConditionDefinition provides a simple way to help the system be more adaptive.

No references for this Resource.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConditionDefinition TUDomainResourceA definition of a condition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical identifier for this condition definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the condition definition

... version Σ0..1stringBusiness version of the condition definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this condition definition (computer friendly)
... title ΣT0..1stringName for this condition definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the condition definition
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for condition definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Condition/Problem/Diagnosis Codes (Example)
... severity Σ0..1CodeableConceptSubjective severity of condition
Binding: Condition/Diagnosis Severity (Preferred)
... bodySite Σ0..1CodeableConceptAnatomical location, if relevant
Binding: SNOMED CT Body Structures (Example)
... stage Σ0..1CodeableConceptStage/grade, usually assessed formally
Binding: Condition Stage (Example)
... hasSeverity 0..1booleanWhether Severity is appropriate
... hasBodySite 0..1booleanWhether bodySite is appropriate
... hasStage 0..1booleanWhether stage is appropriate
... definition 0..*uriFormal Definition for the condition

... observation 0..*BackboneElementObservations particularly relevant to this condition

.... category 0..1CodeableConceptCategory that is relevant
Binding: Observation Category Codes (Preferred)
.... code 0..1CodeableConceptCode for relevant Observation
Binding: LOINC Codes (Example)
... medication 0..*BackboneElementMedications particularly relevant for this condition

.... category 0..1CodeableConceptCategory that is relevant
Binding: Medication request category codes icon (Example)
.... code 0..1CodeableConceptCode for relevant Medication
Binding: SNOMED CT Medication Codes (Example)
... precondition 0..*BackboneElementObservation that suggets this condition

.... type 1..1codesensitive | specific
Binding: Condition Precondition Type (Required)
.... code 1..1CodeableConceptCode for relevant Observation
Binding: LOINC Codes (Example)
.... value[x] 0..1Value of Observation
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
... team 0..*Reference(CareTeam)Appropriate team for this condition

... questionnaire 0..*BackboneElementQuestionnaire for this condition

.... purpose 1..1codepreadmit | diff-diagnosis | outcome
Binding: Condition Questionnaire Purpose (Required)
.... reference 1..1Reference(Questionnaire)Specific Questionnaire
... plan 0..*BackboneElementPlan that is appropriate

.... role 0..1CodeableConceptUse for the plan
.... reference 1..1Reference(PlanDefinition)The actual plan

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ConditionDefinition (DomainResource) +MetadataResourceAn absolute URI that is used to identify this condition definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the condition definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the condition definitiontitle : string [0..1]An explanatory or alternate title for the event definition giving additional information about its contentsubtitle : string [0..1]The status of this condition definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the condition definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the condition definition changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the condition definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the condition definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate condition definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the condition definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Identification of the condition, problem or diagnosiscode : CodeableConcept [1..1] « null (Strength=Example)ConditionProblemDiagnosisCodes?? »A subjective assessment of the severity of the condition as evaluated by the clinicianseverity : CodeableConcept [0..1] « null (Strength=Preferred)ConditionDiagnosisSeverity? »The anatomical location where this condition manifests itselfbodySite : CodeableConcept [0..1] « Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMEDCTBodyStructures?? »Clinical stage or grade of a condition. May include formal severity assessmentsstage : CodeableConcept [0..1] « null (Strength=Example)ConditionStage?? »Whether Severity is appropriate to collect for this conditionhasSeverity : boolean [0..1]Whether bodySite is appropriate to collect for this conditionhasBodySite : boolean [0..1]Whether stage is appropriate to collect for this conditionhasStage : boolean [0..1]Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papersdefinition : uri [0..*]Appropriate team for this conditionteam : Reference [0..*] « CareTeam »ObservationCategory that is relevantcategory : CodeableConcept [0..1] « null (Strength=Preferred)ObservationCategoryCodes? »Code for relevant Observationcode : CodeableConcept [0..1] « null (Strength=Example)LOINCCodes?? »MedicationCategory that is relevantcategory : CodeableConcept [0..1] « null (Strength=Example)MedicationRequestCategoryCodes?? »Code for relevant Medicationcode : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTMedicationCodes?? »PreconditionKind of pre-conditiontype : code [1..1] « null (Strength=Required)ConditionPreconditionType! »Code for relevant Observationcode : CodeableConcept [1..1] « null (Strength=Example)LOINCCodes?? »Value of Observationvalue[x] : DataType [0..1] « CodeableConcept|Quantity »QuestionnaireUse of the questionnairepurpose : code [1..1] « null (Strength=Required)ConditionQuestionnairePurpose! »Specific Questionnairereference : Reference [1..1] « Questionnaire »PlanUse for the planrole : CodeableConcept [0..1]The actual planreference : Reference [1..1] « PlanDefinition »Observations particularly relevant to this conditionobservation[0..*]Medications particularly relevant for this conditionmedication[0..*]An observation that suggests that this condition appliesprecondition[0..*]Questionnaire for this conditionquestionnaire[0..*]Plan that is appropriateplan[0..*]

XML Template

<ConditionDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this condition definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the condition definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the condition definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this condition definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this condition definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the event definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the condition definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for condition definition (if applicable) --></jurisdiction>
 <code><!-- 1..1 CodeableConcept Identification of the condition, problem or diagnosis --></code>
 <severity><!-- 0..1 CodeableConcept Subjective severity of condition --></severity>
 <bodySite><!-- 0..1 CodeableConcept Anatomical location, if relevant --></bodySite>
 <stage><!-- 0..1 CodeableConcept Stage/grade, usually assessed formally --></stage>
 <hasSeverity value="[boolean]"/><!-- 0..1 Whether Severity is appropriate -->
 <hasBodySite value="[boolean]"/><!-- 0..1 Whether bodySite is appropriate -->
 <hasStage value="[boolean]"/><!-- 0..1 Whether stage is appropriate -->
 <definition value="[uri]"/><!-- 0..* Formal Definition for the condition -->
 <observation>  <!-- 0..* Observations particularly relevant to this condition -->
  <category><!-- 0..1 CodeableConcept Category that is relevant --></category>
  <code><!-- 0..1 CodeableConcept Code for relevant Observation --></code>
 </observation>
 <medication>  <!-- 0..* Medications particularly relevant for this condition -->
  <category><!-- 0..1 CodeableConcept Category that is relevant icon --></category>
  <code><!-- 0..1 CodeableConcept Code for relevant Medication --></code>
 </medication>
 <precondition>  <!-- 0..* Observation that suggets this condition -->
  <type value="[code]"/><!-- 1..1 sensitive | specific -->
  <code><!-- 1..1 CodeableConcept Code for relevant Observation --></code>
  <value[x]><!-- 0..1 CodeableConcept|Quantity Value of Observation --></value[x]>
 </precondition>
 <team><!-- 0..* Reference(CareTeam) Appropriate team for this condition --></team>
 <questionnaire>  <!-- 0..* Questionnaire for this condition -->
  <purpose value="[code]"/><!-- 1..1 preadmit | diff-diagnosis | outcome -->
  <reference><!-- 1..1 Reference(Questionnaire) Specific Questionnaire --></reference>
 </questionnaire>
 <plan>  <!-- 0..* Plan that is appropriate -->
  <role><!-- 0..1 CodeableConcept Use for the plan --></role>
  <reference><!-- 1..1 Reference(PlanDefinition) The actual plan --></reference>
 </plan>
</ConditionDefinition>

JSON Template

{doco
  "resourceType" : "ConditionDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this condition definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the condition definition
  "version" : "<string>", // Business version of the condition definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this condition definition (computer friendly)
  "title" : "<string>", // Name for this condition definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the event definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the condition definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for condition definition (if applicable)
  "code" : { CodeableConcept }, // R!  Identification of the condition, problem or diagnosis
  "severity" : { CodeableConcept }, // Subjective severity of condition
  "bodySite" : { CodeableConcept }, // Anatomical location, if relevant
  "stage" : { CodeableConcept }, // Stage/grade, usually assessed formally
  "hasSeverity" : <boolean>, // Whether Severity is appropriate
  "hasBodySite" : <boolean>, // Whether bodySite is appropriate
  "hasStage" : <boolean>, // Whether stage is appropriate
  "definition" : ["<uri>"], // Formal Definition for the condition
  "observation" : [{ // Observations particularly relevant to this condition
    "category" : { CodeableConcept }, // Category that is relevant
    "code" : { CodeableConcept } // Code for relevant Observation
  }],
  "medication" : [{ // Medications particularly relevant for this condition
    "category" : { CodeableConcept }, // Category that is relevant icon
    "code" : { CodeableConcept } // Code for relevant Medication
  }],
  "precondition" : [{ // Observation that suggets this condition
    "type" : "<code>", // R!  sensitive | specific
    "code" : { CodeableConcept }, // R!  Code for relevant Observation
    // value[x]: Value of Observation. One of these 2:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity }
  }],
  "team" : [{ Reference(CareTeam) }], // Appropriate team for this condition
  "questionnaire" : [{ // Questionnaire for this condition
    "purpose" : "<code>", // R!  preadmit | diff-diagnosis | outcome
    "reference" : { Reference(Questionnaire) } // R!  Specific Questionnaire
  }],
  "plan" : [{ // Plan that is appropriate
    "role" : { CodeableConcept }, // Use for the plan
    "reference" : { Reference(PlanDefinition) } // R!  The actual plan
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ConditionDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this condition definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the condition definition
  fhir:version [ string ] ; # 0..1 Business version of the condition definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this condition definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this condition definition (human friendly)
  fhir:subtitle [ string ] ; # 0..1 Subordinate title of the event definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the condition definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for condition definition (if applicable)
  fhir:code [ CodeableConcept ] ; # 1..1 Identification of the condition, problem or diagnosis
  fhir:severity [ CodeableConcept ] ; # 0..1 Subjective severity of condition
  fhir:bodySite [ CodeableConcept ] ; # 0..1 Anatomical location, if relevant
  fhir:stage [ CodeableConcept ] ; # 0..1 Stage/grade, usually assessed formally
  fhir:hasSeverity [ boolean ] ; # 0..1 Whether Severity is appropriate
  fhir:hasBodySite [ boolean ] ; # 0..1 Whether bodySite is appropriate
  fhir:hasStage [ boolean ] ; # 0..1 Whether stage is appropriate
  fhir:definition  ( [ uri ] ... ) ; # 0..* Formal Definition for the condition
  fhir:observation ( [ # 0..* Observations particularly relevant to this condition
    fhir:category [ CodeableConcept ] ; # 0..1 Category that is relevant
    fhir:code [ CodeableConcept ] ; # 0..1 Code for relevant Observation
  ] ... ) ;
  fhir:medication ( [ # 0..* Medications particularly relevant for this condition
    fhir:category [ CodeableConcept ] ; # 0..1 Category that is relevant
    fhir:code [ CodeableConcept ] ; # 0..1 Code for relevant Medication
  ] ... ) ;
  fhir:precondition ( [ # 0..* Observation that suggets this condition
    fhir:type [ code ] ; # 1..1 sensitive | specific
    fhir:code [ CodeableConcept ] ; # 1..1 Code for relevant Observation
    # value[x] : 0..1 Value of Observation. One of these 2
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
  ] ... ) ;
  fhir:team  ( [ Reference(CareTeam) ] ... ) ; # 0..* Appropriate team for this condition
  fhir:questionnaire ( [ # 0..* Questionnaire for this condition
    fhir:purpose [ code ] ; # 1..1 preadmit | diff-diagnosis | outcome
    fhir:reference [ Reference(Questionnaire) ] ; # 1..1 Specific Questionnaire
  ] ... ) ;
  fhir:plan ( [ # 0..* Plan that is appropriate
    fhir:role [ CodeableConcept ] ; # 0..1 Use for the plan
    fhir:reference [ Reference(PlanDefinition) ] ; # 1..1 The actual plan
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConditionDefinition TUDomainResourceA definition of a condition
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
Interfaces Implemented: MetadataResource
... url ΣC0..1uriCanonical identifier for this condition definition, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier Σ0..*IdentifierAdditional identifier for the condition definition

... version Σ0..1stringBusiness version of the condition definition
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this condition definition (computer friendly)
... title ΣT0..1stringName for this condition definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description T0..1markdownNatural language description of the condition definition
... useContext Σ0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for condition definition (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Binding: Condition/Problem/Diagnosis Codes (Example)
... severity Σ0..1CodeableConceptSubjective severity of condition
Binding: Condition/Diagnosis Severity (Preferred)
... bodySite Σ0..1CodeableConceptAnatomical location, if relevant
Binding: SNOMED CT Body Structures (Example)
... stage Σ0..1CodeableConceptStage/grade, usually assessed formally
Binding: Condition Stage (Example)
... hasSeverity 0..1booleanWhether Severity is appropriate
... hasBodySite 0..1booleanWhether bodySite is appropriate
... hasStage 0..1booleanWhether stage is appropriate
... definition 0..*uriFormal Definition for the condition

... observation 0..*BackboneElementObservations particularly relevant to this condition

.... category 0..1CodeableConceptCategory that is relevant
Binding: Observation Category Codes (Preferred)
.... code 0..1CodeableConceptCode for relevant Observation
Binding: LOINC Codes (Example)
... medication 0..*BackboneElementMedications particularly relevant for this condition

.... category 0..1CodeableConceptCategory that is relevant
Binding: Medication request category codes icon (Example)
.... code 0..1CodeableConceptCode for relevant Medication
Binding: SNOMED CT Medication Codes (Example)
... precondition 0..*BackboneElementObservation that suggets this condition

.... type 1..1codesensitive | specific
Binding: Condition Precondition Type (Required)
.... code 1..1CodeableConceptCode for relevant Observation
Binding: LOINC Codes (Example)
.... value[x] 0..1Value of Observation
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
... team 0..*Reference(CareTeam)Appropriate team for this condition

... questionnaire 0..*BackboneElementQuestionnaire for this condition

.... purpose 1..1codepreadmit | diff-diagnosis | outcome
Binding: Condition Questionnaire Purpose (Required)
.... reference 1..1Reference(Questionnaire)Specific Questionnaire
... plan 0..*BackboneElementPlan that is appropriate

.... role 0..1CodeableConceptUse for the plan
.... reference 1..1Reference(PlanDefinition)The actual plan

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

ConditionDefinition (DomainResource) +MetadataResourceAn absolute URI that is used to identify this condition definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this condition definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the condition definition is stored on different serversurl : uri [0..1]A formal identifier that is used to identify this condition definition when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the condition definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the condition definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »A natural language name identifying the condition definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1] « This element has or is affected by some invariantsC »A short, descriptive, user-friendly title for the condition definitiontitle : string [0..1]An explanatory or alternate title for the event definition giving additional information about its contentsubtitle : string [0..1]The status of this condition definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this condition definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the condition definition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the condition definition changesdate : dateTime [0..1]The name of the organization or individual responsible for the release and ongoing maintenance of the condition definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the condition definition from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate condition definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the condition definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)JurisdictionValueSet+ »Identification of the condition, problem or diagnosiscode : CodeableConcept [1..1] « null (Strength=Example)ConditionProblemDiagnosisCodes?? »A subjective assessment of the severity of the condition as evaluated by the clinicianseverity : CodeableConcept [0..1] « null (Strength=Preferred)ConditionDiagnosisSeverity? »The anatomical location where this condition manifests itselfbodySite : CodeableConcept [0..1] « Codes describing anatomical locations. May include laterality. (Strength=Example)SNOMEDCTBodyStructures?? »Clinical stage or grade of a condition. May include formal severity assessmentsstage : CodeableConcept [0..1] « null (Strength=Example)ConditionStage?? »Whether Severity is appropriate to collect for this conditionhasSeverity : boolean [0..1]Whether bodySite is appropriate to collect for this conditionhasBodySite : boolean [0..1]Whether stage is appropriate to collect for this conditionhasStage : boolean [0..1]Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papersdefinition : uri [0..*]Appropriate team for this conditionteam : Reference [0..*] « CareTeam »ObservationCategory that is relevantcategory : CodeableConcept [0..1] « null (Strength=Preferred)ObservationCategoryCodes? »Code for relevant Observationcode : CodeableConcept [0..1] « null (Strength=Example)LOINCCodes?? »MedicationCategory that is relevantcategory : CodeableConcept [0..1] « null (Strength=Example)MedicationRequestCategoryCodes?? »Code for relevant Medicationcode : CodeableConcept [0..1] « null (Strength=Example)SNOMEDCTMedicationCodes?? »PreconditionKind of pre-conditiontype : code [1..1] « null (Strength=Required)ConditionPreconditionType! »Code for relevant Observationcode : CodeableConcept [1..1] « null (Strength=Example)LOINCCodes?? »Value of Observationvalue[x] : DataType [0..1] « CodeableConcept|Quantity »QuestionnaireUse of the questionnairepurpose : code [1..1] « null (Strength=Required)ConditionQuestionnairePurpose! »Specific Questionnairereference : Reference [1..1] « Questionnaire »PlanUse for the planrole : CodeableConcept [0..1]The actual planreference : Reference [1..1] « PlanDefinition »Observations particularly relevant to this conditionobservation[0..*]Medications particularly relevant for this conditionmedication[0..*]An observation that suggests that this condition appliesprecondition[0..*]Questionnaire for this conditionquestionnaire[0..*]Plan that is appropriateplan[0..*]

XML Template

<ConditionDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this condition definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the condition definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the condition definition -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this condition definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this condition definition (human friendly) -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the event definition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the condition definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for condition definition (if applicable) --></jurisdiction>
 <code><!-- 1..1 CodeableConcept Identification of the condition, problem or diagnosis --></code>
 <severity><!-- 0..1 CodeableConcept Subjective severity of condition --></severity>
 <bodySite><!-- 0..1 CodeableConcept Anatomical location, if relevant --></bodySite>
 <stage><!-- 0..1 CodeableConcept Stage/grade, usually assessed formally --></stage>
 <hasSeverity value="[boolean]"/><!-- 0..1 Whether Severity is appropriate -->
 <hasBodySite value="[boolean]"/><!-- 0..1 Whether bodySite is appropriate -->
 <hasStage value="[boolean]"/><!-- 0..1 Whether stage is appropriate -->
 <definition value="[uri]"/><!-- 0..* Formal Definition for the condition -->
 <observation>  <!-- 0..* Observations particularly relevant to this condition -->
  <category><!-- 0..1 CodeableConcept Category that is relevant --></category>
  <code><!-- 0..1 CodeableConcept Code for relevant Observation --></code>
 </observation>
 <medication>  <!-- 0..* Medications particularly relevant for this condition -->
  <category><!-- 0..1 CodeableConcept Category that is relevant icon --></category>
  <code><!-- 0..1 CodeableConcept Code for relevant Medication --></code>
 </medication>
 <precondition>  <!-- 0..* Observation that suggets this condition -->
  <type value="[code]"/><!-- 1..1 sensitive | specific -->
  <code><!-- 1..1 CodeableConcept Code for relevant Observation --></code>
  <value[x]><!-- 0..1 CodeableConcept|Quantity Value of Observation --></value[x]>
 </precondition>
 <team><!-- 0..* Reference(CareTeam) Appropriate team for this condition --></team>
 <questionnaire>  <!-- 0..* Questionnaire for this condition -->
  <purpose value="[code]"/><!-- 1..1 preadmit | diff-diagnosis | outcome -->
  <reference><!-- 1..1 Reference(Questionnaire) Specific Questionnaire --></reference>
 </questionnaire>
 <plan>  <!-- 0..* Plan that is appropriate -->
  <role><!-- 0..1 CodeableConcept Use for the plan --></role>
  <reference><!-- 1..1 Reference(PlanDefinition) The actual plan --></reference>
 </plan>
</ConditionDefinition>

JSON Template

{doco
  "resourceType" : "ConditionDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this condition definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the condition definition
  "version" : "<string>", // Business version of the condition definition
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this condition definition (computer friendly)
  "title" : "<string>", // Name for this condition definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the event definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the condition definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for condition definition (if applicable)
  "code" : { CodeableConcept }, // R!  Identification of the condition, problem or diagnosis
  "severity" : { CodeableConcept }, // Subjective severity of condition
  "bodySite" : { CodeableConcept }, // Anatomical location, if relevant
  "stage" : { CodeableConcept }, // Stage/grade, usually assessed formally
  "hasSeverity" : <boolean>, // Whether Severity is appropriate
  "hasBodySite" : <boolean>, // Whether bodySite is appropriate
  "hasStage" : <boolean>, // Whether stage is appropriate
  "definition" : ["<uri>"], // Formal Definition for the condition
  "observation" : [{ // Observations particularly relevant to this condition
    "category" : { CodeableConcept }, // Category that is relevant
    "code" : { CodeableConcept } // Code for relevant Observation
  }],
  "medication" : [{ // Medications particularly relevant for this condition
    "category" : { CodeableConcept }, // Category that is relevant icon
    "code" : { CodeableConcept } // Code for relevant Medication
  }],
  "precondition" : [{ // Observation that suggets this condition
    "type" : "<code>", // R!  sensitive | specific
    "code" : { CodeableConcept }, // R!  Code for relevant Observation
    // value[x]: Value of Observation. One of these 2:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity }
  }],
  "team" : [{ Reference(CareTeam) }], // Appropriate team for this condition
  "questionnaire" : [{ // Questionnaire for this condition
    "purpose" : "<code>", // R!  preadmit | diff-diagnosis | outcome
    "reference" : { Reference(Questionnaire) } // R!  Specific Questionnaire
  }],
  "plan" : [{ // Plan that is appropriate
    "role" : { CodeableConcept }, // Use for the plan
    "reference" : { Reference(PlanDefinition) } // R!  The actual plan
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ConditionDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this condition definition, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the condition definition
  fhir:version [ string ] ; # 0..1 Business version of the condition definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this condition definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this condition definition (human friendly)
  fhir:subtitle [ string ] ; # 0..1 Subordinate title of the event definition
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the condition definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for condition definition (if applicable)
  fhir:code [ CodeableConcept ] ; # 1..1 Identification of the condition, problem or diagnosis
  fhir:severity [ CodeableConcept ] ; # 0..1 Subjective severity of condition
  fhir:bodySite [ CodeableConcept ] ; # 0..1 Anatomical location, if relevant
  fhir:stage [ CodeableConcept ] ; # 0..1 Stage/grade, usually assessed formally
  fhir:hasSeverity [ boolean ] ; # 0..1 Whether Severity is appropriate
  fhir:hasBodySite [ boolean ] ; # 0..1 Whether bodySite is appropriate
  fhir:hasStage [ boolean ] ; # 0..1 Whether stage is appropriate
  fhir:definition  ( [ uri ] ... ) ; # 0..* Formal Definition for the condition
  fhir:observation ( [ # 0..* Observations particularly relevant to this condition
    fhir:category [ CodeableConcept ] ; # 0..1 Category that is relevant
    fhir:code [ CodeableConcept ] ; # 0..1 Code for relevant Observation
  ] ... ) ;
  fhir:medication ( [ # 0..* Medications particularly relevant for this condition
    fhir:category [ CodeableConcept ] ; # 0..1 Category that is relevant
    fhir:code [ CodeableConcept ] ; # 0..1 Code for relevant Medication
  ] ... ) ;
  fhir:precondition ( [ # 0..* Observation that suggets this condition
    fhir:type [ code ] ; # 1..1 sensitive | specific
    fhir:code [ CodeableConcept ] ; # 1..1 Code for relevant Observation
    # value[x] : 0..1 Value of Observation. One of these 2
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
  ] ... ) ;
  fhir:team  ( [ Reference(CareTeam) ] ... ) ; # 0..* Appropriate team for this condition
  fhir:questionnaire ( [ # 0..* Questionnaire for this condition
    fhir:purpose [ code ] ; # 1..1 preadmit | diff-diagnosis | outcome
    fhir:reference [ Reference(Questionnaire) ] ; # 1..1 Specific Questionnaire
  ] ... ) ;
  fhir:plan ( [ # 0..* Plan that is appropriate
    fhir:role [ CodeableConcept ] ; # 0..1 Use for the plan
    fhir:reference [ Reference(PlanDefinition) ] ; # 1..1 The actual plan
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

PathValueSetTypeDocumentation
ConditionDefinition.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.

ConditionDefinition.status PublicationStatus Required

The lifecycle status of an artifact.

ConditionDefinition.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.

ConditionDefinition.code ConditionProblemDiagnosisCodes Example

Example value set for Condition/Problem/Diagnosis codes.

ConditionDefinition.severity ConditionDiagnosisSeverity Preferred

Preferred value set for Condition/Diagnosis severity grading.

ConditionDefinition.bodySite SNOMEDCTBodyStructures Example

This value set includes all codes from SNOMED CT icon where concept is-a 442083009 (Anatomical or acquired body site (body structure)).

ConditionDefinition.stage ConditionStage Example

Value set for stages of cancer and other conditions.

ConditionDefinition.observation.category ObservationCategoryCodes Preferred

Observation Category codes.

ConditionDefinition.observation.code LOINCCodes (a valid code from LOINC icon)Example

This value set includes all LOINC codes

ConditionDefinition.medication.category MedicationRequestCategoryCodes icon Example

MedicationRequest Category Codes

ConditionDefinition.medication.code SNOMEDCTMedicationCodes Example

This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set.

ConditionDefinition.precondition.type ConditionPreconditionType Required

Kind of precondition for the condition.

ConditionDefinition.precondition.code LOINCCodes (a valid code from LOINC icon)Example

This value set includes all LOINC codes

ConditionDefinition.questionnaire.purpose ConditionQuestionnairePurpose Required

The use of a questionnaire.

UniqueKeyLevelLocationDescriptionExpression
img cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
img cnl-1Warning ConditionDefinition.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the condition definition(ConditionDefinition.useContext.value.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the condition definition(ConditionDefinition.useContext.value.ofType(Quantity)) | (ConditionDefinition.useContext.value.ofType(Range))30 Resources
context-typetokenA type of use context assigned to the condition definitionConditionDefinition.useContext.code30 Resources
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the condition definitionOn ConditionDefinition.useContext:
  context-type: code
  context-quantity: value.ofType(Quantity) | value.ofType(Range)
30 Resources
context-type-valuecompositeA use context type and value assigned to the condition definitionOn ConditionDefinition.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)
30 Resources
datedateThe condition definition publication dateConditionDefinition.date30 Resources
descriptionstringThe description of the condition definitionConditionDefinition.description28 Resources
identifiertokenExternal identifier for the condition definitionConditionDefinition.identifier34 Resources
jurisdictiontokenIntended jurisdiction for the condition definitionConditionDefinition.jurisdiction26 Resources
namestringComputationally friendly name of the condition definitionConditionDefinition.name26 Resources
publisherstringName of the publisher of the condition definitionConditionDefinition.publisher30 Resources
statustokenThe current status of the condition definitionConditionDefinition.status35 Resources
titlestringThe human-friendly name of the condition definitionConditionDefinition.title27 Resources
urluriThe uri that identifies the condition definitionConditionDefinition.url34 Resources
versiontokenThe business version of the condition definitionConditionDefinition.version30 Resources