| UKCoreFamilyMemberHistory (FamilyMemberHistory) | C | | FamilyMemberHistory | There are no (further) constraints on this element Element idFamilyMemberHistory Short descriptionInformation about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient.
FamilyMemberHistory Constraints- 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() - fhs-1: Can have age[x] or born[x], but not both
age.empty() or born.empty() - fhs-2: Can only have estimatedAge if age[x] is present
age.exists() or estimatedAge.empty()
Mappings- rim: Entity. Role, or Act
- workflow: Event
- v2: Not in scope for v2
- rim: Observation[classCode=OBS, moodCode=EVN]
|
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
string |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Short descriptionMetadata about the resource DefinitionThe 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.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules Short descriptionA set of rules under which this content was created DefinitionA 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.
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.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
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).
code BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
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.
Narrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
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.
Resource Mappings |
| extension | C | 0..* | Extension | Element idFamilyMemberHistory.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension SlicingUnordered, 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 |
| associatedEncounter | C | 0..1 | Extension(Reference(Encounter)) | Element idFamilyMemberHistory.extension:associatedEncounter Short descriptionAn associated encounter reference. Alternate namesextensions, user content DefinitionAn associated encounter reference.
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.
Extension(Reference(Encounter)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| participantR5 | C | 0..* | Extension(Complex) | Element idFamilyMemberHistory.extension:participantR5 Short descriptionWho or what participated in the activities related to the family member history. This is a R5 backport. Alternate namesextensions, user content DefinitionAn extension to record who or what participated in the activities related to the family member history.
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.
Extension(Complex) Extension URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| id | | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 1..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| function | C | 0..1 | ExtensionBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function Short descriptionThe type of involvement in the activities related to the family member history. Alternate namesextensions, user content DefinitionDistinguishes the type of involvement of the actor in the activities related to the family member history.
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.
Extension BindingParticipationRoleType (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| id | | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:function.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Auto valuefunction Mappings |
| value[x] | | 1..1 | | Element idFamilyMemberHistory.extension:participantR5.extension:function.value[x] Short descriptionThe type of involvement in the activities related to the family member history DefinitionThis FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes referred to the agent functional-role relative to the activity.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| valueCodeableConcept | | | CodeableConcept | There are no (further) constraints on this element Data typeCodeableConcept |
| actor | C | 1..1 | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor Short descriptionWho or what participated in the activities related to the family member history. Alternate namesextensions, user content DefinitionIndicates who or what participated in the activities related to the family member history.
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.
Extension ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| id | | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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.
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.
Extension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 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 |
| url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.extension:actor.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Auto valueactor Mappings |
| value[x] | | 1..1 | | Element idFamilyMemberHistory.extension:participantR5.extension:actor.value[x] Short descriptionWho or what participated in the activities related to the family member history DefinitionA reference to a Patient, Practitioner, PractitionerRole, RelatedPerson, Device, Organization, or CareTeam.
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| valueReference | | | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Organization | CareTeam) | There are no (further) constraints on this element Data typeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Organization | CareTeam) |
| url | | 1..1 | uriAuto Value | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.url Short descriptionidentifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
uri Auto valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant Mappings |
| value[x] | | 0..0 | | There are no (further) constraints on this element Element idFamilyMemberHistory.extension:participantR5.value[x] Short descriptionValue of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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).
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.
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.
Extension 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 idFamilyMemberHistory.identifier Short descriptionExternal Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers.
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.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.identifier
- w5: FiveWs.identifier
- rim: id
|
| instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Short descriptionInstantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.instantiatesCanonical
- rim: .outboundRelationship[typeCode=DEFN].target
|
| instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Short descriptionInstantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.
This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.instantiatesUri
- rim: .outboundRelationship[typeCode=DEFN].target
|
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status Short descriptionpartial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member.
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
code BindingA code that identifies the status of the family history record.
FamilyHistoryStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.status
- w5: FiveWs.status
|
| dataAbsentReason | Σ | 0..1 | CodeableConceptBinding | Element idFamilyMemberHistory.dataAbsentReason Short descriptionsubject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available.
This is a separate element to allow it to have a distinct binding from reasonCode.
CodeableConcept BindingCodes describing the reason why a family member's history is not available.
FamilyHistoryAbsentReason (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| patient | S Σ | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idFamilyMemberHistory.patient Short descriptionPatient history is about Alternate namesProband DefinitionThe person who this history concerns.
Reference(Patient) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.subject
- w5: FiveWs.subject[x]
- rim: participation[typeCode=SBJ].role
- w5: FiveWs.subject
|
| date | S Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date Short descriptionWhen history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated.
Allows determination of how current the summary is.
This should be captured even if the same as the date on the List aggregating the full family history.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- w5: FiveWs.recorded
- rim: participation[typeCode=AUT].time
|
| name | S Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name Short descriptionThe family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
Allows greater ease in ensuring the same person is being talked about.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| relationship | S Σ | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.relationship Short descriptionRelationship to the subject DefinitionThe type of relationship this person has to the patient (father, mother, brother etc.).
CodeableConcept BindingThe nature of the relationship between the patient and the related person being described in the family member history.
UKCorePersonRelationshipType (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex Short descriptionmale | female | other | unknown DefinitionThe birth sex of the family member.
Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments.
This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.
CodeableConcept BindingCodes describing the sex assigned at birth as documented on the birth registration.
AdministrativeGender (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| born[x] | C | 0..1 | | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] Short description(approximate) date of birth DefinitionThe actual or approximate date of birth of the relative.
Allows calculation of the relative's age.
The cardinality or value of this element may be affected by these constraints: fhs-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)
|
| bornPeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
| bornDate | | | date | There are no (further) constraints on this element Data typedate |
| bornString | | | string | There are no (further) constraints on this element Data typestring |
| age[x] | Σ C | 0..1 | | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] Short description(approximate) age DefinitionThe age of the relative at the time the family member history is recorded.
While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians.
use estimatedAge to indicate whether the age is actual or not.
The cardinality or value of this element may be affected by these constraints: fhs-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code="age"].value
|
| ageAge | | | Age | There are no (further) constraints on this element Data typeAge |
| ageRange | | | Range | There are no (further) constraints on this element Data typeRange |
| ageString | | | string | There are no (further) constraints on this element Data typestring |
| estimatedAge | Σ C | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Short descriptionAge is estimated? DefinitionIf true, indicates that the age value specified is an estimated value.
Clinicians often prefer to specify an estimaged age rather than an age range.
This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age.
It is unknown whether the age is an estimate or not
boolean ConditionsThe cardinality or value of this element may be affected by these constraints: fhs-2 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| deceased[x] | Σ | 0..1 | | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Short descriptionDead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG) For age, you'd hang an observation off the role
|
| deceasedBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
| deceasedAge | | | Age | There are no (further) constraints on this element Data typeAge |
| deceasedRange | | | Range | There are no (further) constraints on this element Data typeRange |
| deceasedDate | | | date | There are no (further) constraints on this element Data typedate |
| deceasedString | | | string | There are no (further) constraints on this element Data typestring |
| reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Short descriptionWhy was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form.
Textual reasons can be captured using reasonCode.text.
CodeableConcept BindingCodes indicating why the family member history was done.
SNOMEDCTClinicalFindings (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.reasonCode
- w5: FiveWs.why[x]
- rim: .reasonCode
|
| reasonReference | Σ | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Short descriptionWhy was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.reasonReference
- w5: FiveWs.why[x]
- rim: .outboundRelationship[typeCode=RSON].target
|
| note | | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.note Short descriptionGeneral note about related person DefinitionThis property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
Annotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.note
- rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
|
| condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Short descriptionCondition that the related person had DefinitionThe significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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.
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.
Extension 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 |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
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.
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.
Extension 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 |
| code | | 1..1 | CodeableConceptBinding | Element idFamilyMemberHistory.condition.code Short descriptionCondition suffered by relation DefinitionThe actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.
CodeableConcept BindingIdentification of the Condition or diagnosis.
Condition/Problem/DiagnosisCodes (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| outcome | | 0..1 | CodeableConceptBinding | Element idFamilyMemberHistory.condition.outcome Short descriptiondeceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation.
CodeableConcept BindingThe result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
ConditionOutcomeCodes (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value
|
| contributedToDeath | | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Short descriptionWhether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| onset[x] | | 0..1 | | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.onset[x] Short descriptionWhen condition first manifested DefinitionEither the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
Age of onset of a condition in relatives is predictive of risk for the patient.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="Subject Age at measurement", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS'] Use originalText for string
|
| onsetAge | | | Age | There are no (further) constraints on this element Data typeAge |
| onsetRange | | | Range | There are no (further) constraints on this element Data typeRange |
| onsetPeriod | | | Period | There are no (further) constraints on this element Data typePeriod |
| onsetString | | | string | There are no (further) constraints on this element Data typestring |
| note | | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Short descriptionExtra information about condition DefinitionAn area where general notes can be placed about this specific condition.
Annotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value
|
