MedNet interface implementation guide
0.15.0 - CI Build

MedNet interface implementation guide - Local Development build (v0.15.0). See the Directory of published versions

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

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-familyMemberHistory Version: 0.15.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.

This structure is derived from FamilyMemberHistory

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element FamilyMemberHistory.relationship.coding is sliced based on the values of value:system, value:code
  • The element FamilyMemberHistory.condition.code.coding is sliced based on the values of value:system, value:code

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryMedNet Interface (MNI) - Family Member History
... id S0..1stringThe 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 S1..1codecompleted
Fixed Value: completed
... patient S1..1Reference(MedNet Interface (MNI) - Patient)Link to the Patient
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode S0..1CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code S1..1codesee https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display S0..1stringRepresentation defined by the system
.... text S0..1stringIf the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... ageAge S0..1Age(approximate) age
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S0..1stringUnit representation
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... deceasedBoolean S0..1booleanIt the family Member already decesead
... deceasedAge S0..1AgeIf the family Member is already decesead how old was it
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S0..1stringUnit representation
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition S1..*BackboneElementCondition that the related person had
.... code S1..1CodeableConceptCondition suffered by relation
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed S0..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code S1..1codeSymbol in syntax defined by the system
....... display S0..1stringRepresentation defined by the system
...... coding:ICD10 S0..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... code S1..1codeSymbol in syntax defined by the system
....... display S0..1stringRepresentation defined by the system
...... coding:ICPC2 S0..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... code S1..1codeSymbol in syntax defined by the system
....... display S0..1stringRepresentation defined by the system
..... text S1..1stringShould 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 I0..*FamilyMemberHistoryMedNet Interface (MNI) - Family Member History
... id SΣ0..1stringThe 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..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!SΣ1..1codecompleted
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


Fixed Value: completed
... dataAbsentReason Σ0..1CodeableConceptsubject-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..1Reference(MedNet Interface (MNI) - Patient)Link to the Patient
... date Σ0..1dateTimeWhen history was recorded or last updated
... name Σ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode SΣ0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codesee https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringIf the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] I0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... Slices for age[x] ΣI0..1Age(approximate) age
Slice: Unordered, Closed by type:$this
.... age[x]:ageAge SΣI0..1Age(approximate) age
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... estimatedAge ΣI0..1booleanAge is estimated?
... Slices for deceased[x] Σ0..1Dead? How old/when?
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceased[x]:deceasedBoolean SΣ0..1booleanIt the family Member already decesead
.... deceased[x]:deceasedAge SΣ0..1AgeIf the family Member is already decesead how old was it
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... reasonCode Σ0..*CodeableConceptWhy 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..*AnnotationGeneral note about related person
... condition S1..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed SΣ0..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:ICD10 SΣ0..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:ICPC2 SΣ0..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ1..1stringShould contain the full name or label of the condition in the document language. This text must alway be provided
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*FamilyMemberHistoryMedNet Interface (MNI) - Family Member History
... id Σ0..1stringThe 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 ?!Σ1..1codecompleted
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


Fixed Value: completed
... patient Σ1..1Reference(MedNet Interface (MNI) - Patient)Link to the Patient
.... coding:v3RoleCode Σ0..1CodingCode defined by a terminology system
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code Σ1..1codesee https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
..... display Σ0..1stringRepresentation defined by the system
.... text Σ0..1stringIf the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... age[x]:ageAge ΣI0..1Age(approximate) age
.... value Σ1..1decimalNumerical value (with implicit precision)
.... unit Σ0..1stringUnit representation
.... system ΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code Σ1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... deceased[x]:deceasedBoolean Σ0..1booleanIt the family Member already decesead
... deceased[x]:deceasedAge Σ0..1AgeIf the family Member is already decesead how old was it
.... value Σ1..1decimalNumerical value (with implicit precision)
.... unit Σ0..1stringUnit representation
.... system ΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code Σ1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition 1..*BackboneElementCondition that the related person had
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... coding:snomed Σ0..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
..... coding:ICD10 Σ0..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
..... coding:ICPC2 Σ0..1CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
..... text Σ1..1stringShould contain the full name or label of the condition in the document language. This text must alway be provided

doco Documentation for this format

This structure is derived from FamilyMemberHistory

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element FamilyMemberHistory.relationship.coding is sliced based on the values of value:system, value:code
  • The element FamilyMemberHistory.condition.code.coding is sliced based on the values of value:system, value:code

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory 0..*FamilyMemberHistoryMedNet Interface (MNI) - Family Member History
... id S0..1stringThe 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 S1..1codecompleted
Fixed Value: completed
... patient S1..1Reference(MedNet Interface (MNI) - Patient)Link to the Patient
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode S0..1CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... code S1..1codesee https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display S0..1stringRepresentation defined by the system
.... text S0..1stringIf the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... ageAge S0..1Age(approximate) age
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S0..1stringUnit representation
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... deceasedBoolean S0..1booleanIt the family Member already decesead
... deceasedAge S0..1AgeIf the family Member is already decesead how old was it
.... value S1..1decimalNumerical value (with implicit precision)
.... unit S0..1stringUnit representation
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... condition S1..*BackboneElementCondition that the related person had
.... code S1..1CodeableConceptCondition suffered by relation
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed S0..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... code S1..1codeSymbol in syntax defined by the system
....... display S0..1stringRepresentation defined by the system
...... coding:ICD10 S0..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... code S1..1codeSymbol in syntax defined by the system
....... display S0..1stringRepresentation defined by the system
...... coding:ICPC2 S0..1CodingCode defined by a terminology system
....... system S1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... code S1..1codeSymbol in syntax defined by the system
....... display S0..1stringRepresentation defined by the system
..... text S1..1stringShould 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 I0..*FamilyMemberHistoryMedNet Interface (MNI) - Family Member History
... id SΣ0..1stringThe 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..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Id(s) for this record
... instantiatesCanonical Σ0..*canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... status ?!SΣ1..1codecompleted
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.


Fixed Value: completed
... dataAbsentReason Σ0..1CodeableConceptsubject-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..1Reference(MedNet Interface (MNI) - Patient)Link to the Patient
... date Σ0..1dateTimeWhen history was recorded or last updated
... name Σ0..1stringThe family member described
... relationship SΣ1..1CodeableConceptRelationship 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
..... coding:v3RoleCode SΣ0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codesee https://terminology.hl7.org/1.0.0//ValueSet-v3-FamilyMember.html
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringIf the relationship cannot be delivered in a codeable way, it must be delivered in plain text
... sex Σ0..1CodeableConceptmale | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.

... born[x] I0..1(approximate) date of birth
.... bornPeriodPeriod
.... bornDatedate
.... bornStringstring
... Slices for age[x] ΣI0..1Age(approximate) age
Slice: Unordered, Closed by type:$this
.... age[x]:ageAge SΣI0..1Age(approximate) age
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... estimatedAge ΣI0..1booleanAge is estimated?
... Slices for deceased[x] Σ0..1Dead? How old/when?
Slice: Unordered, Closed by type:$this
.... deceasedBooleanboolean
.... deceasedAgeAge
.... deceased[x]:deceasedBoolean SΣ0..1booleanIt the family Member already decesead
.... deceased[x]:deceasedAge SΣ0..1AgeIf the family Member is already decesead how old was it
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ1..1decimalNumerical value (with implicit precision)
..... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit SΣ0..1stringUnit representation
..... system SΣI1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit. min (minutes) | d (days) | wk (weeks) | mo (months) | a (years)
... reasonCode Σ0..*CodeableConceptWhy 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..*AnnotationGeneral note about related person
... condition S1..*BackboneElementCondition that the related person had
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.

..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system, value:code
...... coding:snomed SΣ0..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:ICD10 SΣ0..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://fhir.de/CodeSystem/dimdi/icd-10-gm
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:ICPC2 SΣ0..1CodingCode defined by a terminology system
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.840.1.113883.6.139
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ1..1stringShould contain the full name or label of the condition in the document language. This text must alway be provided
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcomeCodes (example): The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

.... contributedToDeath 0..1booleanWhether the condition contributed to the cause of death
.... onset[x] 0..1When condition first manifested
..... onsetAgeAge
..... onsetRangeRange
..... onsetPeriodPeriod
..... onsetStringstring
.... note 0..*AnnotationExtra information about condition

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
FamilyMemberHistory.languagepreferredCommonLanguages
Max Binding: AllLanguages
FamilyMemberHistory.statusrequiredFixed Value: completed
FamilyMemberHistory.dataAbsentReasonexampleFamilyHistoryAbsentReason
FamilyMemberHistory.relationshipexampleFamilyMember
FamilyMemberHistory.sexextensibleAdministrativeGender
FamilyMemberHistory.age[x]:ageAge.comparatorrequiredQuantityComparator
FamilyMemberHistory.deceased[x]:deceasedAge.comparatorrequiredQuantityComparator
FamilyMemberHistory.reasonCodeexampleSNOMEDCTClinicalFindings
FamilyMemberHistory.condition.codeexampleCondition/Problem/DiagnosisCodes
FamilyMemberHistory.condition.outcomeexampleConditionOutcomeCodes

Constraints

IdGradePathDetailsRequirements
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()
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()
ele-1errorFamilyMemberHistory.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.instantiatesCanonicalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.instantiatesUriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.dataAbsentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.relationship.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.relationship.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.coding:v3RoleCode.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.relationship.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.sexAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.born[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]:ageAgeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]:ageAge.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.age[x]:ageAge.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.age[x]:ageAge.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]:ageAge.comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]:ageAge.unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]:ageAge.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.age[x]:ageAge.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.estimatedAgeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedBooleanAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAgeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAge.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.deceased[x]:deceasedAge.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAge.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAge.comparatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAge.unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAge.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.deceased[x]:deceasedAge.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:snomedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:snomed.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.code.coding:snomed.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.code.coding:snomed.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:snomed.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:snomed.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:snomed.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:snomed.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.code.coding:ICD10.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICD10.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorFamilyMemberHistory.condition.code.coding:ICPC2.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.coding:ICPC2.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.outcomeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.contributedToDeathAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.onset[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorFamilyMemberHistory.condition.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())