Guía implementación interoperabilidad FHIR sectorial e intersectorial
0.10.1 - ci-build
Guía implementación interoperabilidad FHIR sectorial e intersectorial - Local Development build (v0.10.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Definiciones para ProfileFamilyMemberHistoryHCEU resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. FamilyMemberHistory | |||||
| Definition | Significant health conditions for a person related to the patient relevant in the context of care for the patient. | ||||
| Short | Information about patient's relatives, relevant for patient | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 2. FamilyMemberHistory.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. FamilyMemberHistory.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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. FamilyMemberHistory.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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. FamilyMemberHistory.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. FamilyMemberHistory.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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. FamilyMemberHistory.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. | ||||
| Short | Contained, inline 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. FamilyMemberHistory.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..1 | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on FamilyMemberHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. FamilyMemberHistory.extension:genderIdentity | |||||
| Slice Name | genderIdentity | ||||
| Definition | Gender with which the patient identifies. | ||||
| Short | Gender patient | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Gender patient) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 18. FamilyMemberHistory.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). | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 20. FamilyMemberHistory.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. ☛ El sistema de codificación es un campo opcional y en esta caso esta definido por los catálogos de los sistemas de atención clínica donde se crean los registros clínicos; se recomienda que dicho manejo sea controlado por las fuentes de forma tal que se pueda identificar de forma univoca cada registro de condición clínica asociada al paciente | ||||
| Short | External Id(s) for this record | ||||
| 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| Slicing | This element introduces a set of slices on FamilyMemberHistory.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 22. FamilyMemberHistory.identifier:HISdentifier | |||||
| Slice Name | HISdentifier | ||||
| Definition | Identificador del registro en el HIS origen | ||||
| Short | External Id(s) for this record | ||||
| 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. FamilyMemberHistory.identifier:HISdentifier.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 26. FamilyMemberHistory.identifier:HISdentifier.extension | |||||
| Definition | May 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on FamilyMemberHistory.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 28. FamilyMemberHistory.identifier:HISdentifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Fixed Value | usual | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. FamilyMemberHistory.identifier:HISdentifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| 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. | ||||
| Control | 0..0 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. FamilyMemberHistory.identifier:HISdentifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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. | ||||
| Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient <br/><b>HIS uri</b>:http://hospitalSystemInformation.example.org/FamilyMemberHistories/ | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 34. FamilyMemberHistory.identifier:HISdentifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. A pesar de que se pueden asociar multiples identificadores canonicos al recurso, se recomienda tener un valor unico tipo GUID, OID o con llaves compuestas | ||||
| Short | The value that is unique | ||||
| 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. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>General</b>:123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. FamilyMemberHistory.identifier:HISdentifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..0 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. FamilyMemberHistory.identifier:HISdentifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| 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. | ||||
| Control | 0..0 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. FamilyMemberHistory.instantiatesCanonical | |||||
| Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. | ||||
| Short | Instantiates FHIR protocol or definition | ||||
| Control | 0..0 | ||||
| Type | canonical(PlanDefinition, Questionnaire, ActivityDefinition, Measure, OperationDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. FamilyMemberHistory.instantiatesUri | |||||
| Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. | ||||
| Short | Instantiates external protocol or definition | ||||
| Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. | ||||
| Control | 0..0 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. FamilyMemberHistory.status | |||||
| Definition | A code specifying the status of the record of the family history of a specific family member. Solo se permiten los valores "completed", se tiene disponible toda la información clínica del familiar o en su defecto o una parte de la misma (valor "partial"). Los demas posibles NO son permitidos | ||||
| Short | completed | partial | ||||
| Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Solo se permiten los valores "completed", se tiene disponible toda la información clínica del familiar o en su defecto o una parte de la misma (valor "partial"). Los demas posibles NO son permitidos | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from FamilyHistoryStatus (required to http://hl7.org/fhir/ValueSet/history-status|4.0.1)A code that identifies the status of the family history record. | ||||
| Type | code | ||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | <br/><b>ej</b>:partial <br/><b>ej2</b>:completed | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. FamilyMemberHistory.dataAbsentReason | |||||
| Definition | Describes why the family member's history is not available. | ||||
| Short | subject-unknown | withheld | unable-to-obtain | deferred | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see FamilyHistoryAbsentReason (example to http://hl7.org/fhir/ValueSet/history-absent-reason)Codes describing the reason why a family member's history is not available. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | This is a separate element to allow it to have a distinct binding from reasonCode. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. FamilyMemberHistory.patient | |||||
| Definition | The person who this history concerns. | ||||
| Short | Patient history is about | ||||
| Control | 1..1 | ||||
| Type | Reference(HCEU - Patient) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | Proband | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. FamilyMemberHistory.date | |||||
| Definition | The date (and possibly time) when the family member history was recorded or last updated. | ||||
| Short | When history was recorded or last updated | ||||
| Comments | This should be captured even if the same as the date on the List aggregating the full family history. | ||||
| Control | 0..0 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows determination of how current the summary is. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. FamilyMemberHistory.name | |||||
| Definition | This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". | ||||
| Short | The family member described | ||||
| Control | 0..0 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows greater ease in ensuring the same person is being talked about. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. FamilyMemberHistory.relationship | |||||
| Definition | The type of relationship this person has to the patient (father, mother, brother etc.). | ||||
| Short | Relationship to the subject | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see FamilyMember (example to http://terminology.hl7.org/ValueSet/v3-FamilyMember)The nature of the relationship between the patient and the related person being described in the family member history. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Example | <br/><b>ej</b>:{ "coding" : [{ "system" : "https://hl7.org/fhir/R4/v3/FamilyMember/vs.html", "code" : "BRO", "display" : "Brother" }] } | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. FamilyMemberHistory.sex | |||||
| Definition | The birth sex of the family member. | ||||
| Short | male | female | other | unknown | ||||
| Comments | 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. | ||||
| Control | 0..0 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from AdministrativeGender (extensible to http://hl7.org/fhir/ValueSet/administrative-gender)Codes describing the sex assigned at birth as documented on the birth registration. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. FamilyMemberHistory.born[x] | |||||
| Definition | The actual or approximate date of birth of the relative. | ||||
| Short | (approximate) date of birth | ||||
| Control | 0..1 This element is affected by the following invariants: fhs-1 | ||||
| Type | Choice of: Period, date, string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | Allows calculation of the relative's age. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. FamilyMemberHistory.age[x] | |||||
| Definition | The age of the relative at the time the family member history is recorded. | ||||
| Short | (approximate) age | ||||
| Comments | use estimatedAge to indicate whether the age is actual or not. | ||||
| Control | 0..1 This element is affected by the following invariants: fhs-1 | ||||
| Type | Choice of: Age, Range, string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. FamilyMemberHistory.estimatedAge | |||||
| Definition | If true, indicates that the age value specified is an estimated value. | ||||
| Short | Age is estimated? | ||||
| Comments | 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. | ||||
| Control | 0..1 This element is affected by the following invariants: fhs-2 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Clinicians often prefer to specify an estimaged age rather than an age range. | ||||
| Meaning if Missing | It is unknown whether the age is an estimate or not | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. FamilyMemberHistory.deceased[x] | |||||
| Definition | Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. | ||||
| Short | Dead? How old/when? | ||||
| Control | 0..1 | ||||
| Type | Age | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. FamilyMemberHistory.reasonCode | |||||
| Definition | Describes why the family member history occurred in coded or textual form. | ||||
| Short | Why was family member history performed? | ||||
| Comments | Textual reasons can be captured using reasonCode.text. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see SNOMEDCTClinicalFindings (example to http://hl7.org/fhir/ValueSet/clinical-findings)Codes indicating why the family member history was done. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. FamilyMemberHistory.reasonCode.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 70. FamilyMemberHistory.reasonCode.extension | |||||
| Definition | May 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on FamilyMemberHistory.reasonCode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 72. FamilyMemberHistory.reasonCode.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 1..1 | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. FamilyMemberHistory.reasonCode.coding.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 76. FamilyMemberHistory.reasonCode.coding.extension | |||||
| Definition | May 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on FamilyMemberHistory.reasonCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 78. FamilyMemberHistory.reasonCode.coding.system | |||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
| Short | Identity of the terminology system | ||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
| Control | 1..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
| Fixed Value | https://icd.who.int/browse/2024-01/mms/es | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. FamilyMemberHistory.reasonCode.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version of the system - if relevant | ||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
| Note | This is a business version Id, not a resource version Id (see discussion) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 82. FamilyMemberHistory.reasonCode.coding.code | |||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
| Short | Symbol in syntax defined by the system | ||||
| Control | 1..1 | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to refer to a particular code in the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. FamilyMemberHistory.reasonCode.coding.display | |||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
| Short | Representation defined by the system | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. FamilyMemberHistory.reasonCode.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If this coding was chosen directly by the user | ||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. FamilyMemberHistory.reasonCode.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. FamilyMemberHistory.reasonReference | |||||
| Definition | Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. | ||||
| Short | Why was family member history performed? | ||||
| Control | 0..* | ||||
| Type | Reference(HCEU - Condition, HCEU - Intramural - Observation, HCEU - Allergy Intolerance, HCEU - Diagnostic Report) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. FamilyMemberHistory.note | |||||
| Definition | This 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. | ||||
| Short | General note about related person | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. FamilyMemberHistory.condition | |||||
| Definition | The 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. | ||||
| Short | Condition that the related person had | ||||
| Control | 0..0 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||