Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena FamilyMemberHistory

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaFamilyMemberHistory

Defines constraints and extensions on the familymemberhistory resource as supported by Athena Products.

This FamilyMemberHistory profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource captures significant health events and conditions for persons related to the patient and that are relevant to patient care.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access FamilyMemberHistory resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The FamilyMemberHistory resource is derived from the FamilyHealthHistory tables in athenaPractice and athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... id 0..1 id Logical id of this artifact
... meta 1..1 Meta Metadata about the resource
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-familyhistory-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..* Coding Tags applied to this resource
... identifier 0..1 Identifier External Id(s) for this record
... patient 1..1 Reference(Patient) Patient history is about
... date 1..1 dateTime When history was recorded or last updated
... relationship 1..1 CodeableConcept Relationship to the subject
... sex 1..1 CodeableConcept male | female | other | unknown
... note 0..1 Annotation General note about related person
... condition 0..1 BackboneElement Condition that the related person had
.... code 1..1 CodeableConcept Condition suffered by relation
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text 0..1 string Plain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-familyhistory-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier External Id(s) for this record
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... patient Σ 1..1 Reference(Patient) Patient history is about
... date Σ 1..1 dateTime When history was recorded or last updated
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ 1..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... note 0..1 Annotation General note about related person
... condition 0..1 BackboneElement Condition that the related person had
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
..... text Σ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-familyhistory-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier External Id(s) for this record
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... dataAbsentReason Σ 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient Σ 1..1 Reference(Patient) Patient history is about
... date Σ 1..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ 1..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... deceased[x] Σ 0..1 Dead? How old/when?
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Why was family member history performed?
... note 0..1 Annotation General note about related person
... condition 0..1 BackboneElement Condition that the related person had
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... outcome 0..1 CodeableConcept deceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1 boolean Whether the condition contributed to the cause of death
.... onset[x] 0..1 When condition first manifested
..... onsetAge Age
..... onsetRange Range
..... onsetPeriod Period
..... onsetString string
.... note 0..* Annotation Extra information about condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
http://hl7.org/fhir/ValueSet/history-absent-reason
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 9 elements(7 nested mandatory elements)
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of FamilyMemberHistory.meta.profile
  • The element 1 is sliced based on the value of FamilyMemberHistory.meta.security

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
... id 0..1 id Logical id of this artifact
... meta 1..1 Meta Metadata about the resource
.... lastUpdated 0..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-familyhistory-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile
.... Slices for security 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
..... security:CONFABBR 0..1 Coding Security Labels applied to this resource
...... system 1..1 uri Identity of the terminology system
...... code 1..1 code Symbol in syntax defined by the system
.... tag 1..* Coding Tags applied to this resource
... identifier 0..1 Identifier External Id(s) for this record
... patient 1..1 Reference(Patient) Patient history is about
... date 1..1 dateTime When history was recorded or last updated
... relationship 1..1 CodeableConcept Relationship to the subject
... sex 1..1 CodeableConcept male | female | other | unknown
... note 0..1 Annotation General note about related person
... condition 0..1 BackboneElement Condition that the related person had
.... code 1..1 CodeableConcept Condition suffered by relation
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text 0..1 string Plain text representation of the concept

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-familyhistory-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... system Σ 1..1 uri Identity of the terminology system
...... code Σ 1..1 code Symbol in syntax defined by the system
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier External Id(s) for this record
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... patient Σ 1..1 Reference(Patient) Patient history is about
... date Σ 1..1 dateTime When history was recorded or last updated
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ 1..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... note 0..1 Annotation General note about related person
... condition 0..1 BackboneElement Condition that the related person had
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... coding Σ 1..1 Coding Code defined by a terminology system
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
..... text Σ 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory Information about patient's relatives, relevant for patient
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-familyhistory-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile
.... Slices for security Σ 0..2 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... security:CONFABBR Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... tag Σ 1..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier External Id(s) for this record
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.

... dataAbsentReason Σ 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

... patient Σ 1..1 Reference(Patient) Patient history is about
... date Σ 1..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (example): The nature of the relationship between the patient and the related person being described in the family member history.

... sex Σ 1..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... deceased[x] Σ 0..1 Dead? How old/when?
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.


... reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Why was family member history performed?
... note 0..1 Annotation General note about related person
... condition 0..1 BackboneElement Condition that the related person had
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... outcome 0..1 CodeableConcept deceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1 boolean Whether the condition contributed to the cause of death
.... onset[x] 0..1 When condition first manifested
..... onsetAge Age
..... onsetRange Range
..... onsetPeriod Period
..... onsetString string
.... note 0..* Annotation Extra information about condition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.security:CONFABBRextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
FamilyMemberHistory.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
FamilyMemberHistory.statusrequiredFamilyHistoryStatus
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
http://hl7.org/fhir/ValueSet/history-absent-reason
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
from the FHIR Standard
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

This structure is derived from FamilyMemberHistory

Summary

Mandatory: 9 elements(7 nested mandatory elements)
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of FamilyMemberHistory.meta.profile
  • The element 1 is sliced based on the value of FamilyMemberHistory.meta.security

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for FamilyMemberHistory resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/FamilyMemberHistory?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results FamilyMemberHistory resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
_security (token)
code (token) A search by a condition code
date (date) When history was captured/updated
date-fromnow (quantity) Like date except expressed as a positive or negative offset from the current time in units of time, e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
sex (token) A search by a sex code of a family member
identifier (token) A search by a record identifier
patient (reference) The identity of a subject to list family member history items for
relationship (token) A search by a relationship type
status (token) partial | completed | entered-in-error | health-unknown
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.