Guidance on how to interpret the contents of this table can be found here
| 0. Condition | |
| Definition | A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern. |
| Short | Documentation of a health problem of the patient |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| 2. Condition.clinicalStatus | |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Short | Concept - reference to a terminology or just text |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from ConditionClinicalStatusCodes (required to http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1)The clinical status of the condition or diagnosis. |
| Type | CodeableConcept(Codeable Concept (IPS)) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Condition.category | |
| Definition | A category assigned to the condition. In this profile, a health problem of the patient, therefore a 'problem-list-item'. |
| Short | Concept - reference to a terminology or just text |
| Comments | In this profile, Condition represents a health problem of the patient. Therefore one of the category value(s) must be problem-list-item. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from Problem Type - IPS (extensible to http://hl7.org/fhir/uv/ips/ValueSet/problem-type-uv-ips) |
| Type | CodeableConcept(Codeable Concept (IPS)) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. Condition.severity | |
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
| Short | Concept - reference to a terminology or just text |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHOULD be taken from Condition/DiagnosisSeverity (preferred to http://hl7.org/fhir/ValueSet/condition-severity) |
| Type | CodeableConcept(Codeable Concept (IPS)) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Condition.code | |
| Definition | Identification of the condition, problem or diagnosis or recording of absent/unknown problems. |
| Short | Concept - reference to a terminology or just text |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHOULD be taken from Problems - IPS (preferred to http://hl7.org/fhir/uv/ips/ValueSet/problems-uv-ips)Code for a clinical problem (or absent/unknown problem) that is selected from SNOMED CT |
| Type | CodeableConcept(Codeable Concept (IPS)) |
| Is Modifier | false |
| Must Support | false |
| Requirements | 0..1 to account for primarily narrative only resources. |
| Alternate Names | type |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Condition.code.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | A reference to a code defined by a terminology system |
| Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Coding(Coding with translations) |
| Is Modifier | false |
| Must Support | false |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Condition.code.coding.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Condition.code.coding.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Short | Symbol in syntax defined by the system |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Undiagnosed Rare Disease Case Value Set (required to https://github.com/BIH-CEI/RareLink/ValueSet/undiagnosed-rd-case-vs) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Condition.code.coding.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Short | Representation defined by the system |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Condition.code.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Short | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Condition.subject | |
| Definition | Indicates the patient or group who the condition record is associated with. |
| Short | Who has the condition? |
| Control | 1..1 |
| Type | Reference(RareLink IPS Patient) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Group is typically used for veterinary or public health use cases. |
| Alternate Names | patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Condition.subject.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| Control | 1..1 This element is affected by the following invariants: ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Condition.subject.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Condition.onset[x] | |
| Definition | Estimated or actual date or date-time the condition began, in the opinion of the clinician. |
| Short | Estimated or actual date, date-time, or age |
| Comments | Age is generally used when the patient reports an age at which the Condition began to occur. |
| Control | 0..1 |
| Type | Choice of: dateTime, Age, Period, Range, string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |