Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.8 Resource ConditionDefinition - Content

Patient Care Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

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

14.8.1 Scope and Usage

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 the condition is identified, managed, and treated.

14.8.2 Boundaries and Relationships

  • 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

14.8.3 Background and Context

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.

14.8.4 References

No resources refer to this resource directly.

This resource does not implement any patterns.

14.8.5 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConditionDefinition TUMetadataResourceA 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, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this condition definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the condition definition
... version Σ0..1stringBusiness version of the condition definition
... name ΣI0..1stringName for this condition definition (computer friendly)
... title Σ0..1stringName for this condition definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the condition definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for condition definition (if applicable)
Jurisdiction (Extensible)
... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Condition/Problem/Diagnosis Codes (Example)
... severity Σ0..1CodeableConceptSubjective severity of condition
Condition/Diagnosis Severity (Preferred)
... bodySite Σ0..1CodeableConceptAnatomical location, if relevant
SNOMED CT Body Structures (Example)
... stage Σ0..1CodeableConceptStage/grade, usually assessed formally
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
Observation Category Codes (Preferred)
.... code 0..1CodeableConceptCode for relevant Observation
LOINC Codes (Example)
... medication 0..*BackboneElementMedications particularly relevant for this condition
.... category 0..1CodeableConceptCategory that is relevant
Medication request category codes (Example)
.... code 0..1CodeableConceptCode for relevant Medication
SNOMED CT Medication Codes (Example)
... precondition 0..*BackboneElementObservation that suggets this condition
.... type 1..1codesensitive | specific
ConditionPreconditionType (Required)
.... code 1..1CodeableConceptCode for relevant Observation
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
ConditionQuestionnairePurpose (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

UML Diagram (Legend)

ConditionDefinition (MetadataResource)An 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 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]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]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] « The lifecycle status of an artifact. (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 published. 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 that published 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..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Identification of the condition, problem or diagnosiscode : CodeableConcept [1..1] « Identification of the condition or diagnosis. (Strength=Example)Condition/Problem/DiagnosisCo...?? »A subjective assessment of the severity of the condition as evaluated by the clinicianseverity : CodeableConcept [0..1] « A subjective assessment of the severity of the condition as evaluated by the clinician. (Strength=Preferred)Condition/DiagnosisSeverity? »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] « Codes describing condition stages (e.g. Cancer stages). (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] « Codes for high level observation categories. (Strength=Preferred)ObservationCategoryCodes? »Code for relevant Observationcode : CodeableConcept [0..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »MedicationCategory that is relevantcategory : CodeableConcept [0..1] « A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. (Strength=Example)medicationRequest Category ?? »Code for relevant Medicationcode : CodeableConcept [0..1] « A coded concept identifying substance or product that can be ordered. (Strength=Example)SNOMEDCTMedicationCodes?? »PreconditionKind of pre-conditiontype : code [1..1] « Kind of precondition for the condition. (Strength=Required)ConditionPreconditionType! »Code for relevant Observationcode : CodeableConcept [1..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »Value of Observationvalue[x] : DataType [0..1] « CodeableConcept|Quantity »QuestionnaireUse of the questionnairepurpose : code [1..1] « The use of a questionnaire. (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 -->
 <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 -->
 <name value="[string]"/><!-- ?? 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 (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 --></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
  "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
  "name" : "<string>", // C? 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 (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
    "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
  fhir:ConditionDefinition.url [ uri ]; # 0..1 Canonical identifier for this condition definition, represented as a URI (globally unique)
  fhir:ConditionDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the condition definition
  fhir:ConditionDefinition.version [ string ]; # 0..1 Business version of the condition definition
  fhir:ConditionDefinition.name [ string ]; # 0..1 Name for this condition definition (computer friendly)
  fhir:ConditionDefinition.title [ string ]; # 0..1 Name for this condition definition (human friendly)
  fhir:ConditionDefinition.subtitle [ string ]; # 0..1 Subordinate title of the event definition
  fhir:ConditionDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ConditionDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ConditionDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ConditionDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ConditionDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ConditionDefinition.description [ markdown ]; # 0..1 Natural language description of the condition definition
  fhir:ConditionDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ConditionDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for condition definition (if applicable)
  fhir:ConditionDefinition.code [ CodeableConcept ]; # 1..1 Identification of the condition, problem or diagnosis
  fhir:ConditionDefinition.severity [ CodeableConcept ]; # 0..1 Subjective severity of condition
  fhir:ConditionDefinition.bodySite [ CodeableConcept ]; # 0..1 Anatomical location, if relevant
  fhir:ConditionDefinition.stage [ CodeableConcept ]; # 0..1 Stage/grade, usually assessed formally
  fhir:ConditionDefinition.hasSeverity [ boolean ]; # 0..1 Whether Severity is appropriate
  fhir:ConditionDefinition.hasBodySite [ boolean ]; # 0..1 Whether bodySite is appropriate
  fhir:ConditionDefinition.hasStage [ boolean ]; # 0..1 Whether stage is appropriate
  fhir:ConditionDefinition.definition [ uri ], ... ; # 0..* Formal Definition for the condition
  fhir:ConditionDefinition.observation [ # 0..* Observations particularly relevant to this condition
    fhir:ConditionDefinition.observation.category [ CodeableConcept ]; # 0..1 Category that is relevant
    fhir:ConditionDefinition.observation.code [ CodeableConcept ]; # 0..1 Code for relevant Observation
  ], ...;
  fhir:ConditionDefinition.medication [ # 0..* Medications particularly relevant for this condition
    fhir:ConditionDefinition.medication.category [ CodeableConcept ]; # 0..1 Category that is relevant
    fhir:ConditionDefinition.medication.code [ CodeableConcept ]; # 0..1 Code for relevant Medication
  ], ...;
  fhir:ConditionDefinition.precondition [ # 0..* Observation that suggets this condition
    fhir:ConditionDefinition.precondition.type [ code ]; # 1..1 sensitive | specific
    fhir:ConditionDefinition.precondition.code [ CodeableConcept ]; # 1..1 Code for relevant Observation
    # ConditionDefinition.precondition.value[x] : 0..1 Value of Observation. One of these 2
      fhir:ConditionDefinition.precondition.valueCodeableConcept [ CodeableConcept ]
      fhir:ConditionDefinition.precondition.valueQuantity [ Quantity ]
  ], ...;
  fhir:ConditionDefinition.team [ Reference(CareTeam) ], ... ; # 0..* Appropriate team for this condition
  fhir:ConditionDefinition.questionnaire [ # 0..* Questionnaire for this condition
    fhir:ConditionDefinition.questionnaire.purpose [ code ]; # 1..1 preadmit | diff-diagnosis | outcome
    fhir:ConditionDefinition.questionnaire.reference [ Reference(Questionnaire) ]; # 1..1 Specific Questionnaire
  ], ...;
  fhir:ConditionDefinition.plan [ # 0..* Plan that is appropriate
    fhir:ConditionDefinition.plan.role [ CodeableConcept ]; # 0..1 Use for the plan
    fhir:ConditionDefinition.plan.reference [ Reference(PlanDefinition) ]; # 1..1 The actual plan
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConditionDefinition TUMetadataResourceA 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, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this condition definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the condition definition
... version Σ0..1stringBusiness version of the condition definition
... name ΣI0..1stringName for this condition definition (computer friendly)
... title Σ0..1stringName for this condition definition (human friendly)
... subtitle 0..1stringSubordinate title of the event definition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the condition definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for condition definition (if applicable)
Jurisdiction (Extensible)
... code Σ1..1CodeableConceptIdentification of the condition, problem or diagnosis
Condition/Problem/Diagnosis Codes (Example)
... severity Σ0..1CodeableConceptSubjective severity of condition
Condition/Diagnosis Severity (Preferred)
... bodySite Σ0..1CodeableConceptAnatomical location, if relevant
SNOMED CT Body Structures (Example)
... stage Σ0..1CodeableConceptStage/grade, usually assessed formally
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
Observation Category Codes (Preferred)
.... code 0..1CodeableConceptCode for relevant Observation
LOINC Codes (Example)
... medication 0..*BackboneElementMedications particularly relevant for this condition
.... category 0..1CodeableConceptCategory that is relevant
Medication request category codes (Example)
.... code 0..1CodeableConceptCode for relevant Medication
SNOMED CT Medication Codes (Example)
... precondition 0..*BackboneElementObservation that suggets this condition
.... type 1..1codesensitive | specific
ConditionPreconditionType (Required)
.... code 1..1CodeableConceptCode for relevant Observation
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
ConditionQuestionnairePurpose (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

UML Diagram (Legend)

ConditionDefinition (MetadataResource)An 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 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]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]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] « The lifecycle status of an artifact. (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 published. 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 that published 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..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Identification of the condition, problem or diagnosiscode : CodeableConcept [1..1] « Identification of the condition or diagnosis. (Strength=Example)Condition/Problem/DiagnosisCo...?? »A subjective assessment of the severity of the condition as evaluated by the clinicianseverity : CodeableConcept [0..1] « A subjective assessment of the severity of the condition as evaluated by the clinician. (Strength=Preferred)Condition/DiagnosisSeverity? »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] « Codes describing condition stages (e.g. Cancer stages). (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] « Codes for high level observation categories. (Strength=Preferred)ObservationCategoryCodes? »Code for relevant Observationcode : CodeableConcept [0..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »MedicationCategory that is relevantcategory : CodeableConcept [0..1] « A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment. (Strength=Example)medicationRequest Category ?? »Code for relevant Medicationcode : CodeableConcept [0..1] « A coded concept identifying substance or product that can be ordered. (Strength=Example)SNOMEDCTMedicationCodes?? »PreconditionKind of pre-conditiontype : code [1..1] « Kind of precondition for the condition. (Strength=Required)ConditionPreconditionType! »Code for relevant Observationcode : CodeableConcept [1..1] « Codes identifying names of simple observations. (Strength=Example)LOINCCodes?? »Value of Observationvalue[x] : DataType [0..1] « CodeableConcept|Quantity »QuestionnaireUse of the questionnairepurpose : code [1..1] « The use of a questionnaire. (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 -->
 <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 -->
 <name value="[string]"/><!-- ?? 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 (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 --></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
  "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
  "name" : "<string>", // C? 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 (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
    "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
  fhir:ConditionDefinition.url [ uri ]; # 0..1 Canonical identifier for this condition definition, represented as a URI (globally unique)
  fhir:ConditionDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the condition definition
  fhir:ConditionDefinition.version [ string ]; # 0..1 Business version of the condition definition
  fhir:ConditionDefinition.name [ string ]; # 0..1 Name for this condition definition (computer friendly)
  fhir:ConditionDefinition.title [ string ]; # 0..1 Name for this condition definition (human friendly)
  fhir:ConditionDefinition.subtitle [ string ]; # 0..1 Subordinate title of the event definition
  fhir:ConditionDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ConditionDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ConditionDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ConditionDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ConditionDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ConditionDefinition.description [ markdown ]; # 0..1 Natural language description of the condition definition
  fhir:ConditionDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ConditionDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for condition definition (if applicable)
  fhir:ConditionDefinition.code [ CodeableConcept ]; # 1..1 Identification of the condition, problem or diagnosis
  fhir:ConditionDefinition.severity [ CodeableConcept ]; # 0..1 Subjective severity of condition
  fhir:ConditionDefinition.bodySite [ CodeableConcept ]; # 0..1 Anatomical location, if relevant
  fhir:ConditionDefinition.stage [ CodeableConcept ]; # 0..1 Stage/grade, usually assessed formally
  fhir:ConditionDefinition.hasSeverity [ boolean ]; # 0..1 Whether Severity is appropriate
  fhir:ConditionDefinition.hasBodySite [ boolean ]; # 0..1 Whether bodySite is appropriate
  fhir:ConditionDefinition.hasStage [ boolean ]; # 0..1 Whether stage is appropriate
  fhir:ConditionDefinition.definition [ uri ], ... ; # 0..* Formal Definition for the condition
  fhir:ConditionDefinition.observation [ # 0..* Observations particularly relevant to this condition
    fhir:ConditionDefinition.observation.category [ CodeableConcept ]; # 0..1 Category that is relevant
    fhir:ConditionDefinition.observation.code [ CodeableConcept ]; # 0..1 Code for relevant Observation
  ], ...;
  fhir:ConditionDefinition.medication [ # 0..* Medications particularly relevant for this condition
    fhir:ConditionDefinition.medication.category [ CodeableConcept ]; # 0..1 Category that is relevant
    fhir:ConditionDefinition.medication.code [ CodeableConcept ]; # 0..1 Code for relevant Medication
  ], ...;
  fhir:ConditionDefinition.precondition [ # 0..* Observation that suggets this condition
    fhir:ConditionDefinition.precondition.type [ code ]; # 1..1 sensitive | specific
    fhir:ConditionDefinition.precondition.code [ CodeableConcept ]; # 1..1 Code for relevant Observation
    # ConditionDefinition.precondition.value[x] : 0..1 Value of Observation. One of these 2
      fhir:ConditionDefinition.precondition.valueCodeableConcept [ CodeableConcept ]
      fhir:ConditionDefinition.precondition.valueQuantity [ Quantity ]
  ], ...;
  fhir:ConditionDefinition.team [ Reference(CareTeam) ], ... ; # 0..* Appropriate team for this condition
  fhir:ConditionDefinition.questionnaire [ # 0..* Questionnaire for this condition
    fhir:ConditionDefinition.questionnaire.purpose [ code ]; # 1..1 preadmit | diff-diagnosis | outcome
    fhir:ConditionDefinition.questionnaire.reference [ Reference(Questionnaire) ]; # 1..1 Specific Questionnaire
  ], ...;
  fhir:ConditionDefinition.plan [ # 0..* Plan that is appropriate
    fhir:ConditionDefinition.plan.role [ CodeableConcept ]; # 0..1 Use for the plan
    fhir:ConditionDefinition.plan.reference [ Reference(PlanDefinition) ]; # 1..1 The actual plan
  ], ...;
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a

14.8.5.1 Terminology Bindings

PathDefinitionTypeReference
ConditionDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
ConditionDefinition.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
ConditionDefinition.code Identification of the condition or diagnosis.ExampleCondition/Problem/DiagnosisCodes
ConditionDefinition.severity A subjective assessment of the severity of the condition as evaluated by the clinician.PreferredCondition/DiagnosisSeverity
ConditionDefinition.bodySite Codes describing anatomical locations. May include laterality.ExampleSNOMEDCTBodyStructures
ConditionDefinition.stage Codes describing condition stages (e.g. Cancer stages).ExampleConditionStage
ConditionDefinition.observation.category Codes for high level observation categories.PreferredObservationCategoryCodes
ConditionDefinition.observation.code
ConditionDefinition.precondition.code 		Codes identifying names of simple observations.ExampleLOINCCodes
ConditionDefinition.medication.category A coded concept identifying the category of medication request. For example, where the medication is to be consumed or administered, or the type of medication treatment.ExamplemedicationRequest Category Codes
ConditionDefinition.medication.code A coded concept identifying substance or product that can be ordered.ExampleSNOMEDCTMedicationCodes
ConditionDefinition.precondition.type Kind of precondition for the condition.RequiredConditionPreconditionType
ConditionDefinition.questionnaire.purpose The use of a questionnaire.RequiredConditionQuestionnairePurpose

14.8.5.2 Constraints

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

14.8.6 Search Parameters

Search parameters for 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 as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the condition definition(ConditionDefinition.useContext.value as Quantity) | (ConditionDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the condition definitionConditionDefinition.useContext.code
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.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the condition definitionOn ConditionDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date NdateThe condition definition publication dateConditionDefinition.date
description NstringThe description of the condition definitionConditionDefinition.description
identifiertokenExternal identifier for the condition definitionConditionDefinition.identifier
jurisdictiontokenIntended jurisdiction for the condition definitionConditionDefinition.jurisdiction
name NstringComputationally friendly name of the condition definitionConditionDefinition.name
publisher NstringName of the publisher of the condition definitionConditionDefinition.publisher
status NtokenThe current status of the condition definitionConditionDefinition.status
title NstringThe human-friendly name of the condition definitionConditionDefinition.title
url NuriThe uri that identifies the condition definitionConditionDefinition.url
version NtokenThe business version of the condition definitionConditionDefinition.version