MedNet interface implementation guide
0.16.0 - CI Build

Publication Build: This will be filled in by the publication tooling

Resource Profile: MedNet Interface (MNI) - Family Member History

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-familyMemberHistory Version: 0.16.0
Active as of 2020-11-06 Computable Name: MNIFamilyMemberHistory

Copyright/Legal: novcom AG

MedNet Interface (MNI) - Family Member History Profile

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory MedNet Interface (MNI) - Family Member History
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Link to the Patient
... relationship SΣ 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.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code SΣ 1..1 code see https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string If the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... Slices for age[x] ΣC 0..1 Age (approximate) age
Slice: Unordered, Closed by type:$this
.... age[x]:ageAge SΣC 0..1 Age (approximate) age
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceased[x]:deceasedBoolean SΣ 0..1 boolean It the family Member already decesead
.... deceased[x]:deceasedAge SΣ 0..1 Age If the family Member is already decesead how old was it
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition S 1..* BackboneElement Condition that the related person had
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed SΣ 0..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
...... coding:ICD10 SΣ 0..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
...... coding:ICPC2 SΣ 0..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
..... text SΣ 1..1 string Should contain the full name or label of the condition in the document language. This text must alway be provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
FamilyMemberHistory.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.age[x]:ageAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
FamilyMemberHistory.deceased[x]:deceasedAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
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 FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory MedNet Interface (MNI) - Family Member History
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... status S 1..1 code completed
Fixed Value: completed
... patient S 1..1 Reference(MedNet Interface (MNI) - Patient) Link to the Patient
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code S 1..1 code see https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display S 0..1 string Representation defined by the system
.... text S 0..1 string If the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... ageAge S 0..1 Age (approximate) age
.... value S 1..1 decimal Numerical value (with implicit precision)
.... unit S 0..1 string Unit representation
.... system S 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... deceasedBoolean S 0..1 boolean It the family Member already decesead
... deceasedAge S 0..1 Age If the family Member is already decesead how old was it
.... value S 1..1 decimal Numerical value (with implicit precision)
.... unit S 0..1 string Unit representation
.... system S 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition S 1..* BackboneElement Condition that the related person had
.... code S 1..1 CodeableConcept Condition suffered by relation
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed S 0..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system
...... coding:ICD10 S 0..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system
...... coding:ICPC2 S 0..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system
..... text S 1..1 string Should contain the full name or label of the condition in the document language. This text must alway be provided

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory MedNet Interface (MNI) - Family Member History
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... 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 ?!SΣ 1..1 code completed
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


Fixed Value: completed
... 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 SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Link to the Patient
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship SΣ 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.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode SΣ 0..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 SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code see https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string If the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... sex Σ 0..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
... Slices for age[x] ΣC 0..1 Age (approximate) age
Slice: Unordered, Closed by type:$this
.... age[x]:ageAge SΣC 0..1 Age (approximate) age
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... 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
.... deceased[x]:deceasedBoolean SΣ 0..1 boolean It the family Member already decesead
.... deceased[x]:deceasedAge SΣ 0..1 Age If the family Member is already decesead how old was it
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... 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 S 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 S 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
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed SΣ 0..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 SΣ 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 SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:ICD10 SΣ 0..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 SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:ICPC2 SΣ 0..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 SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 1..1 string Should contain the full name or label of the condition in the document language. This text must alway be provided
.... 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

PathConformanceValueSet / CodeURI
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
FamilyMemberHistory.statusrequiredFixed Value: completed
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.age[x]:ageAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
FamilyMemberHistory.deceased[x]:deceasedAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
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

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 FamilyMemberHistory

Summary

Mandatory: 3 elements(14 nested mandatory elements)
Must-Support: 35 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of FamilyMemberHistory.relationship.coding
  • The element 2 is sliced based on the values of FamilyMemberHistory.condition.code.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory MedNet Interface (MNI) - Family Member History
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Link to the Patient
... relationship SΣ 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.

.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode SΣ 0..1 Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code SΣ 1..1 code see https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display SΣ 0..1 string Representation defined by the system
.... text SΣ 0..1 string If the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... Slices for age[x] ΣC 0..1 Age (approximate) age
Slice: Unordered, Closed by type:$this
.... age[x]:ageAge SΣC 0..1 Age (approximate) age
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... Slices for deceased[x] Σ 0..1 Dead? How old/when?
Slice: Unordered, Closed by type:$this
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceased[x]:deceasedBoolean SΣ 0..1 boolean It the family Member already decesead
.... deceased[x]:deceasedAge SΣ 0..1 Age If the family Member is already decesead how old was it
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition S 1..* BackboneElement Condition that the related person had
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code S 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed SΣ 0..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
...... coding:ICD10 SΣ 0..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
...... coding:ICPC2 SΣ 0..1 Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
..... text SΣ 1..1 string Should contain the full name or label of the condition in the document language. This text must alway be provided

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
FamilyMemberHistory.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/history-status|4.0.1
from the FHIR Standard
FamilyMemberHistory.relationshipexampleFamilyMember
http://terminology.hl7.org/ValueSet/v3-FamilyMember
FamilyMemberHistory.age[x]:ageAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
FamilyMemberHistory.deceased[x]:deceasedAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
http://hl7.org/fhir/ValueSet/condition-code
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()

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory MedNet Interface (MNI) - Family Member History
... id S 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... status S 1..1 code completed
Fixed Value: completed
... patient S 1..1 Reference(MedNet Interface (MNI) - Patient) Link to the Patient
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode S 0..1 Coding Code defined by a terminology system
...... system S 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code S 1..1 code see https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display S 0..1 string Representation defined by the system
.... text S 0..1 string If the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... ageAge S 0..1 Age (approximate) age
.... value S 1..1 decimal Numerical value (with implicit precision)
.... unit S 0..1 string Unit representation
.... system S 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... deceasedBoolean S 0..1 boolean It the family Member already decesead
... deceasedAge S 0..1 Age If the family Member is already decesead how old was it
.... value S 1..1 decimal Numerical value (with implicit precision)
.... unit S 0..1 string Unit representation
.... system S 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition S 1..* BackboneElement Condition that the related person had
.... code S 1..1 CodeableConcept Condition suffered by relation
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed S 0..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system
...... coding:ICD10 S 0..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system
...... coding:ICPC2 S 0..1 Coding Code defined by a terminology system
....... system S 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... code S 1..1 code Symbol in syntax defined by the system
....... display S 0..1 string Representation defined by the system
..... text S 1..1 string Should contain the full name or label of the condition in the document language. This text must alway be provided

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory MedNet Interface (MNI) - Family Member History
fhs-1: Can have age[x] or born[x], but not both
fhs-2: Can only have estimatedAge if age[x] is present
... id SΣ 0..1 id The id is unique within the space of all resources of the same type on the same server It can be any combination of upper- or lower-case ASCII letters 'A'..'Z', and 'a'..'z', numerals ('0'..'9'), '-' and '.' with a length limit of 64 characters. (This might be an integer, an un-prefixed OID, UUID or any other identifier pattern that meets these constraints.)
... 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 ?!SΣ 1..1 code completed
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


Fixed Value: completed
... 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 SΣ 1..1 Reference(MedNet Interface (MNI) - Patient) Link to the Patient
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship SΣ 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.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode SΣ 0..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 SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code see https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display SΣ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string If the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... sex Σ 0..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
... Slices for age[x] ΣC 0..1 Age (approximate) age
Slice: Unordered, Closed by type:$this
.... age[x]:ageAge SΣC 0..1 Age (approximate) age
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... 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
.... deceased[x]:deceasedBoolean SΣ 0..1 boolean It the family Member already decesead
.... deceased[x]:deceasedAge SΣ 0..1 Age If the family Member is already decesead how old was it
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ 1..1 decimal Numerical value (with implicit precision)
..... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ 0..1 string Unit representation
..... system SΣC 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ 1..1 code Coded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... 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 S 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 S 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
..... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed SΣ 0..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 SΣ 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 SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:ICD10 SΣ 0..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 SΣ 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... coding:ICPC2 SΣ 0..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 SΣ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display SΣ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text SΣ 1..1 string Should contain the full name or label of the condition in the document language. This text must alway be provided
.... 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

PathConformanceValueSet / CodeURI
FamilyMemberHistory.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
FamilyMemberHistory.statusrequiredFixed Value: completed
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.age[x]:ageAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
from the FHIR Standard
FamilyMemberHistory.deceased[x]:deceasedAge.comparatorrequiredQuantityComparator
http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
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

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 FamilyMemberHistory

Summary

Mandatory: 3 elements(14 nested mandatory elements)
Must-Support: 35 elements
Fixed: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of FamilyMemberHistory.relationship.coding
  • The element 2 is sliced based on the values of FamilyMemberHistory.condition.code.coding

 

Other representations of profile: CSV, Excel, Schematron