Profile: FamilyMemberHistory
PS-AB Simplifier Project Page: package/StructureDefinition-FamilyMemberHistoryPSAB.json
Derived from PS-CA FamilyMemberHistory
Views of Profile Content
FamilyMemberHistory | I | FamilyMemberHistory | Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient. FamilyMemberHistory resources included in Alberta Patient Summary Document Bundles have rules that certain attributes are not to be contained in FamilyMemberHistory resource. These are mechanically enforced through invariants at the PS-AB Bundle level.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record.
|
dataAbsentReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available.
|
patient | S Σ I | 1..1 | Reference(package/StructureDefinition-PatientPSAB.json) | Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(package/StructureDefinition-PatientPSAB.json) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date When history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relationship | S Σ | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.jsonBinding | Element idFamilyMemberHistory.relationship Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingThe nature of the relationship between the patient and the related person being described in the family member history.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | package/structuredefinition-profile-coding-ca-ps.json | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.coding A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. While the IPS-UV specification considers this a Must Support element, some systems will not have the ability to support codings for every codeableConcept, further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance. Implementers that support codings should still send the codings for codeable concepts if they are available and receivers should not produce failures or rejections if codings are included in the patient summary in the first release (a base tenet of FHIR). Additionally vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content package/structuredefinition-profile-coding-ca-ps.json Constraints
|
text | S Σ | 1..1 | string | Element idFamilyMemberHistory.relationship.text Plain text representation of the concept DefinitionA 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. 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. The full label of the family relationship (e.g., 'brother', 'sister', 'grandmother', etc.). Abbreviations are not allowed, to avoid confusion or misinterpretation. String: Max Character length (20) Required if a family history condition or characteristic is submitted.
|
sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration.
|
born[x] | I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
bornPeriod | Period | There are no (further) constraints on this element Data type | ||
bornDate | date | There are no (further) constraints on this element Data type | ||
bornString | string | There are no (further) constraints on this element Data type | ||
age[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
ageAge | Age | There are no (further) constraints on this element Data type | ||
ageRange | Range | There are no (further) constraints on this element Data type | ||
ageString | string | There are no (further) constraints on this element Data type | ||
estimatedAge | Σ I | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedAge | Age | There are no (further) constraints on this element Data type | ||
deceasedRange | Range | There are no (further) constraints on this element Data type | ||
deceasedDate | date | There are no (further) constraints on this element Data type | ||
deceasedString | string | There are no (further) constraints on this element Data type | ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints
|
note | S | 0..* | Annotation | Element idFamilyMemberHistory.note General note about related person DefinitionThis property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. Some form of note is required if family history data is being submitted. FamilyMemberHistory.note is used when the note cannot be distinctly tied to the condition property (i.e., familyMemberHistory.condition.note).
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.note.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | Element idFamilyMemberHistory.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Required if FamilyMemberHistory.note is populated. String: Max Character length (2000)
|
condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. . Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.json | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.code Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingIdentification of the Condition or diagnosis.
| |
outcome | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
| |
contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
| |
onset[x] | S | 1..1 | Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. Age of onset of a condition in relatives is predictive of risk for the patient. Required if a family history condition or characteristic is submitted. May contain a number (age or year), or a textual description of an age, age range or life stage. String: Max Character length (50)
| |
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
note | S | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | Element idFamilyMemberHistory.condition.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Required if FamilyMemberHistory.condition.note is populated. String: Max Character length (2000)
|
FamilyMemberHistory | I | FamilyMemberHistory | Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient. FamilyMemberHistory resources included in Alberta Patient Summary Document Bundles have rules that certain attributes are not to be contained in FamilyMemberHistory resource. These are mechanically enforced through invariants at the PS-AB Bundle level.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record.
|
dataAbsentReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available.
|
patient | S Σ I | 1..1 | Reference(package/StructureDefinition-PatientPSAB.json) | Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(package/StructureDefinition-PatientPSAB.json) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date When history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relationship | S Σ | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.jsonBinding | Element idFamilyMemberHistory.relationship Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingThe nature of the relationship between the patient and the related person being described in the family member history.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | package/structuredefinition-profile-coding-ca-ps.json | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.coding A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. While the IPS-UV specification considers this a Must Support element, some systems will not have the ability to support codings for every codeableConcept, further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance. Implementers that support codings should still send the codings for codeable concepts if they are available and receivers should not produce failures or rejections if codings are included in the patient summary in the first release (a base tenet of FHIR). Additionally vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content package/structuredefinition-profile-coding-ca-ps.json Constraints
|
text | S Σ | 1..1 | string | Element idFamilyMemberHistory.relationship.text Plain text representation of the concept DefinitionA 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. 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. The full label of the family relationship (e.g., 'brother', 'sister', 'grandmother', etc.). Abbreviations are not allowed, to avoid confusion or misinterpretation. String: Max Character length (20) Required if a family history condition or characteristic is submitted.
|
sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration.
|
born[x] | I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
bornPeriod | Period | There are no (further) constraints on this element Data type | ||
bornDate | date | There are no (further) constraints on this element Data type | ||
bornString | string | There are no (further) constraints on this element Data type | ||
age[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
ageAge | Age | There are no (further) constraints on this element Data type | ||
ageRange | Range | There are no (further) constraints on this element Data type | ||
ageString | string | There are no (further) constraints on this element Data type | ||
estimatedAge | Σ I | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedAge | Age | There are no (further) constraints on this element Data type | ||
deceasedRange | Range | There are no (further) constraints on this element Data type | ||
deceasedDate | date | There are no (further) constraints on this element Data type | ||
deceasedString | string | There are no (further) constraints on this element Data type | ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints
|
note | S | 0..* | Annotation | Element idFamilyMemberHistory.note General note about related person DefinitionThis property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. Some form of note is required if family history data is being submitted. FamilyMemberHistory.note is used when the note cannot be distinctly tied to the condition property (i.e., familyMemberHistory.condition.note).
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.note.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | Element idFamilyMemberHistory.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Required if FamilyMemberHistory.note is populated. String: Max Character length (2000)
|
condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. . Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.json | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.code Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingIdentification of the Condition or diagnosis.
| |
outcome | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
| |
contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
| |
onset[x] | S | 1..1 | Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. Age of onset of a condition in relatives is predictive of risk for the patient. Required if a family history condition or characteristic is submitted. May contain a number (age or year), or a textual description of an age, age range or life stage. String: Max Character length (50)
| |
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
note | S | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | Element idFamilyMemberHistory.condition.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Required if FamilyMemberHistory.condition.note is populated. String: Max Character length (2000)
|
FamilyMemberHistory | I | FamilyMemberHistory | Element idFamilyMemberHistory Information about patient's relatives, relevant for patient DefinitionSignificant health conditions for a person related to the patient relevant in the context of care for the patient. FamilyMemberHistory resources included in Alberta Patient Summary Document Bundles have rules that certain attributes are not to be contained in FamilyMemberHistory resource. These are mechanically enforced through invariants at the PS-AB Bundle level.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idFamilyMemberHistory.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idFamilyMemberHistory.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idFamilyMemberHistory.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.identifier External Id(s) for this record DefinitionBusiness identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the family member history as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesCanonical Instantiates FHIR protocol or definition DefinitionThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Constraints
|
instantiatesUri | Σ | 0..* | uri | There are no (further) constraints on this element Element idFamilyMemberHistory.instantiatesUri Instantiates external protocol or definition DefinitionThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory. This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.status partial | completed | entered-in-error | health-unknown DefinitionA code specifying the status of the record of the family history of a specific family member. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code that identifies the status of the family history record.
|
dataAbsentReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.dataAbsentReason subject-unknown | withheld | unable-to-obtain | deferred DefinitionDescribes why the family member's history is not available. This is a separate element to allow it to have a distinct binding from reasonCode. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes describing the reason why a family member's history is not available.
|
patient | S Σ I | 1..1 | Reference(package/StructureDefinition-PatientPSAB.json) | Element idFamilyMemberHistory.patient Patient history is about Alternate namesProband DefinitionThe person who this history concerns. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(package/StructureDefinition-PatientPSAB.json) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.date When history was recorded or last updated DefinitionThe date (and possibly time) when the family member history was recorded or last updated. Allows determination of how current the summary is. This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.name The family member described DefinitionThis will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". Allows greater ease in ensuring the same person is being talked about. Note that FHIR strings SHALL NOT exceed 1MB in size
|
relationship | S Σ | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.jsonBinding | Element idFamilyMemberHistory.relationship Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingThe nature of the relationship between the patient and the related person being described in the family member history.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | package/structuredefinition-profile-coding-ca-ps.json | There are no (further) constraints on this element Element idFamilyMemberHistory.relationship.coding A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. While the IPS-UV specification considers this a Must Support element, some systems will not have the ability to support codings for every codeableConcept, further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance. Implementers that support codings should still send the codings for codeable concepts if they are available and receivers should not produce failures or rejections if codings are included in the patient summary in the first release (a base tenet of FHIR). Additionally vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content package/structuredefinition-profile-coding-ca-ps.json Constraints
|
text | S Σ | 1..1 | string | Element idFamilyMemberHistory.relationship.text Plain text representation of the concept DefinitionA 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. 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. The full label of the family relationship (e.g., 'brother', 'sister', 'grandmother', etc.). Abbreviations are not allowed, to avoid confusion or misinterpretation. String: Max Character length (20) Required if a family history condition or characteristic is submitted.
|
sex | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idFamilyMemberHistory.sex male | female | other | unknown DefinitionThe birth sex of the family member. Not all relationship codes imply sex and the relative's sex can be relevant for risk assessments. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element. Codes describing the sex assigned at birth as documented on the birth registration.
|
born[x] | I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.born[x] (approximate) date of birth DefinitionThe actual or approximate date of birth of the relative. Allows calculation of the relative's age.
| |
bornPeriod | Period | There are no (further) constraints on this element Data type | ||
bornDate | date | There are no (further) constraints on this element Data type | ||
bornString | string | There are no (further) constraints on this element Data type | ||
age[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.age[x] (approximate) age DefinitionThe age of the relative at the time the family member history is recorded. While age can be calculated from date of birth, sometimes recording age directly is more natural for clinicians. use estimatedAge to indicate whether the age is actual or not.
| |
ageAge | Age | There are no (further) constraints on this element Data type | ||
ageRange | Range | There are no (further) constraints on this element Data type | ||
ageString | string | There are no (further) constraints on this element Data type | ||
estimatedAge | Σ I | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.estimatedAge Age is estimated? DefinitionIf true, indicates that the age value specified is an estimated value. Clinicians often prefer to specify an estimaged age rather than an age range. This element is labeled as a modifier because the fact that age is estimated can/should change the results of any algorithm that calculates based on the specified age. It is unknown whether the age is an estimate or not
|
deceased[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.deceased[x] Dead? How old/when? DefinitionDeceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedAge | Age | There are no (further) constraints on this element Data type | ||
deceasedRange | Range | There are no (further) constraints on this element Data type | ||
deceasedDate | date | There are no (further) constraints on this element Data type | ||
deceasedString | string | There are no (further) constraints on this element Data type | ||
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonCode Why was family member history performed? DefinitionDescribes why the family member history occurred in coded or textual form. Textual reasons can be captured using reasonCode.text. Codes indicating why the family member history was done.
|
reasonReference | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) | There are no (further) constraints on this element Element idFamilyMemberHistory.reasonReference Why was family member history performed? DefinitionIndicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Constraints
|
note | S | 0..* | Annotation | Element idFamilyMemberHistory.note General note about related person DefinitionThis property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible. Some form of note is required if family history data is being submitted. FamilyMemberHistory.note is used when the note cannot be distinctly tied to the condition property (i.e., familyMemberHistory.condition.note).
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.note.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | Element idFamilyMemberHistory.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Required if FamilyMemberHistory.note is populated. String: Max Character length (2000)
|
condition | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idFamilyMemberHistory.condition Condition that the related person had DefinitionThe significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition. This element is not currently flagged as Must Support in PS-CA, as early implementers have indicated the element may not be supported by some piloting systems. While the ability to use structured data is desirable, the practice of documenting family member history is still varied and some systems may not have the ability to differentiate individual condition details that are being noted for family members. For initial pilots, implementers should expect that some systems will populate this information as free text in the FamilyMemberHistory.note element. . Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
code | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.json | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.code Concept - reference to a terminology or just text DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingIdentification of the Condition or diagnosis.
| |
outcome | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.outcome deceased | permanent disability | etc. DefinitionIndicates what happened following the condition. If the condition resulted in death, deceased date is captured on the relation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.
| |
contributedToDeath | 0..1 | boolean | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.contributedToDeath Whether the condition contributed to the cause of death DefinitionThis condition contributed to the cause of death of the related person. If contributedToDeath is not populated, then it is unknown.
| |
onset[x] | S | 1..1 | Element idFamilyMemberHistory.condition.onset[x] When condition first manifested DefinitionEither the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. Age of onset of a condition in relatives is predictive of risk for the patient. Required if a family history condition or characteristic is submitted. May contain a number (age or year), or a textual description of an age, age range or life stage. String: Max Character length (50)
| |
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
note | S | 0..* | Annotation | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note Extra information about condition DefinitionAn area where general notes can be placed about this specific condition. For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
|
id | 0..1 | string | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idFamilyMemberHistory.condition.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | Element idFamilyMemberHistory.condition.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Required if FamilyMemberHistory.condition.note is populated. String: Max Character length (2000)
|
Restrictions
Alberta Patient Summary (PS-AB) employs a set of constraints on the package/StructureDefinition-BundlePSAB.json Profile that prevents patient summaries created in Alberta to include certain elements from Family Member History.
Family Member History records sent in a PS-AB Bundle SHALL NOT contain any of the following Family Member History details:
- .instantiatesCanonical
- .instantiatesUri
- .reasonReference
- .condition.outcome
- .condition.contributedToDeath
These elements are restricted based on current privacy requirements that require data that is collected, used or disclosed be limited to only the amount of health information that is essential to enable the custodian or the recipient of the information to carry out the intended purpose.
Usage
The FamilyMemberHistory Resource is used to populate entries in the Family History section of a patient summary.
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a Bundle for transmission, a UUID SHOULD be used in this element (with a corresponding value in
Bundle.entry.fullUrl
)
.status
- SHALL always be populated
.patient
- SHALL always be populated
- the referenced resource SHALL be included in the Bundle.entry
.reference
SHALL always be populated and SHALL be the UUID in theBundle.entry.fullURL
of the referenced resource
.relationship
- SHALL always be populated
.text
SHALL always be populated