HL7 Europe Hospital Discharge Report
0.0.1-ci - ci-build 150

HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions

Resource Profile: FamilyMemberHistory: obligations

Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/familyMemberHistory-obl-eu-hdr Version: 0.0.1-ci
Standards status: Informative Maturity Level: 0 Computable Name: FamilyMemberHistoryEuHdrObligation

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile represents the constraints applied to the FamilyMemberHistory resource by this guide.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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.


ele-1: All FHIR elements must have a @value or children
... patient OΣ 1..1 Reference(Patient (EU core)) Patient history is about
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... relationship OΣ 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.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... Slices for born[x] C 0..1 (approximate) date of birth
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... bornPeriod Period
.... bornDate date
.... bornString string
.... born[x]:bornDate C 0..1 date Date of birth of the relative
ele-1: All FHIR elements must have a @value or children
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
.... deceased[x]:deceasedAge OΣ 0..1 Age (Approximate) age at death of the relative
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... deceased[x]:deceasedDate OΣ 0..1 date Date of death of the relative
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... condition O 0..* BackboneElement Condition that the related person had
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code O 1..1 CodeableConceptIPS(2.0.0) Condition suffered by relation
Binding: Condition Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
.... note O 0..* Annotation Extra information about this condition
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.condition.codepreferredConditionHdrVS
http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()

This structure is derived from FamilyMemberHistoryEuHdr

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
... dataAbsentReason O 0..1 CodeableConcept Reason for missing data
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... patient O 1..1 Reference(Patient (EU core)) Patient history is about
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... relationship O 1..1 CodeableConcept Relationship to the subject.
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... deceased[x]:deceasedAge O 0..1 Age (Approximate) age at death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... deceased[x]:deceasedDate O 0..1 date Date of death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... condition O 0..* BackboneElement Condition that the related person had
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... code O 1..1 CodeableConceptIPS(2.0.0) Condition suffered by relation
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
.... note O 0..* Annotation Extra information about this condition
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistoryEuHdr 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 Σ 0..1 Meta Metadata about the resource
... 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..* 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 OΣ 0..1 CodeableConcept Reason for missing data
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... patient OΣ 1..1 Reference(Patient (EU core)) Patient history is about
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship OΣ 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.

ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... sex Σ 0..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... Slices for born[x] C 0..1 (approximate) date of birth
Slice: Unordered, Open by type:$this
.... bornPeriod Period
.... bornDate date
.... bornString string
.... born[x]:bornDate C 0..1 date Date of birth of the relative
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
.... deceased[x]:deceasedAge OΣ 0..1 Age (Approximate) age at death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... deceased[x]:deceasedDate OΣ 0..1 date Date of death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... 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..* Annotation General note about related person
... condition O 0..* BackboneElement Condition that the related person had
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... 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 O 1..1 CodeableConceptIPS(2.0.0) Condition suffered by relation
Binding: Condition Value Set (preferred)
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
.... 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 O 0..* Annotation Extra information about this condition
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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.codepreferredConditionHdrVS
http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr
from this IG
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()

This structure is derived from FamilyMemberHistoryEuHdr

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... 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.


ele-1: All FHIR elements must have a @value or children
... patient OΣ 1..1 Reference(Patient (EU core)) Patient history is about
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... relationship OΣ 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.


ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... Slices for born[x] C 0..1 (approximate) date of birth
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... bornPeriod Period
.... bornDate date
.... bornString string
.... born[x]:bornDate C 0..1 date Date of birth of the relative
ele-1: All FHIR elements must have a @value or children
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
.... deceased[x]:deceasedAge OΣ 0..1 Age (Approximate) age at death of the relative
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... deceased[x]:deceasedDate OΣ 0..1 date Date of death of the relative
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... condition O 0..* BackboneElement Condition that the related person had
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... code O 1..1 CodeableConceptIPS(2.0.0) Condition suffered by relation
Binding: Condition Value Set (preferred)
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
.... note O 0..* Annotation Extra information about this condition
ele-1: All FHIR elements must have a @value or children
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
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.condition.codepreferredConditionHdrVS
http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()

Differential View

This structure is derived from FamilyMemberHistoryEuHdr

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
... dataAbsentReason O 0..1 CodeableConcept Reason for missing data
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... patient O 1..1 Reference(Patient (EU core)) Patient history is about
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... relationship O 1..1 CodeableConcept Relationship to the subject.
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... deceased[x]:deceasedAge O 0..1 Age (Approximate) age at death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... deceased[x]:deceasedDate O 0..1 date Date of death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... condition O 0..* BackboneElement Condition that the related person had
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... code O 1..1 CodeableConceptIPS(2.0.0) Condition suffered by relation
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
.... note O 0..* Annotation Extra information about this condition
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistoryEuHdr 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 Σ 0..1 Meta Metadata about the resource
... 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..* 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 OΣ 0..1 CodeableConcept Reason for missing data
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.

ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... patient OΣ 1..1 Reference(Patient (EU core)) Patient history is about
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship OΣ 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.

ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... sex Σ 0..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... Slices for born[x] C 0..1 (approximate) date of birth
Slice: Unordered, Open by type:$this
.... bornPeriod Period
.... bornDate date
.... bornString string
.... born[x]:bornDate C 0..1 date Date of birth of the relative
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
.... deceased[x]:deceasedAge OΣ 0..1 Age (Approximate) age at death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... deceased[x]:deceasedDate OΣ 0..1 date Date of death of the relative
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... 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..* Annotation General note about related person
... condition O 0..* BackboneElement Condition that the related person had
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
.... 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 O 1..1 CodeableConceptIPS(2.0.0) Condition suffered by relation
Binding: Condition Value Set (preferred)
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
.... 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 O 0..* Annotation Extra information about this condition
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
FamilyMemberHistory.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
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.codepreferredConditionHdrVS
http://hl7.eu/fhir/hdr/ValueSet/condition-eu-hdr
from this IG
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes
http://hl7.org/fhir/ValueSet/condition-outcome
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFamilyMemberHistoryIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorFamilyMemberHistoryIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceFamilyMemberHistoryA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
fhs-1errorFamilyMemberHistoryCan have age[x] or born[x], but not both
: age.empty() or born.empty()
fhs-2errorFamilyMemberHistoryCan only have estimatedAge if age[x] is present
: age.exists() or estimatedAge.empty()

This structure is derived from FamilyMemberHistoryEuHdr

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron