Profile: CareConnect-FamilyMemberHistory
CareConnect-FamilyMemberHistory-1 (FamilyMemberHistory) | C | FamilyMemberHistory | |
id | Σ | 0..1 | id |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | C | 0..1 | Narrative |
contained | 0..* | Resource | |
extension | 0..* | Extension | |
recorder | C | 0..1 | Extension(Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1)) |
encounter | C | 0..1 | Extension(Reference(Encounter)) |
modifierExtension | ?! | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
id | 0..1 | string | |
extension | 0..* | Extension | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) |
definition | Σ | 0..* | Reference(PlanDefinition | Questionnaire) |
status | Σ ?! | 1..1 | codeBinding |
notDone | Σ ?! | 0..1 | boolean |
notDoneReason | Σ C | 0..1 | CodeableConcept |
patient | Σ | 1..1 | Reference(CareConnect-Patient-1) |
date | Σ | 0..1 | dateTime |
name | Σ | 0..1 | string |
relationship | Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
gender | Σ | 0..1 | codeBinding |
born[x] | C | 0..1 | |
bornPeriod | Period | ||
bornDate | date | ||
bornString | string | ||
age[x] | Σ C | 0..1 | |
ageAge | Age | ||
ageRange | Range | ||
ageString | string | ||
estimatedAge | Σ ?! C | 0..1 | boolean |
deceased[x] | Σ | 0..1 | |
deceasedBoolean | boolean | ||
deceasedAge | Age | ||
deceasedRange | Range | ||
deceasedDate | date | ||
deceasedString | string | ||
reasonCode | Σ | 0..* | CodeableConcept |
reasonReference | Σ | 0..* | Reference(QuestionnaireResponse | CareConnect-Observation-1 | CareConnect-Condition-1 | CareConnect-AllergyIntolerance-1) |
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string | |
condition | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | 0..* | Extension | |
modifierExtension | Σ ?! | 0..* | Extension |
code | 1..1 | CodeableConcept | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
outcome | 0..1 | CodeableConcept | |
id | 0..1 | string | |
extension | 0..* | Extension | |
coding | Σ | 0..* | Coding |
snomedCT | Σ | 0..1 | Coding |
id | 0..1 | string | |
extension | 0..* | Extension | |
snomedCTDescriptionID | C | 0..1 | Extension(Complex) |
system | Σ | 1..1 | uriAuto Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
onset[x] | 0..1 | ||
onsetAge | Age | ||
onsetRange | Range | ||
onsetPeriod | Period | ||
onsetString | string | ||
note | 0..* | Annotation | |
id | 0..1 | string | |
extension | 0..* | Extension | |
author[x] | Σ | 0..1 | |
authorString | string | ||
authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | ||
time | Σ | 0..1 | dateTime |
text | 1..1 | string |
FamilyMemberHistory | |||
Short | Information about patient's relatives, relevant for patient | ||
Definition | Significant health events and conditions for a person related to the patient relevant in the context of care for the patient. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.id | |||
Short | Logical id of this artifact | ||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||
Cardinality | 0..1 | ||
Type | id | ||
Summary | True | ||
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. | ||
FamilyMemberHistory.meta | |||
Short | Metadata about the resource | ||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
Cardinality | 0..1 | ||
Type | Meta | ||
Summary | True | ||
FamilyMemberHistory.implicitRules | |||
Short | A set of rules under which this content was created | ||
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. | ||
Cardinality | 0..1 | ||
Type | uri | ||
Modifier | True | ||
Summary | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
FamilyMemberHistory.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language. Binding extensions
| ||
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). | ||
FamilyMemberHistory.text | |||
Short | Text summary of the resource, for human interpretation | ||
Definition | A human-readable narrative that contains a summary of the resource, and may 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. | ||
Cardinality | 0..1 | ||
Type | Narrative | ||
Alias | 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 in formation is added later. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: dom-1 | ||
Mappings |
| ||
FamilyMemberHistory.contained | |||
Short | Contained, inline Resources | ||
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. | ||
Cardinality | 0..* | ||
Type | Resource | ||
Alias | 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. | ||
Mappings |
| ||
FamilyMemberHistory.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) | ||
Mappings |
| ||
FamilyMemberHistory.extension:recorder | |||
Short | Who recorded the event | ||
Definition | Who recorded the event. | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1)) | ||
Alias | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.extension:encounter | |||
Short | Associated Encounter | ||
Definition | This encounter occurs within the scope of the referenced encounter. | ||
Cardinality | 0..1 | ||
Type | Extension(Reference(Encounter)) | ||
Alias | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
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. Usually modifier elements provide negation or qualification. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Alias | 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. | ||
Mappings |
| ||
FamilyMemberHistory.identifier | |||
Short | External Id(s) for this record | ||
Definition | This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Summary | True | ||
Requirements | Need to allow connection to a wider workflow. | ||
Mappings |
| ||
FamilyMemberHistory.identifier.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.identifier.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.identifier.use | |||
Short | usual | official | temp | secondary (If known) | ||
Definition | The purpose of this identifier. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | Identifies the purpose for this identifier, if known . | ||
Modifier | True | ||
Summary | True | ||
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||
Mappings |
| ||
FamilyMemberHistory.identifier.type | |||
Short | Description of identifier | ||
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||
Summary | True | ||
Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||
Mappings |
| ||
FamilyMemberHistory.identifier.system | |||
Short | The namespace for the identifier value | ||
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||
Cardinality | 1..1 | ||
Type | uri | ||
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. | ||
Examples | Generalhttp://www.acme.com/identifiers/patient | ||
Mappings |
| ||
FamilyMemberHistory.identifier.value | |||
Short | The value that is unique | ||
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
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. | ||
Examples | General123456 | ||
Mappings |
| ||
FamilyMemberHistory.identifier.period | |||
Short | Time period when id is/was valid for use | ||
Definition | Time period during which identifier is/was valid for use. | ||
Cardinality | 0..1 | ||
Type | Period | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.identifier.assigner | |||
Short | Organization that issued id (may be just text) | ||
Definition | Organization that issued/manages the identifier. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-Organization-1) | ||
Summary | True | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.definition | |||
Short | Instantiates protocol or definition | ||
Definition | A protocol or questionnaire that was adhered to in whole or in part by this event. | ||
Cardinality | 0..* | ||
Type | Reference(PlanDefinition | Questionnaire) | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.status | |||
Short | partial | completed | entered-in-error | health-unknown | ||
Definition | A code specifying the status of the record of the family history of a specific family member. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | A code that identifies the status of the family history record. | ||
Modifier | True | ||
Summary | True | ||
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||
Mappings |
| ||
FamilyMemberHistory.notDone | |||
Short | The taking of a family member's history did not occur | ||
Definition | If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Requirements | Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task. | ||
Comments | This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release. | ||
Default value | false | ||
Mappings |
| ||
FamilyMemberHistory.notDoneReason | |||
Short | subject-unknown | withheld | unable-to-obtain | deferred | ||
Definition | Describes why the family member's history is absent. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | Codes describing the reason why a family member history was not done. | ||
Summary | True | ||
Requirements | This is a separate element to allow it to have a distinct binding from reasonCode. | ||
Comments | This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason). | ||
Conditions | The cardinality or value of this element may be affected by these constraints: fhs-3 | ||
Mappings |
| ||
FamilyMemberHistory.patient | |||
Short | Patient history is about | ||
Definition | The person who this history concerns. | ||
Cardinality | 1..1 | ||
Type | Reference(CareConnect-Patient-1) | ||
Summary | True | ||
Alias | Proband | ||
Mappings |
| ||
FamilyMemberHistory.date | |||
Short | When history was captured/updated | ||
Definition | The date (and possibly time) when the family member history was taken. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Requirements | Allows determination of how current the summary is. | ||
Comments | This should be captured even if the same as the date on the List aggregating the full family history. | ||
Mappings |
| ||
FamilyMemberHistory.name | |||
Short | The family member described | ||
Definition | This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Allows greater ease in ensuring the same person is being talked about. | ||
Mappings |
| ||
FamilyMemberHistory.relationship | |||
Short | Relationship to the subject | ||
Definition | The type of relationship this person has to the patient (father, mother, brother etc.). | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | The nature of the relationship between the patient and the related person being described in the family member history. | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.relationship.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.relationship.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
FamilyMemberHistory.relationship.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
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. | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.relationship.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
FamilyMemberHistory.gender | |||
Short | male | female | other | unknown | ||
Definition | Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The gender of a person used for administrative purposes. | ||
Summary | True | ||
Requirements | Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments. | ||
FamilyMemberHistory.born[x] | |||
Short | (approximate) date of birth | ||
Definition | The actual or approximate date of birth of the relative. | ||
Cardinality | 0..1 | ||
Type | Period, date, string | ||
Requirements | Allows calculation of the relative's age. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: fhs-1 | ||
Mappings |
| ||
FamilyMemberHistory.age[x] | |||
Short | (approximate) age | ||
Definition | The age of the relative at the time the family member history is recorded. | ||
Cardinality | 0..1 | ||
Type | Age, Range, string | ||
Summary | True | ||
Requirements | While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians. | ||
Comments | use estimatedAge to indicate whether the age is actual or not. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: fhs-1 | ||
Mappings |
| ||
FamilyMemberHistory.estimatedAge | |||
Short | Age is estimated? | ||
Definition | If true, indicates that the age value specified is an estimated value. | ||
Cardinality | 0..1 | ||
Type | boolean | ||
Modifier | True | ||
Summary | True | ||
Requirements | Clinicians often prefer to specify an estimaged age rather than an age range. | ||
Comments | This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age. | ||
Meaning when missing | It is unknown whether the age is an estimate or not | ||
Conditions | The cardinality or value of this element may be affected by these constraints: fhs-2 | ||
FamilyMemberHistory.deceased[x] | |||
Short | Dead? How old/when? | ||
Definition | Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. | ||
Cardinality | 0..1 | ||
Type | boolean, Age, Range, date, string | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.reasonCode | |||
Short | Why was family member history performed? | ||
Definition | Describes why the family member history occurred in coded or textual form. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | Codes indicating why the family member history was done. | ||
Summary | True | ||
Comments | Textual reasons can be caprued using reasonCode.text. | ||
Mappings |
| ||
FamilyMemberHistory.reasonReference | |||
Short | Why was family member history performed? | ||
Definition | Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. | ||
Cardinality | 0..* | ||
Type | Reference(QuestionnaireResponse | CareConnect-Observation-1 | CareConnect-Condition-1 | CareConnect-AllergyIntolerance-1) | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.note | |||
Short | General note about related person | ||
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. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Mappings |
| ||
FamilyMemberHistory.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1), string | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition | |||
Short | Condition that the related person had | ||
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. | ||
Cardinality | 0..* | ||
Type | BackboneElement | ||
Comments | If none of the conditions listed have an outcome of "death" specified, that indicates that none of the specified conditions are known to have been the primary cause of death. | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.condition.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
Definition | May 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Modifier | True | ||
Summary | True | ||
Alias | extensions, user content, modifiers | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code | |||
Short | Condition suffered by relation | ||
Definition | The 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. | ||
Cardinality | 1..1 | ||
Type | CodeableConcept | ||
Binding | Identification of the Condition or diagnosis. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
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. | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.code.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome | |||
Short | deceased | permanent disability | etc. | ||
Definition | Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation. | ||
Cardinality | 0..1 | ||
Type | CodeableConcept | ||
Binding | The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..* | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
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. | ||
Slicing | Unordered, Open, by system(Value) | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT | |||
Short | Code defined by a terminology system | ||
Definition | A reference to a code defined by a terminology system. | ||
Cardinality | 0..1 | ||
Type | Coding | ||
Summary | True | ||
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.extension:snomedCTDescriptionID | |||
Short | The SNOMED CT Description ID for the display | ||
Definition | The SNOMED CT Description ID for the display. | ||
Cardinality | 0..1 | ||
Type | Extension(Complex) | ||
Alias | 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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
Constraints |
| ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.system | |||
Short | Identity of the terminology system | ||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||
Cardinality | 1..1 | ||
Type | uri | ||
Summary | True | ||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||
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 de-reference to some definition that establish the system clearly and unambiguously. | ||
Auto Value | http://snomed.info/sct | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.version | |||
Short | Version of the system - if relevant | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.code | |||
Short | Symbol in syntax defined by the system | ||
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). | ||
Cardinality | 1..1 | ||
Type | code | ||
Summary | True | ||
Requirements | Need to refer to a particular code in the system. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.display | |||
Short | Representation defined by the system | ||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||
Cardinality | 1..1 | ||
Type | string | ||
Summary | True | ||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.coding:snomedCT.userSelected | |||
Short | If this coding was chosen directly by the user | ||
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). | ||
Cardinality | 0..1 | ||
Type | boolean | ||
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. | ||
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. | ||
Mappings |
| ||
FamilyMemberHistory.condition.outcome.text | |||
Short | Plain text representation of the concept | ||
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. | ||
Cardinality | 0..1 | ||
Type | string | ||
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. | ||
Comments | Very often the text is the same as a displayName of one of the codings. | ||
Mappings |
| ||
FamilyMemberHistory.condition.onset[x] | |||
Short | When condition first manifested | ||
Definition | Either 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. | ||
Cardinality | 0..1 | ||
Type | Age, Range, Period, string | ||
Requirements | Age of onset of a condition in relatives is predictive of risk for the patient. | ||
Mappings |
| ||
FamilyMemberHistory.condition.note | |||
Short | Extra information about condition | ||
Definition | An area where general notes can be placed about this specific condition. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Mappings |
| ||
FamilyMemberHistory.condition.note.id | |||
Short | xml:id (or equivalent in JSON) | ||
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
Cardinality | 0..1 | ||
Type | string | ||
Mappings |
| ||
FamilyMemberHistory.condition.note.extension | |||
Short | Additional Content defined by implementations | ||
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||
Cardinality | 0..* | ||
Type | Extension | ||
Alias | 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. | ||
Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
Mappings |
| ||
FamilyMemberHistory.condition.note.author[x] | |||
Short | Individual responsible for the annotation | ||
Definition | The individual responsible for making the annotation. | ||
Cardinality | 0..1 | ||
Type | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1), string | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.condition.note.time | |||
Short | When the annotation was made | ||
Definition | Indicates when this particular annotation was made. | ||
Cardinality | 0..1 | ||
Type | dateTime | ||
Summary | True | ||
Mappings |
| ||
FamilyMemberHistory.condition.note.text | |||
Short | The annotation - text content | ||
Definition | The text of the annotation. | ||
Cardinality | 1..1 | ||
Type | string | ||
Mappings |
|
Data model element usage
Element | Use | CareConnect (STU3) | UK Core (R4) |
---|---|---|---|
extension(recorder) | |||
extension(encounter) | |||
identifier | |||
definition | |||
status | |||
notDone | |||
notDoneReason | |||
patient | |||
date | |||
name | |||
relationship | |||
gender | |||
born[x] | |||
age[x] | |||
estimatedAge | |||
deceased[x] | |||
reasonCode | |||
reasonReference | |||
note | |||
condition |
extension(recorder)
Usage Mandatory
Guidance The person who entered the record on the system. The table below outlines requester and recorder combinations for clarity.
Scenario Requester Recorder Prescibing clinician Fred is requesting new medication Fred Fred Prescibing clinician Fred is re-ordering previous medication he previously prescribed Fred Fred Prescibing clinician Jane is re-ordering previous medication, without any clinical changes, that Fred previously prescribed Fred Jane Prescibing clinician Jane is re-ordering previous medication that Fred previously prescribed, with clinical changes Jane Jane Nurse Rodger is ordering medication prescribed by Fred Fred Rodger Pharmacy technical Sally is re-ordering medication prescribed by Fred Fred Sally Example
<recorder> <identifier> <system value="https://fhir.hl7.org.uk/Id/gmc-number" /> <value value="0054272" /> </identifier> </recorder>
extension(encounter)
Usage
Optional
Guidance
Reference to the Encounter
profile providing the context for the consultation (Date/Doctor/Place ….)
The Encounter reference is provided by all Lists in the structure rather than the top-level List(Consultation) only.
Example
<encounter> <reference value="encounter-12iaq" /> </encounter>
identifier
Usage
Required
Guidance
External Id(s) for this record
Example
<identifier> <system value="https://foo.bar/id/familymemberhistory" /> <value value="fef26348-ccd1-440b-940e-ba1ec058cf21" /> </identifier>
definition
Usage
Mandatory
Guidance
A protocol or questionnaire that was adhered to in whole or in part by this event.
Reference ( PlanDefinition | Questionnaire )
Example
<patient> <reference value="questionnaire-9929ppp" /> </patient>
status
Usage
Optional
Guidance
The status of the family history
e.g. partial | completed | entered-in-error | health-unknown.
Example
<status> <code value="completed" /> <display value="completed " /> </status>
notDone
Usage
Optional
Guidance
The taking of a family member's history did not occur - Boolean - True | False
Example
<notDone value="True" />
notDoneReason
Usage
Optional
Guidance
The status of the family history
e.g. subject-unknown | withheld | unable-to-obtain | deferred. obtai
Example
<status> <code value="withheld" /> <display value="withheld " /> </status>
patient
Usage
Mandatory
Guidance
A reference to the patient who the Family History relates to
Profile: CareConnect-GPC-Patient-1
Example
<patient> <reference value="patient-9929alp" /> </patient>
date
Usage
Optional
Guidance
The date
element should contain the date the family history was taken.
name
Usage
Optional
Guidance
The family member described
Example
<name> <family value="Black"/> <given value="Sarah"/> <prefix value="Mrs"/> </name>
relationship
Usage
Mandatory
Guidance
- The coded value for relationship to the person.
Example
<code> <coding> <system value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" /> <code value="SONFOST" /> <display value="foster son" /> </coding> </code>
gender
Usage
Optional
Guidance
This element should be populated where available.
Example
<gender value="female"/>
born[x]
Usage
Required
Guidance
(approximate) date of birth.
Example
<bornPeriod> <start value="2022-10-28T13:38:00+00:00" /> <end value="2024-10-28T13:38:00+00:00" /> </bornPeriod> <bornDate value="2024-10-28T13:38:00+00:00" /> <bornString value="28th October 22/23/24?" />
age[x]
Usage
Required
Guidance
(approximate) age
Example
<age value="88" /> <Range> <low value="84" /> <high value="92" /> </Range> <String value="Suspected to be 88" />
estimatedAge
Usage
Optional
Guidance
Age is estimate ? - Boolean - True | False
Example
<estimatedAge value="True" />
deceased[x]
Usage
Optional
Guidance
Patient is deceased - Boolean - True | False
Example
<deceasedBoolean value="false"/>
reasonCode
Usage
Optional
Guidance
The reasonCode
describes why the family member history occurred in coded or textual form.
Example
<reasonCode> <coding> <system value="http://snomed.info/sct" /> <code value="195967001" /> <display value="Asthma (disorder)" /> </coding> </reasonCode>
reasonReference
Usage
Optional
Guidance
Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse)
Example
<reasonReference> <reference value="condition--00f39ds" /> </reasonReference>
note
Usage
Required
Guidance
Any notes relating to the specified specimen.
Example
<note> <author> <reference value="practitioner-948392" /> </author> <time value="2022-10-13T16:59:00Z" /> <text> Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM). </text> </note>
condition
Usage
Optional
Guidance
The date
element should contain the date the family history was taken.
Example
<condition> <code> <coding> <system value="http://snomed.info/sct"/> <code value="22298006"/> <display value="Myocardial Infarction"/> </coding> <text value="Heart Attack"/> </code> <contributedToDeath value="true"/> <onsetAge> <value value="74"/> <unit value="yr"/> <system value="http://unitsofmeasure.org"/> <code value="a"/> </onsetAge> ``` ---