R6 Ballot (2nd Draft)
Clinical ReasoningPublish-box (todo)
Patient Care  Work Group | Maturity Level: 0 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
Detailed Descriptions for the elements in the ConditionDefinition resource.
| ConditionDefinition | |||||||||
| Element Id | ConditionDefinition | ||||||||
| Definition | A definition of a condition and information relevant to managing it. | ||||||||
| Short Display | A definition of a condition | ||||||||
| Cardinality | 0..* | ||||||||
| Type | MetadataResource | ||||||||
| Summary | false | ||||||||
| Invariants |
| ||||||||
| ConditionDefinition.url | |||||||||
| Element Id | ConditionDefinition.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 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. | ||||||||
| Short Display | Canonical identifier for this condition definition, represented as a URI (globally unique) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | uri | ||||||||
| Requirements | Allows the condition definition to be referenced by a single globally unique identifier. | ||||||||
| Summary | true | ||||||||
| 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. | ||||||||
| Invariants |
| ||||||||
| ConditionDefinition.identifier | |||||||||
| Element Id | ConditionDefinition.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. | ||||||||
| Short Display | Additional identifier for the condition definition | ||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Identifier | ||||||||
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
| Summary | true | ||||||||
| 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 Id | ConditionDefinition.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. | ||||||||
| Short Display | Business version of the condition definition | ||||||||
| Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| 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]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||
| ConditionDefinition.versionAlgorithm[x] | |||||||||
| Element Id | ConditionDefinition.versionAlgorithm[x] | ||||||||
| Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||
| Short Display | How to compare versions | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Version Algorithm (Extensible) | ||||||||
| Type | string|Coding | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | true | ||||||||
| Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. | ||||||||
| ConditionDefinition.name | |||||||||
| Element Id | ConditionDefinition.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. | ||||||||
| Short Display | Name for this condition definition (computer friendly) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | Support human navigation and code generation. | ||||||||
| Summary | true | ||||||||
| 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 |
| ||||||||
| ConditionDefinition.title | |||||||||
| Element Id | ConditionDefinition.title | ||||||||
| Definition | A short, descriptive, user-friendly title for the condition definition. | ||||||||
| Short Display | Name for this condition definition (human friendly) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
| ConditionDefinition.subtitle | |||||||||
| Element Id | ConditionDefinition.subtitle | ||||||||
| Definition | An explanatory or alternate title for the event definition giving additional information about its content. | ||||||||
| Short Display | Subordinate title of the event definition | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.status | |||||||||
| Element Id | ConditionDefinition.status | ||||||||
| Definition | The status of this condition definition. Enables tracking the life-cycle of the content. | ||||||||
| Short Display | draft | active | retired | unknown | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | PublicationStatus (Required) | ||||||||
| Type | code | ||||||||
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||
| Summary | true | ||||||||
| Comments | Allows filtering of condition definitions that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||
| ConditionDefinition.experimental | |||||||||
| Element Id | ConditionDefinition.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. | ||||||||
| Short Display | For testing purposes, not real usage | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||
| Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level condition definition. | ||||||||
| Summary | true | ||||||||
| Comments | Allows filtering of condition definitions that are appropriate for use versus not. | ||||||||
| ConditionDefinition.date | |||||||||
| Element Id | ConditionDefinition.date | ||||||||
| Definition | 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 changes. | ||||||||
| Short Display | Date last changed | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | dateTime | ||||||||
| Alternate Names | Revision Date | ||||||||
| Summary | true | ||||||||
| Comments | The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements here. | ||||||||
| ConditionDefinition.publisher | |||||||||
| Element Id | ConditionDefinition.publisher | ||||||||
| Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the condition definition. | ||||||||
| Short Display | Name of the publisher/steward (organization or individual) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Requirements | Helps establish the "authority/credibility" of the condition definition. May also allow for contact. | ||||||||
| Summary | true | ||||||||
| 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 Id | ConditionDefinition.contact | ||||||||
| Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
| Short Display | Contact details for the publisher | ||||||||
| Cardinality | 0..* | ||||||||
| Type | ContactDetail | ||||||||
| Summary | true | ||||||||
| Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||
| ConditionDefinition.description | |||||||||
| Element Id | ConditionDefinition.description | ||||||||
| Definition | A free text natural language description of the condition definition from a consumer's perspective. | ||||||||
| Short Display | Natural language description of the condition definition | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | markdown | ||||||||
| Summary | false | ||||||||
| Comments | This description can be used to capture details such as 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 Id | ConditionDefinition.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. | ||||||||
| Short Display | The context that the content is intended to support | ||||||||
| Cardinality | 0..* | ||||||||
| Type | UsageContext | ||||||||
| Requirements | Assist in searching for appropriate content. | ||||||||
| Summary | true | ||||||||
| Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
| ConditionDefinition.jurisdiction | |||||||||
| Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||
| Element Id | ConditionDefinition.jurisdiction | ||||||||
| Definition | A legal or geographic region in which the condition definition is intended to be used. | ||||||||
| Short Display | Intended jurisdiction for condition definition (if applicable) | ||||||||
| Cardinality | 0..* | ||||||||
| Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| 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. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) | ||||||||
| ConditionDefinition.code | |||||||||
| Element Id | ConditionDefinition.code | ||||||||
| Definition | Identification of the condition, problem or diagnosis. | ||||||||
| Short Display | Identification of the condition, problem or diagnosis | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Condition/Problem/Diagnosis Codes (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Requirements | 0..1 to account for primarily narrative only resources. | ||||||||
| Summary | true | ||||||||
| ConditionDefinition.severity | |||||||||
| Element Id | ConditionDefinition.severity | ||||||||
| Definition | A subjective assessment of the severity of the condition as evaluated by the clinician. | ||||||||
| Short Display | Subjective severity of condition | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Condition/Diagnosis Severity (Preferred) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments | Coding of the severity with a terminology is preferred, where possible. | ||||||||
| ConditionDefinition.bodySite | |||||||||
| Element Id | ConditionDefinition.bodySite | ||||||||
| Definition | The anatomical location where this condition manifests itself. | ||||||||
| Short Display | Anatomical location, if relevant | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | SNOMED CT Body Structures (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| 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 http://hl7.org/fhir/StructureDefinition/bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. | ||||||||
| ConditionDefinition.stage | |||||||||
| Element Id | ConditionDefinition.stage | ||||||||
| Definition | Clinical stage or grade of a condition. May include formal severity assessments. | ||||||||
| Short Display | Stage/grade, usually assessed formally | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Condition Stage (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| ConditionDefinition.hasSeverity | |||||||||
| Element Id | ConditionDefinition.hasSeverity | ||||||||
| Definition | Whether Severity is appropriate to collect for this condition. | ||||||||
| Short Display | Whether Severity is appropriate | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.hasBodySite | |||||||||
| Element Id | ConditionDefinition.hasBodySite | ||||||||
| Definition | Whether bodySite is appropriate to collect for this condition. | ||||||||
| Short Display | Whether bodySite is appropriate | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.hasStage | |||||||||
| Element Id | ConditionDefinition.hasStage | ||||||||
| Definition | Whether stage is appropriate to collect for this condition. | ||||||||
| Short Display | Whether stage is appropriate | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | boolean | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.definition | |||||||||
| Element Id | ConditionDefinition.definition | ||||||||
| Definition | Formal definitions of the condition. These may be references to ontologies, published clinical protocols or research papers. | ||||||||
| Short Display | Formal Definition for the condition | ||||||||
| Cardinality | 0..* | ||||||||
| Type | uri | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.observation | |||||||||
| Element Id | ConditionDefinition.observation | ||||||||
| Definition | Observations particularly relevant to this condition. | ||||||||
| Short Display | Observations particularly relevant to this condition | ||||||||
| Cardinality | 0..* | ||||||||
| Type | canonical(ObservationDefinition) | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.medication | |||||||||
| Element Id | ConditionDefinition.medication | ||||||||
| Definition | Medications particularly relevant for this condition. | ||||||||
| Short Display | Medications particularly relevant for this condition | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.medication.category | |||||||||
| Element Id | ConditionDefinition.medication.category | ||||||||
| Definition | Category that is relevant. | ||||||||
| Short Display | Category that is relevant | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | Medication request category codes (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.medication.code | |||||||||
| Element Id | ConditionDefinition.medication.code | ||||||||
| Definition | Code for relevant Medication. | ||||||||
| Short Display | Code for relevant Medication | ||||||||
| Cardinality | 0..1 | ||||||||
| Terminology Binding | SNOMED CT Medication Codes (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.precondition | |||||||||
| Element Id | ConditionDefinition.precondition | ||||||||
| Definition | An observation that suggests that this condition applies. | ||||||||
| Short Display | Observation that suggets this condition | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.precondition.type | |||||||||
| Element Id | ConditionDefinition.precondition.type | ||||||||
| Definition | Kind of pre-condition. | ||||||||
| Short Display | sensitive | specific | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Condition Precondition Type (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.precondition.code | |||||||||
| Element Id | ConditionDefinition.precondition.code | ||||||||
| Definition | Code for relevant Observation. | ||||||||
| Short Display | Code for relevant Observation | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | LOINC Codes (Example) | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.precondition.value[x] | |||||||||
| Element Id | ConditionDefinition.precondition.value[x] | ||||||||
| Definition | Value of Observation. | ||||||||
| Short Display | Value of Observation | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | CodeableConcept|Quantity | ||||||||
| [x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.team | |||||||||
| Element Id | ConditionDefinition.team | ||||||||
| Definition | Appropriate team for this condition. | ||||||||
| Short Display | Appropriate team for this condition | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference(CareTeam) | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.questionnaire | |||||||||
| Element Id | ConditionDefinition.questionnaire | ||||||||
| Definition | Questionnaire for this condition. | ||||||||
| Short Display | Questionnaire for this condition | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.questionnaire.purpose | |||||||||
| Element Id | ConditionDefinition.questionnaire.purpose | ||||||||
| Definition | Use of the questionnaire. | ||||||||
| Short Display | preadmit | diff-diagnosis | outcome | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | Condition Questionnaire Purpose (Required) | ||||||||
| Type | code | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.questionnaire.reference | |||||||||
| Element Id | ConditionDefinition.questionnaire.reference | ||||||||
| Definition | Specific Questionnaire. | ||||||||
| Short Display | Specific Questionnaire | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Reference(Questionnaire) | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.plan | |||||||||
| Element Id | ConditionDefinition.plan | ||||||||
| Definition | Plan that is appropriate. | ||||||||
| Short Display | Plan that is appropriate | ||||||||
| Cardinality | 0..* | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.plan.role | |||||||||
| Element Id | ConditionDefinition.plan.role | ||||||||
| Definition | Use for the plan. | ||||||||
| Short Display | Use for the plan | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | CodeableConcept | ||||||||
| Summary | false | ||||||||
| ConditionDefinition.plan.reference | |||||||||
| Element Id | ConditionDefinition.plan.reference | ||||||||
| Definition | The actual plan. | ||||||||
| Short Display | The actual plan | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | Reference(PlanDefinition) | ||||||||
| Summary | false | ||||||||
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Mon, Aug 12, 2024 16:58+0800.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change