Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_FamilyMemberHistory_R4B

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-FamilyMemberHistory Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_FamilyMemberHistory_R4B

This cross-version profile allows STU3 FamilyMemberHistory content to be represented via FHIR R4B FamilyMemberHistory resources.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory(4.3.0) Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4B(0.1.0) | Questionnaire) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: subject-unknown | withheld | unable-to-obtain | deferred (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDoneReason
Binding: R3HistoryNotDoneReasonForR4B (0.1.0) (example): Codes describing the reason why a family member history was not done.
Constraints: ext-1
.... extension:born 0..1 Period STU3: born additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.born
Constraints: ext-1
.... extension:age 0..1 Range STU3: age additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.age
Constraints: ext-1
.... extension:deceased 0..1 Range STU3: deceased additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.deceased
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: The taking of a family member's history did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDone
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) Patient history is about
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (3.0.0) (example): The nature of the relationship between the patient and the related person being described in the family member history.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.3.0 FHIR Std.
FamilyMemberHistory.​relationship Base example FamilyMember 📍3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error FamilyMemberHistory If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FamilyMemberHistory If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FamilyMemberHistory If 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-5 error FamilyMemberHistory If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FamilyMemberHistory A resource should have narrative for robust management text.`div`.exists()
ele-1 error FamilyMemberHistory.implicitRules, FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.status, FamilyMemberHistory.patient, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient, FamilyMemberHistory.relationship All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()
fhs-1 error FamilyMemberHistory Can have age[x] or born[x], but not both age.empty() or born.empty()
fhs-2 error FamilyMemberHistory Can only have estimatedAge if age[x] is present age.exists() or estimatedAge.empty()

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory(4.3.0) Information about patient's relatives, relevant for patient
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4B(0.1.0) | Questionnaire) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.definition
.... extension:notDoneReason 0..1 CodeableConcept STU3: subject-unknown | withheld | unable-to-obtain | deferred (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDoneReason
Binding: R3HistoryNotDoneReasonForR4B (0.1.0) (example): Codes describing the reason why a family member history was not done.
.... extension:born 0..1 Period STU3: born additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.born
.... extension:age 0..1 Range STU3: age additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.age
.... extension:deceased 0..1 Range STU3: deceased additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.deceased
.... modifierExtension:notDone 0..1 boolean STU3: The taking of a family member's history did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDone
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.identifier
... patient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sex
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:gender 0..1 code STU3: gender
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... reasonReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reasonReference 0..* Reference(Resource) STU3: reasonReference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.note
... condition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:onset 0..1 Range, Period STU3: onset additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.onset
.... note
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.note

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory(4.3.0) Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4B(0.1.0) | Questionnaire) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: subject-unknown | withheld | unable-to-obtain | deferred (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDoneReason
Binding: R3HistoryNotDoneReasonForR4B (0.1.0) (example): Codes describing the reason why a family member history was not done.
Constraints: ext-1
.... extension:born 0..1 Period STU3: born additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.born
Constraints: ext-1
.... extension:age 0..1 Range STU3: age additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.age
Constraints: ext-1
.... extension:deceased 0..1 Range STU3: deceased additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.deceased
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: The taking of a family member's history did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDone
Constraints: ext-1
... identifier Σ 0..* Identifier External Id(s) for this record
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
... dataAbsentReason Σ 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
... patient Σ 1..1 Reference(Patient) Patient history is about
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (3.0.0) (example): The nature of the relationship between the patient and the related person being described in the family member history.
... sex Σ 0..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:gender 0..1 code STU3: gender
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... deceased[x] Σ 0..1 Dead? How old/when?
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
... reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Why was family member history performed?
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:reasonReference 0..1 Reference(Resource) STU3: reasonReference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..* Annotation General note about related person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... condition 0..* BackboneElement Condition that the related person had
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:onset 0..1 Range, Period STU3: onset additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.onset
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.note
Constraints: ext-1
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
FamilyMemberHistory.​meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
FamilyMemberHistory.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
FamilyMemberHistory.​text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
FamilyMemberHistory.​identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
FamilyMemberHistory.​identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.3.0 FHIR Std.
FamilyMemberHistory.​dataAbsentReason Base example FamilyHistoryAbsentReason 📍4.3.0 FHIR Std.
FamilyMemberHistory.​patient.type Base extensible ResourceType 📍4.3.0 FHIR Std.
FamilyMemberHistory.​relationship Base example FamilyMember 📍3.0.0 THO v7.1
FamilyMemberHistory.​sex Base extensible AdministrativeGender 📍4.3.0 FHIR Std.
FamilyMemberHistory.​reasonCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
FamilyMemberHistory.​reasonReference.type Base extensible ResourceType 📍4.3.0 FHIR Std.
FamilyMemberHistory.​condition.code Base example Condition/Problem/Diagnosis Codes 📍4.3.0 FHIR Std.
FamilyMemberHistory.​condition.outcome Base example Condition Outcome Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error FamilyMemberHistory If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FamilyMemberHistory If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FamilyMemberHistory If 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-5 error FamilyMemberHistory If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FamilyMemberHistory A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning FamilyMemberHistory.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error FamilyMemberHistory.meta, FamilyMemberHistory.meta.extension, FamilyMemberHistory.meta.extension:meta, FamilyMemberHistory.meta.versionId, FamilyMemberHistory.meta.lastUpdated, FamilyMemberHistory.meta.source, FamilyMemberHistory.meta.profile, FamilyMemberHistory.meta.security, FamilyMemberHistory.meta.tag, FamilyMemberHistory.implicitRules, FamilyMemberHistory.language, FamilyMemberHistory.text, FamilyMemberHistory.text.extension, FamilyMemberHistory.text.extension:text, FamilyMemberHistory.text.status, FamilyMemberHistory.text.div, FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.identifier, FamilyMemberHistory.identifier.extension, FamilyMemberHistory.identifier.extension:identifier, FamilyMemberHistory.identifier.use, FamilyMemberHistory.identifier.type, FamilyMemberHistory.identifier.system, FamilyMemberHistory.identifier.value, FamilyMemberHistory.identifier.period, FamilyMemberHistory.identifier.assigner, FamilyMemberHistory.instantiatesCanonical, FamilyMemberHistory.instantiatesUri, FamilyMemberHistory.status, FamilyMemberHistory.dataAbsentReason, FamilyMemberHistory.patient, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient, FamilyMemberHistory.patient.reference, FamilyMemberHistory.patient.type, FamilyMemberHistory.patient.identifier, FamilyMemberHistory.patient.display, FamilyMemberHistory.date, FamilyMemberHistory.name, FamilyMemberHistory.relationship, FamilyMemberHistory.sex, FamilyMemberHistory.sex.extension, FamilyMemberHistory.sex.extension:gender, FamilyMemberHistory.sex.coding, FamilyMemberHistory.sex.text, FamilyMemberHistory.born[x], FamilyMemberHistory.age[x], FamilyMemberHistory.estimatedAge, FamilyMemberHistory.deceased[x], FamilyMemberHistory.reasonCode, FamilyMemberHistory.reasonReference, FamilyMemberHistory.reasonReference.extension, FamilyMemberHistory.reasonReference.extension:reasonReference, FamilyMemberHistory.reasonReference.reference, FamilyMemberHistory.reasonReference.type, FamilyMemberHistory.reasonReference.identifier, FamilyMemberHistory.reasonReference.display, FamilyMemberHistory.note, FamilyMemberHistory.note.extension, FamilyMemberHistory.note.extension:note, FamilyMemberHistory.note.author[x], FamilyMemberHistory.note.time, FamilyMemberHistory.note.text, FamilyMemberHistory.condition, FamilyMemberHistory.condition.extension, FamilyMemberHistory.condition.extension:onset, FamilyMemberHistory.condition.modifierExtension, FamilyMemberHistory.condition.code, FamilyMemberHistory.condition.outcome, FamilyMemberHistory.condition.contributedToDeath, FamilyMemberHistory.condition.onset[x], FamilyMemberHistory.condition.note, FamilyMemberHistory.condition.note.extension, FamilyMemberHistory.condition.note.extension:note, FamilyMemberHistory.condition.note.author[x], FamilyMemberHistory.condition.note.time, FamilyMemberHistory.condition.note.text All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error FamilyMemberHistory.meta.extension, FamilyMemberHistory.meta.extension:meta, FamilyMemberHistory.text.extension, FamilyMemberHistory.text.extension:text, FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.identifier.extension, FamilyMemberHistory.identifier.extension:identifier, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient, FamilyMemberHistory.sex.extension, FamilyMemberHistory.sex.extension:gender, FamilyMemberHistory.reasonReference.extension, FamilyMemberHistory.reasonReference.extension:reasonReference, FamilyMemberHistory.note.extension, FamilyMemberHistory.note.extension:note, FamilyMemberHistory.condition.extension, FamilyMemberHistory.condition.extension:onset, FamilyMemberHistory.condition.modifierExtension, FamilyMemberHistory.condition.note.extension, FamilyMemberHistory.condition.note.extension:note Must have either extensions or value[x], not both extension.exists() != value.exists()
fhs-1 error FamilyMemberHistory Can have age[x] or born[x], but not both age.empty() or born.empty()
fhs-2 error FamilyMemberHistory Can only have estimatedAge if age[x] is present age.exists() or estimatedAge.empty()
txt-1 error FamilyMemberHistory.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error FamilyMemberHistory.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory(4.3.0) Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4B(0.1.0) | Questionnaire) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: subject-unknown | withheld | unable-to-obtain | deferred (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDoneReason
Binding: R3HistoryNotDoneReasonForR4B (0.1.0) (example): Codes describing the reason why a family member history was not done.
Constraints: ext-1
.... extension:born 0..1 Period STU3: born additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.born
Constraints: ext-1
.... extension:age 0..1 Range STU3: age additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.age
Constraints: ext-1
.... extension:deceased 0..1 Range STU3: deceased additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.deceased
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: The taking of a family member's history did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDone
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) Patient history is about
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (3.0.0) (example): The nature of the relationship between the patient and the related person being described in the family member history.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.3.0 FHIR Std.
FamilyMemberHistory.​relationship Base example FamilyMember 📍3.0.0 THO v7.1

Constraints

Id Grade Path(s) Description Expression
dom-2 error FamilyMemberHistory If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FamilyMemberHistory If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FamilyMemberHistory If 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-5 error FamilyMemberHistory If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FamilyMemberHistory A resource should have narrative for robust management text.`div`.exists()
ele-1 error FamilyMemberHistory.implicitRules, FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.status, FamilyMemberHistory.patient, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient, FamilyMemberHistory.relationship All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()
fhs-1 error FamilyMemberHistory Can have age[x] or born[x], but not both age.empty() or born.empty()
fhs-2 error FamilyMemberHistory Can only have estimatedAge if age[x] is present age.exists() or estimatedAge.empty()

Differential View

This structure is derived from FamilyMemberHistory

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory 0..* FamilyMemberHistory(4.3.0) Information about patient's relatives, relevant for patient
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4B(0.1.0) | Questionnaire) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.definition
.... extension:notDoneReason 0..1 CodeableConcept STU3: subject-unknown | withheld | unable-to-obtain | deferred (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDoneReason
Binding: R3HistoryNotDoneReasonForR4B (0.1.0) (example): Codes describing the reason why a family member history was not done.
.... extension:born 0..1 Period STU3: born additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.born
.... extension:age 0..1 Range STU3: age additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.age
.... extension:deceased 0..1 Range STU3: deceased additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.deceased
.... modifierExtension:notDone 0..1 boolean STU3: The taking of a family member's history did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDone
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.identifier
... patient
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... sex
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:gender 0..1 code STU3: gender
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... reasonReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:reasonReference 0..* Reference(Resource) STU3: reasonReference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.note
... condition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:onset 0..1 Range, Period STU3: onset additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.onset
.... note
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.note

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FamilyMemberHistory C 0..* FamilyMemberHistory(4.3.0) Information about patient's relatives, relevant for patient
Constraints: fhs-1, fhs-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4B(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4B(0.1.0) | Questionnaire) STU3: Instantiates protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.definition
Constraints: ext-1
.... extension:notDoneReason 0..1 CodeableConcept STU3: subject-unknown | withheld | unable-to-obtain | deferred (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDoneReason
Binding: R3HistoryNotDoneReasonForR4B (0.1.0) (example): Codes describing the reason why a family member history was not done.
Constraints: ext-1
.... extension:born 0..1 Period STU3: born additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.born
Constraints: ext-1
.... extension:age 0..1 Range STU3: age additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.age
Constraints: ext-1
.... extension:deceased 0..1 Range STU3: deceased additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.deceased
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:notDone ?! 0..1 boolean STU3: The taking of a family member's history did not occur (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.notDone
Constraints: ext-1
... identifier Σ 0..* Identifier External Id(s) for this record
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition | Questionnaire | ActivityDefinition | Measure | OperationDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... status ?!Σ 1..1 code partial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required): A code that identifies the status of the family history record.
... dataAbsentReason Σ 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
Binding: FamilyHistoryAbsentReason (example): Codes describing the reason why a family member's history is not available.
... patient Σ 1..1 Reference(Patient) Patient history is about
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) STU3: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... date Σ 0..1 dateTime When history was recorded or last updated
... name Σ 0..1 string The family member described
... relationship Σ 1..1 CodeableConcept Relationship to the subject
Binding: FamilyMember (3.0.0) (example): The nature of the relationship between the patient and the related person being described in the family member history.
... sex Σ 0..1 CodeableConcept male | female | other | unknown
Binding: AdministrativeGender (extensible): Codes describing the sex assigned at birth as documented on the birth registration.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:gender 0..1 code STU3: gender
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... born[x] C 0..1 (approximate) date of birth
.... bornPeriod Period
.... bornDate date
.... bornString string
... age[x] ΣC 0..1 (approximate) age
.... ageAge Age
.... ageRange Range
.... ageString string
... estimatedAge ΣC 0..1 boolean Age is estimated?
... deceased[x] Σ 0..1 Dead? How old/when?
.... deceasedBoolean boolean
.... deceasedAge Age
.... deceasedRange Range
.... deceasedDate date
.... deceasedString string
... reasonCode Σ 0..* CodeableConcept Why was family member history performed?
Binding: SNOMEDCTClinicalFindings (example): Codes indicating why the family member history was done.
... reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse | DiagnosticReport | DocumentReference) Why was family member history performed?
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:reasonReference 0..1 Reference(Resource) STU3: reasonReference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... note 0..* Annotation General note about related person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)
... condition 0..* BackboneElement Condition that the related person had
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:onset 0..1 Range, Period STU3: onset additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.onset
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code 1..1 CodeableConcept Condition suffered by relation
Binding: Condition/Problem/DiagnosisCodes (example): Identification of the Condition or diagnosis.
.... 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
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-FamilyMemberHistory.condition.note
Constraints: ext-1
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FamilyMemberHistory.​meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
FamilyMemberHistory.​meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
FamilyMemberHistory.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
FamilyMemberHistory.​text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
FamilyMemberHistory.​identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
FamilyMemberHistory.​identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
FamilyMemberHistory.​status Base required FamilyHistoryStatus 📍4.3.0 FHIR Std.
FamilyMemberHistory.​dataAbsentReason Base example FamilyHistoryAbsentReason 📍4.3.0 FHIR Std.
FamilyMemberHistory.​patient.type Base extensible ResourceType 📍4.3.0 FHIR Std.
FamilyMemberHistory.​relationship Base example FamilyMember 📍3.0.0 THO v7.1
FamilyMemberHistory.​sex Base extensible AdministrativeGender 📍4.3.0 FHIR Std.
FamilyMemberHistory.​reasonCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
FamilyMemberHistory.​reasonReference.type Base extensible ResourceType 📍4.3.0 FHIR Std.
FamilyMemberHistory.​condition.code Base example Condition/Problem/Diagnosis Codes 📍4.3.0 FHIR Std.
FamilyMemberHistory.​condition.outcome Base example Condition Outcome Codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error FamilyMemberHistory If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FamilyMemberHistory If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FamilyMemberHistory If 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-5 error FamilyMemberHistory If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FamilyMemberHistory A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning FamilyMemberHistory.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error FamilyMemberHistory.meta, FamilyMemberHistory.meta.extension, FamilyMemberHistory.meta.extension:meta, FamilyMemberHistory.meta.versionId, FamilyMemberHistory.meta.lastUpdated, FamilyMemberHistory.meta.source, FamilyMemberHistory.meta.profile, FamilyMemberHistory.meta.security, FamilyMemberHistory.meta.tag, FamilyMemberHistory.implicitRules, FamilyMemberHistory.language, FamilyMemberHistory.text, FamilyMemberHistory.text.extension, FamilyMemberHistory.text.extension:text, FamilyMemberHistory.text.status, FamilyMemberHistory.text.div, FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.identifier, FamilyMemberHistory.identifier.extension, FamilyMemberHistory.identifier.extension:identifier, FamilyMemberHistory.identifier.use, FamilyMemberHistory.identifier.type, FamilyMemberHistory.identifier.system, FamilyMemberHistory.identifier.value, FamilyMemberHistory.identifier.period, FamilyMemberHistory.identifier.assigner, FamilyMemberHistory.instantiatesCanonical, FamilyMemberHistory.instantiatesUri, FamilyMemberHistory.status, FamilyMemberHistory.dataAbsentReason, FamilyMemberHistory.patient, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient, FamilyMemberHistory.patient.reference, FamilyMemberHistory.patient.type, FamilyMemberHistory.patient.identifier, FamilyMemberHistory.patient.display, FamilyMemberHistory.date, FamilyMemberHistory.name, FamilyMemberHistory.relationship, FamilyMemberHistory.sex, FamilyMemberHistory.sex.extension, FamilyMemberHistory.sex.extension:gender, FamilyMemberHistory.sex.coding, FamilyMemberHistory.sex.text, FamilyMemberHistory.born[x], FamilyMemberHistory.age[x], FamilyMemberHistory.estimatedAge, FamilyMemberHistory.deceased[x], FamilyMemberHistory.reasonCode, FamilyMemberHistory.reasonReference, FamilyMemberHistory.reasonReference.extension, FamilyMemberHistory.reasonReference.extension:reasonReference, FamilyMemberHistory.reasonReference.reference, FamilyMemberHistory.reasonReference.type, FamilyMemberHistory.reasonReference.identifier, FamilyMemberHistory.reasonReference.display, FamilyMemberHistory.note, FamilyMemberHistory.note.extension, FamilyMemberHistory.note.extension:note, FamilyMemberHistory.note.author[x], FamilyMemberHistory.note.time, FamilyMemberHistory.note.text, FamilyMemberHistory.condition, FamilyMemberHistory.condition.extension, FamilyMemberHistory.condition.extension:onset, FamilyMemberHistory.condition.modifierExtension, FamilyMemberHistory.condition.code, FamilyMemberHistory.condition.outcome, FamilyMemberHistory.condition.contributedToDeath, FamilyMemberHistory.condition.onset[x], FamilyMemberHistory.condition.note, FamilyMemberHistory.condition.note.extension, FamilyMemberHistory.condition.note.extension:note, FamilyMemberHistory.condition.note.author[x], FamilyMemberHistory.condition.note.time, FamilyMemberHistory.condition.note.text All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error FamilyMemberHistory.meta.extension, FamilyMemberHistory.meta.extension:meta, FamilyMemberHistory.text.extension, FamilyMemberHistory.text.extension:text, FamilyMemberHistory.extension, FamilyMemberHistory.extension:definition, FamilyMemberHistory.extension:notDoneReason, FamilyMemberHistory.extension:born, FamilyMemberHistory.extension:age, FamilyMemberHistory.extension:deceased, FamilyMemberHistory.modifierExtension, FamilyMemberHistory.modifierExtension:notDone, FamilyMemberHistory.identifier.extension, FamilyMemberHistory.identifier.extension:identifier, FamilyMemberHistory.patient.extension, FamilyMemberHistory.patient.extension:patient, FamilyMemberHistory.sex.extension, FamilyMemberHistory.sex.extension:gender, FamilyMemberHistory.reasonReference.extension, FamilyMemberHistory.reasonReference.extension:reasonReference, FamilyMemberHistory.note.extension, FamilyMemberHistory.note.extension:note, FamilyMemberHistory.condition.extension, FamilyMemberHistory.condition.extension:onset, FamilyMemberHistory.condition.modifierExtension, FamilyMemberHistory.condition.note.extension, FamilyMemberHistory.condition.note.extension:note Must have either extensions or value[x], not both extension.exists() != value.exists()
fhs-1 error FamilyMemberHistory Can have age[x] or born[x], but not both age.empty() or born.empty()
fhs-2 error FamilyMemberHistory Can only have estimatedAge if age[x] is present age.exists() or estimatedAge.empty()
txt-1 error FamilyMemberHistory.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error FamilyMemberHistory.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron