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

Detailed Descriptions for the elements in the ConditionDefinition resource.

ConditionDefinition
Element IdConditionDefinition
Definition

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

Cardinality0..*
TypeDomainResource
Invariants
Defined on this element
cdf-0Warning 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}')
ConditionDefinition.url
Element IdConditionDefinition.url
Definition

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 servers.

Cardinality0..1
Typeuri
Requirements

Allows the condition definition to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

ConditionDefinition.identifier
Element IdConditionDefinition.identifier
Definition

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 instance.

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this condition definition outside of FHIR, where it is not possible to use the logical URI.

ConditionDefinition.version
Element IdConditionDefinition.version
Definition

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 sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different condition definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the condition definition with the format [url]|[version].

ConditionDefinition.name
Element IdConditionDefinition.name
Definition

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 generation.

Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
inv-0Warning 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}')
ConditionDefinition.title
Element IdConditionDefinition.title
Definition

A short, descriptive, user-friendly title for the condition definition.

Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

ConditionDefinition.subtitle
Element IdConditionDefinition.subtitle
Definition

An explanatory or alternate title for the event definition giving additional information about its content.

Cardinality0..1
Typestring
ConditionDefinition.status
Element IdConditionDefinition.status
Definition

The status of this condition definition. Enables tracking the life-cycle of the content.

Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of condition definitions that are appropriate for use versus not.

ConditionDefinition.experimental
Element IdConditionDefinition.experimental
Definition

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 usage.

Cardinality0..1
Typeboolean
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level condition definition.

Summarytrue
Comments

Allows filtering of condition definitions that are appropriate for use versus not.

ConditionDefinition.date
Element IdConditionDefinition.date
Definition

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 changes.

Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the condition definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

ConditionDefinition.publisher
Element IdConditionDefinition.publisher
Definition

The name of the organization or individual that published the condition definition.

Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the condition definition. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the condition definition is the organization or individual primarily responsible for the maintenance and upkeep of the condition definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the condition definition. This item SHOULD be populated unless the information is available from context.

ConditionDefinition.contact
Element IdConditionDefinition.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

ConditionDefinition.description
Element IdConditionDefinition.description
Definition

A free text natural language description of the condition definition from a consumer's perspective.

Cardinality0..1
Typemarkdown
Comments

This description can be used to capture details such as why the condition definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the condition definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the condition definition is presumed to be the predominant language in the place the condition definition was created).

ConditionDefinition.useContext
Element IdConditionDefinition.useContext
Definition

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 instances.

Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

ConditionDefinition.jurisdiction
Element IdConditionDefinition.jurisdiction
Definition

A legal or geographic region in which the condition definition is intended to be used.

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the condition definition to be used in jurisdictions other than those for which it was originally designed or intended.

ConditionDefinition.code
Element IdConditionDefinition.code
Definition

Identification of the condition, problem or diagnosis.

Cardinality1..1
Terminology BindingCondition/Problem/Diagnosis Codes (Example)
TypeCodeableConcept
Requirements

0..1 to account for primarily narrative only resources.

Summarytrue
ConditionDefinition.severity
Element IdConditionDefinition.severity
Definition

A subjective assessment of the severity of the condition as evaluated by the clinician.

Cardinality0..1
Terminology BindingCondition/Diagnosis Severity (Preferred)
TypeCodeableConcept
Summarytrue
Comments

Coding of the severity with a terminology is preferred, where possible.

ConditionDefinition.bodySite
Element IdConditionDefinition.bodySite
Definition

The anatomical location where this condition manifests itself.

Cardinality0..1
Terminology BindingSNOMED CT Body Structures (Example)
TypeCodeableConcept
Summarytrue
Comments

Only used if not implicit in code found in ConditionDefinition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

ConditionDefinition.stage
Element IdConditionDefinition.stage
Definition

Clinical stage or grade of a condition. May include formal severity assessments.

Cardinality0..1
Terminology BindingCondition Stage (Example)
TypeCodeableConcept
Summarytrue
ConditionDefinition.hasSeverity
Element IdConditionDefinition.hasSeverity
Definition

Whether Severity is appropriate to collect for this condition.

Cardinality0..1
Typeboolean
ConditionDefinition.hasBodySite
Element IdConditionDefinition.hasBodySite
Definition

Whether bodySite is appropriate to collect for this condition.

Cardinality0..1
Typeboolean
ConditionDefinition.hasStage
Element IdConditionDefinition.hasStage
Definition

Whether stage is appropriate to collect for this condition.

Cardinality0..1
Typeboolean
ConditionDefinition.definition
Element IdConditionDefinition.definition
Definition

Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers.

Cardinality0..*
Typeuri
ConditionDefinition.observation
Element IdConditionDefinition.observation
Definition

Observations particularly relevant to this condition.

Cardinality0..*
ConditionDefinition.observation.category
Element IdConditionDefinition.observation.category
Definition

Category that is relevant.

Cardinality0..1
Terminology BindingObservation Category Codes (Preferred)
TypeCodeableConcept
ConditionDefinition.observation.code
Element IdConditionDefinition.observation.code
Definition

Code for relevant Observation.

Cardinality0..1
Terminology BindingLOINC Codes (Example)
TypeCodeableConcept
ConditionDefinition.medication
Element IdConditionDefinition.medication
Definition

Medications particularly relevant for this condition.

Cardinality0..*
ConditionDefinition.medication.category
Element IdConditionDefinition.medication.category
Definition

Category that is relevant.

Cardinality0..1
Terminology BindingMedication request category codes (Example)
TypeCodeableConcept
ConditionDefinition.medication.code
Element IdConditionDefinition.medication.code
Definition

Code for relevant Medication.

Cardinality0..1
Terminology BindingSNOMED CT Medication Codes (Example)
TypeCodeableConcept
ConditionDefinition.precondition
Element IdConditionDefinition.precondition
Definition

An observation that suggests that this condition applies.

Cardinality0..*
ConditionDefinition.precondition.type
Element IdConditionDefinition.precondition.type
Definition

Kind of pre-condition.

Cardinality1..1
Terminology BindingConditionPreconditionType (Required)
Typecode
ConditionDefinition.precondition.code
Element IdConditionDefinition.precondition.code
Definition

Code for relevant Observation.

Cardinality1..1
Terminology BindingLOINC Codes (Example)
TypeCodeableConcept
ConditionDefinition.precondition.value[x]
Element IdConditionDefinition.precondition.value[x]
Definition

Value of Observation.

Cardinality0..1
TypeCodeableConcept|Quantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
ConditionDefinition.team
Element IdConditionDefinition.team
Definition

Appropriate team for this condition.

Cardinality0..*
TypeReference(CareTeam)
ConditionDefinition.questionnaire
Element IdConditionDefinition.questionnaire
Definition

Questionnaire for this condition.

Cardinality0..*
ConditionDefinition.questionnaire.purpose
Element IdConditionDefinition.questionnaire.purpose
Definition

Use of the questionnaire.

Cardinality1..1
Terminology BindingConditionQuestionnairePurpose (Required)
Typecode
ConditionDefinition.questionnaire.reference
Element IdConditionDefinition.questionnaire.reference
Definition

Specific Questionnaire.

Cardinality1..1
TypeReference(Questionnaire)
ConditionDefinition.plan
Element IdConditionDefinition.plan
Definition

Plan that is appropriate.

Cardinality0..*
ConditionDefinition.plan.role
Element IdConditionDefinition.plan.role
Definition

Use for the plan.

Cardinality0..1
TypeCodeableConcept
ConditionDefinition.plan.reference
Element IdConditionDefinition.plan.reference
Definition

The actual plan.

Cardinality1..1
TypeReference(PlanDefinition)