COVID-19 FHIR Profile Library IG Informative Version
1.0.0 - Informative US

Publication Build: This will be filled in by the publication tooling

## Resource Profile: COVID19HemoglobinopathyUnderlyingMedicalCondition - Detailed Descriptions

Active as of 2022-07-25

Definitions for the underlying-hemoglobinopathy-medical-condition resource profile.

1. Condition
Definition | The US Core Condition Profile is based upon the core FHIR Condition Resource and created to meet the 2015 Edition Common Clinical Data Set 'Problems' and 'Health Concerns' requirements.
Control | 0..*
Invariants | Defined on this element 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()) 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-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()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) us-core-1: A code in Condition.category SHOULD be from US Core Condition Category Codes value set. (: where(category in 'http://hl7.org/fhir/us/core/ValueSet/us-core-condition-category').exists())
2. Condition.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | string
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Condition.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Condition.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Condition.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Condition.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Condition.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. Condition.extension
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.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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())
9. Condition.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
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.
Invariants | Defined on this element 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())
10. Condition.identifier
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.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Condition.clinicalStatus
Definition | The clinical status of the condition.
Control | 0..1 This element is affected by the following invariants: con-3, con-4, con-5
Binding | The codes SHALL be taken from ConditionClinicalStatusCodes
Type | CodeableConcept
Is Modifier | true
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Condition.verificationStatus
Definition | The verification status to support the clinical status of the condition.
Control | 0..1 This element is affected by the following invariants: con-3, con-5
Binding | The codes SHALL be taken from ConditionVerificationStatus
Type | CodeableConcept
Is Modifier | true
Must Support | true
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Condition.category
Definition | A category assigned to the condition.
Control | 1..* This element is affected by the following invariants: us-core-1
Binding | The codes SHALL be taken from US Core Condition Category Codes; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Comments | The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Condition.severity
Definition | A subjective assessment of the severity of the condition as evaluated by the clinician.
Control | 0..1
Binding | The codes SHOULD be taken from Condition/DiagnosisSeverity A subjective assessment of the severity of the condition as evaluated by the clinician.
Type | CodeableConcept
Comments | Coding of the severity with a terminology is preferred, where possible.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Condition.code
Definition | Identification of the condition, problem or diagnosis.
Control | 1..1
Binding | The codes SHALL be taken from COVID-19 hemoglobinopathy underlying condition reference set; other codes may be used where these codes are not suitable
Type | CodeableConcept
Must Support | true
Requirements | 0..1 to account for primarily narrative only resources.
Alternate Names | type
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Condition.bodySite
Definition | The anatomical location where this condition manifests itself.
Control | 0..0
Binding | For example codes, see SNOMEDCTBodyStructures Codes describing anatomical locations. May include laterality.
Type | CodeableConcept
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Condition.subject
Definition | Indicates the patient or group who the condition record is associated with.
Control | 1..1
Type | Reference(USCorePatientProfile)
Must Support | true
Requirements | Group is typically used for veterinary or public health use cases.
Alternate Names | patient
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Condition.encounter
Definition | The Encounter during which this Condition was created or to which the creation of this record is tightly associated.
Control | 0..1
Type | Reference(Encounter)
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".
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Condition.onset[x]
Definition | Estimated or actual date or date-time the condition began, in the opinion of the clinician.
Control | 0..1
Type | Choice of: dateTime, Age, Period, Range, string
[x] Note | See Choice of Data Types for further information about how to use [x]
Comments | Age is generally used when the patient reports an age at which the Condition began to occur.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Condition.abatement[x]
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.
Control | 0..1 This element is affected by the following invariants: con-4
Type | Choice of: dateTime, Age, Period, Range, string
[x] Note | See Choice of Data Types for further information about how to use [x]
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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Condition.recordedDate
Definition | The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.
Control | 0..1
Type | dateTime
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Condition.recorder
Definition | Individual who recorded the record and takes responsibility for its content.
Control | 0..1
Type | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Condition.asserter
Definition | Individual who is making the condition statement.
Control | 0..1
Type | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Condition.stage
Definition | Clinical stage or grade of a condition. May include formal severity assessments.
Control | 0..0
Type | BackboneElement
Invariants | Defined on this element con-1: Stage SHALL have summary or assessment (: summary.exists() or assessment.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Condition.evidence
Definition | Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.
Control | 0..0
Type | BackboneElement
Comments | The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.
Invariants | Defined on this element con-2: evidence SHALL have code or details (: code.exists() or detail.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Condition.note
Definition | Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
Control | 0..*
Type | Annotation
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))