Condition | I | | Condition | There are no (further) constraints on this element Element IdShort description Detailed information about conditions, problems or diagnoses Definition A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
Data Type Condition Constraints- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-6:A resource should have narrative for robust management
text.`div`.exists() - dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - con-5:Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty() - con-4:If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists() - con-3:Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
Mappings- rim:Entity. Role, or Act
- workflow:Event
- sct-concept:< 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)
- v2:PPR message
- rim:Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]
|
extension | I | 0..* | Extension | Element IdShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
conditionEpisode | I | 0..* | Extension(code) | Element IdCondition.extension:conditionEpisode Short description The episodicity status of a condition Alternate names extensions, user content Definition The episodicity status of a condition.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Data Type Extension(code) Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ConditionEpisode Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1:Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdShort description External Ids for this condition Definition Business identifiers assigned to this condition by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Requirements Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.
Comments This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- workflow:Event.identifier
- w5:FiveWs.identifier
- rim:.id
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdShort description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
clinicalStatus | Σ ?! I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdShort description active | recurrence | relapse | inactive | remission | resolved Definition The clinical status of the condition.
Comments The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.
Data Type CodeableConcept Binding The clinical status of the condition or diagnosis. ConditionClinicalStatusCodes (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.status
- w5:FiveWs.status
- sct-concept:< 303105007 |Disease phases|
- v2:PRB-14
- rim:Observation ACT
.inboundRelationship[typeCode=COMP].source[classCode=OBS, code="clinicalStatus", moodCode=EVN].value
|
verificationStatus | Σ ?! I | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.verificationStatus Short description unconfirmed | provisional | differential | confirmed | refuted | entered-in-error Definition The verification status to support the clinical status of the condition.
Comments verificationStatus is not required. For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.
The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.
Data Type CodeableConcept Binding The verification status to support or decline the clinical status of the condition or diagnosis. ConditionVerificationStatus (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.status
- w5:FiveWs.status
- sct-concept:< 410514004 |Finding context value|
- v2:PRB-13
- rim:Observation ACT
.inboundRelationship[typeCode=COMP].source[classCode=OBS, code="verificationStatus", moodCode=EVN].value
- sct-attr:408729009
|
category | | 0..* | CodeableConceptBinding | Element IdShort description problem-list-item | encounter-diagnosis Definition A category assigned to the condition.
Comments The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.
Data Type CodeableConcept Binding A ValueSet to identify the category of a condition. UKCoreConditionCategory (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5:FiveWs.class
- sct-concept:< 404684003 |Clinical finding|
- v2:'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message
- rim:.code
|
severity | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdShort description Subjective severity of condition Definition A subjective assessment of the severity of the condition as evaluated by the clinician.
Comments Coding of the severity with a terminology is preferred, where possible.
Data Type CodeableConcept Binding A subjective assessment of the severity of the condition as evaluated by the clinician. Condition/DiagnosisSeverity (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- w5:FiveWs.grade
- sct-concept:< 272141005 |Severities|
- v2:PRB-26 / ABS-3
- rim:Can be pre/post-coordinated into value. Or ./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="severity"].value
- sct-attr:246112005
|
code | Σ | 0..1 | CodeableConceptBinding | Element IdShort description Identification of the condition, problem or diagnosis Alternate names type Definition Identification of the condition, problem or diagnosis.
Requirements 0..1 to account for primarily narrative only resources.
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.
Data Type CodeableConcept Binding A code from the SNOMED Clinical Terminology UK with the expression (<404684003 |Clinical finding| OR <413350009 |Finding with explicit context| OR <272379006 |Event|). UKCoreConditionCode (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.code
- w5:FiveWs.what[x]
- sct-concept:code 246090004 |Associated finding| (< 404684003 |Clinical finding| MINUS
<< 420134006 |Propensity to adverse reactions| MINUS
<< 473010000 |Hypersensitivity condition| MINUS
<< 79899007 |Drug interaction| MINUS
<< 69449002 |Drug action| MINUS
<< 441742003 |Evaluation finding| MINUS
<< 307824009 |Administrative status| MINUS
<< 385356007 |Tumor stage finding|)
OR < 413350009 |Finding with explicit context|
OR < 272379006 |Event|
- v2:PRB-3
- rim:.value
- sct-attr:246090004
|
bodySite | Σ | 0..* | CodeableConceptBinding | Element IdShort description Anatomical location, if relevant Definition The anatomical location where this condition manifests itself.
Comments Only used if not implicit in code found in Condition.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.
Data Type CodeableConcept Binding Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (preferred)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept:< 442083009 |Anatomical or acquired body structure|
- rim:.targetBodySiteCode
- sct-attr:363698007
|
subject | Σ I | 1..1 | Reference(Group | UK Core Patient) | Element IdShort description Who has the condition? Alternate names patient Definition Indicates the patient or group who the condition record is associated with.
Requirements Group is typically used for veterinary or public health use cases.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(Group | UK Core Patient) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.subject
- w5:FiveWs.subject[x]
- v2:PID-3
- rim:.participation[typeCode=SBJ].role[classCode=PAT]
- w5:FiveWs.subject
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCondition.subject.reference Short description Literal reference, Relative, internal or absolute URL 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdCondition.subject.identifier Short description Logical reference, when literal reference is not known 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.
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).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCondition.subject.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.subject.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.subject.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.subject.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.subject.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.subject.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.subject.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
encounter | Σ I | 0..1 | Reference(UK Core Encounter) | Element IdShort description Encounter created as part of Definition The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
Comments This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. This record indicates the encounter this particular record is associated with. In the case of a "new" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first "known".
Data Type Reference(UK Core Encounter) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- workflow:Event.context
- w5:FiveWs.context
- v2:PV1-19 (+PV1-54)
- rim:.inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCondition.encounter.reference Short description Literal reference, Relative, internal or absolute URL 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdCondition.encounter.identifier Short description Logical reference, when literal reference is not known 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.
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).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCondition.encounter.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.encounter.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.encounter.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.encounter.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.encounter.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.encounter.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.encounter.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
onset[x] | Σ | 0..1 | | There are no (further) constraints on this element Element IdShort description Estimated or actual date, date-time, or age Definition Estimated or actual date or date-time the condition began, in the opinion of the clinician.
Comments Age is generally used when the patient reports an age at which the Condition began to occur.
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- workflow:Event.occurrence[x]
- w5:FiveWs.init
- v2:PRB-16
- rim:.effectiveTime.low or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at onset"].value
|
onsetDateTime | | | dateTime | There are no (further) constraints on this element Data Type dateTime |
onsetAge | | | Age | There are no (further) constraints on this element Data Type Age |
onsetPeriod | | | Period | There are no (further) constraints on this element Data Type Period |
onsetRange | | | Range | There are no (further) constraints on this element Data Type Range |
onsetString | | | string | There are no (further) constraints on this element Data Type string |
abatement[x] | I | 0..1 | | There are no (further) constraints on this element Element IdShort description When in resolution/remission Definition The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate.
Comments There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated. If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid. When abatementString exists, it implies the condition is abated.
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.done[x]
- rim:.effectiveTime.high or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="age at remission"].value or .inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed
|
abatementDateTime | | | dateTime | There are no (further) constraints on this element Data Type dateTime |
abatementAge | | | Age | There are no (further) constraints on this element Data Type Age |
abatementPeriod | | | Period | There are no (further) constraints on this element Data Type Period |
abatementRange | | | Range | There are no (further) constraints on this element Data Type Range |
abatementString | | | string | There are no (further) constraints on this element Data Type string |
recordedDate | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description Date record was first recorded Definition The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- w5:FiveWs.recorded
- v2:REL-11
- rim:.participation[typeCode=AUT].time
|
recorder | Σ I | 0..1 | Reference(UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson) | Element IdShort description Who recorded the condition Definition Individual who recorded the record and takes responsibility for its content.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(UK Core Patient | UK Core Practitioner | UK Core PractitionerRole | UK Core RelatedPerson) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.author
- rim:.participation[typeCode=AUT].role
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCondition.recorder.reference Short description Literal reference, Relative, internal or absolute URL 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdCondition.recorder.identifier Short description Logical reference, when literal reference is not known 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.
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).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCondition.recorder.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.recorder.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.recorder.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.recorder.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.recorder.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.recorder.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.recorder.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
asserter | Σ I | 0..1 | Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Patient | UK Core RelatedPerson) | Element IdShort description Person who asserts this condition Definition Individual who is making the condition statement.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Patient | UK Core RelatedPerson) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.source
- v2:REL-7.1 identifier + REL-7.12 type code
- rim:.participation[typeCode=INF].role
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCondition.asserter.reference Short description Literal reference, Relative, internal or absolute URL 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdShort description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdCondition.asserter.identifier Short description Logical reference, when literal reference is not known 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.
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).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCondition.asserter.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.asserter.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.asserter.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.asserter.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.asserter.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.asserter.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.asserter.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
stage | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Stage/grade, usually assessed formally Definition Clinical stage or grade of a condition. May include formal severity assessments.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - con-1:Stage SHALL have summary or assessment
summary.exists() or assessment.exists()
Mappings- rim:n/a
- rim:./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="stage/grade"]
|
summary | I | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdShort description Simple summary (disease specific) Definition A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.
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.
Data Type CodeableConcept Binding Codes describing condition stages (e.g. Cancer stages). ConditionStage (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- sct-concept:< 254291000 |Staging and scales|
- v2:PRB-14
- rim:.value
|
assessment | I | 0..* | Reference(ClinicalImpression | UK Core DiagnosticReport | UK Core Observation) | Element IdCondition.stage.assessment Short description Formal record of assessment Definition Reference to a formal record of the evidence on which the staging assessment is based.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(ClinicalImpression | UK Core DiagnosticReport | UK Core Observation) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- rim:.self
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCondition.stage.assessment.reference Short description Literal reference, Relative, internal or absolute URL 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdCondition.stage.assessment.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdCondition.stage.assessment.identifier Short description Logical reference, when literal reference is not known 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.
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).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCondition.stage.assessment.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.stage.assessment.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.stage.assessment.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.stage.assessment.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.stage.assessment.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.stage.assessment.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.stage.assessment.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdShort description Kind of staging Definition The kind of staging, such as pathological or clinical staging.
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.
Data Type CodeableConcept Binding Codes describing the kind of condition staging (e.g. clinical or pathological). ConditionStageType (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="stage type"]
|
evidence | I | 0..* | BackboneElement | There are no (further) constraints on this element Element IdShort description Supporting evidence Definition Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
Comments The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.
Data Type BackboneElement Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - con-2:evidence SHALL have code or details
code.exists() or detail.exists()
Mappings- rim:n/a
- rim:.outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]
|
code | Σ I | 0..* | CodeableConcept | There are no (further) constraints on this element Element IdShort description Manifestation/symptom Definition A manifestation or symptom that led to the recording of this condition.
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.
Data Type CodeableConcept Binding Codes that describe the manifestation or symptoms of a condition. ManifestationAndSymptomCodes (example)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Event.reasonCode
- w5:FiveWs.why[x]
- sct-concept:< 404684003 |Clinical finding|
- rim:[code="diagnosis"].value
|
detail | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element IdCondition.evidence.detail Short description Supporting information found elsewhere Definition Links to other relevant information, including pathology reports.
Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
Data Type Reference(Resource) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- w5:FiveWs.why[x]
- rim:.self
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element IdCondition.evidence.detail.reference Short description Literal reference, Relative, internal or absolute URL 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.
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.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdCondition.evidence.detail.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Data Type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdCondition.evidence.detail.identifier Short description Logical reference, when literal reference is not known 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.
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).
Data Type Identifier Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
- rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
- servd:Identifier
- rim:.identifier
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdCondition.evidence.detail.identifier.use Short description usual | official | temp | secondary | old (If known) Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdCondition.evidence.detail.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- v2:CX.5
- rim:Role.code or implied by context
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdCondition.evidence.detail.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comments Identifier.system is always case sensitive.
Data Type uri Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Generalhttp://www.acme.com/identifiers/patient Mappings- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.evidence.detail.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Examples Mappings- rim:n/a
- v2:CX.1 / EI.1
- rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd:./Value
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdCondition.evidence.detail.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use.
Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").
Period is not used for a duration (a measure of elapsed time). See Duration.
Data Type Period Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings- rim:n/a
- v2:DR
- rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
- v2:CX.7 + CX.8
- rim:Role.effectiveTime or implied by context
- servd:./StartDate and ./EndDate
|
assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element IdCondition.evidence.detail.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier.
Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type Reference(UK Core Organization) Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings- rim:n/a
- rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
- v2:CX.4 / (CX.4,CX.9,CX.10)
- rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd:./IdentifierIssuingAuthority
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdCondition.evidence.detail.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference.
Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type string Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
note | | 0..* | Annotation | There are no (further) constraints on this element Element IdShort description Additional information about the Condition Definition Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
Comments For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
Data Type Annotation Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act
- workflow:Event.note
- v2:NTE child of PRB
- rim:.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
|
author[x] | Σ | 0..1 | | There are no (further) constraints on this element Element IdShort description Individual responsible for the annotation Definition The individual responsible for making the annotation.
Comments Organization is used when there's no need for specific attribution as to who made the comment.
Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act.participant[typeCode=AUT].role
|
authorString | | | string | Data Type string |
authorReference | | | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) | Data Type Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) |
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdShort description When the annotation was made Definition Indicates when this particular annotation was made.
Data Type dateTime Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act.effectiveTime
|
text | Σ | 1..1 | markdown | There are no (further) constraints on this element Element IdShort description The annotation - text content (as markdown) Definition The text of the annotation in markdown format.
Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
Data Type markdown Constraints- ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim:n/a
- v2:N/A
- rim:Act.text
|