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

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

Resource Profile: Profile_R4_FamilyMemberHistory_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-FamilyMemberHistory resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. FamilyMemberHistory
Definition

Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

ShortInformation about patient's relatives, relevant for patient
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
fhs-2: Can only have estimatedAge if age[x] is present (age.exists() or estimatedAge.empty())
fhs-3: Not Done Reason can only be specified if NotDone is "true" (notDone or notDoneReason.exists().not())
fhs-1: Can have age[x] or born[x], but not both (age.empty() or born.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
fhs-2: Can only have estimatedAge if age[x] is present (age.exists() or estimatedAge.empty())
fhs-3: Not Done Reason can only be specified if NotDone is "true" (notDone or notDoneReason.exists().not())
fhs-1: Can have age[x] or born[x], but not both (age.empty() or born.empty())
2. FamilyMemberHistory.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. FamilyMemberHistory.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional Content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on FamilyMemberHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. FamilyMemberHistory.extension:instantiatesUri
    Slice NameinstantiatesUri
    Definition

    R4: FamilyMemberHistory.instantiatesUri (new:uri)

    ShortR4: Instantiates external protocol or definition (new)
    Comments

    Element FamilyMemberHistory.instantiatesUri has a context of FamilyMemberHistory based on following the parent source element upwards and mapping to FamilyMemberHistory. Element FamilyMemberHistory.instantiatesUri has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(R4: Instantiates external protocol or definition (new)) (Extension Type: uri)
    Is Modifierfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. FamilyMemberHistory.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Alternate Namesextensions, user content
    10. FamilyMemberHistory.status
    Definition

    A code specifying the status of the record of the family history of a specific family member.

    Shortpartial | completed | entered-in-error | health-unknown
    Comments

    This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from FamilyHistoryStatushttp://hl7.org/fhir/ValueSet/history-status|3.0.2
    (required to http://hl7.org/fhir/ValueSet/history-status|3.0.2)

    A code that identifies the status of the family history record.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    12. FamilyMemberHistory.notDone
    Definition

    If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.

    ShortThe taking of a family member's history did not occur
    Comments

    This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.

    Control0..1
    Typeboolean
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.

    Default Valuefalse
    14. FamilyMemberHistory.patient
    Definition

    The person who this history concerns.

    ShortPatient history is about
    Control1..1
    TypeReference(Patient)
    Summarytrue
    Alternate NamesProband
    16. FamilyMemberHistory.relationship
    Definition

    The type of relationship this person has to the patient (father, mother, brother etc.).

    ShortRelationship to the subject
    Control1..1
    BindingFor example codes, see FamilyMember|2014-03-26http://hl7.org/fhir/ValueSet/v3-FamilyMember|2014-03-26
    (example to http://hl7.org/fhir/ValueSet/v3-FamilyMember|2014-03-26)

    The nature of the relationship between the patient and the related person being described in the family member history.

    TypeCodeableConcept
    Summarytrue
    18. FamilyMemberHistory.estimatedAge
    Definition

    If true, indicates that the age value specified is an estimated value.

    ShortAge is estimated?
    Comments

    This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age.

    Control0..1
    This element is affected by the following invariants: fhs-2
    Typeboolean
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Clinicians often prefer to specify an estimaged age rather than an age range.

    Meaning if MissingIt is unknown whether the age is an estimate or not

    Guidance on how to interpret the contents of this table can be foundhere

    0. FamilyMemberHistory
    2. FamilyMemberHistory.extension
    Control0..*
    SlicingThis element introduces a set of slices on FamilyMemberHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. FamilyMemberHistory.extension:instantiatesUri
      Slice NameinstantiatesUri
      Definition

      R4: FamilyMemberHistory.instantiatesUri (new:uri)

      ShortR4: Instantiates external protocol or definition (new)
      Comments

      Element FamilyMemberHistory.instantiatesUri has a context of FamilyMemberHistory based on following the parent source element upwards and mapping to FamilyMemberHistory. Element FamilyMemberHistory.instantiatesUri has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

      Control0..*
      TypeExtension(R4: Instantiates external protocol or definition (new)) (Extension Type: uri)
      6. FamilyMemberHistory.definition
      8. FamilyMemberHistory.definition.extension
      Control0..*
      SlicingThis element introduces a set of slices on FamilyMemberHistory.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. FamilyMemberHistory.definition.extension:instantiatesCanonical
        Slice NameinstantiatesCanonical
        Definition

        R4: FamilyMemberHistory.instantiatesCanonical additional types (canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Measure), canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition))

        ShortR4: Instantiates FHIR protocol or definition additional types
        Comments

        Element FamilyMemberHistory.instantiatesCanonical is mapped to FHIR STU3 element FamilyMemberHistory.definition as SourceIsBroaderThanTarget. The mappings for FamilyMemberHistory.instantiatesCanonical do not cover the following types: canonical.

        Control0..*
        TypeExtension(R4: Instantiates FHIR protocol or definition additional types) (Extension Type: uri(Cross-version Profile for R4.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R4.Questionnaire for use in FHIR STU3, Questionnaire, Cross-version Profile for R4.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R4.Measure for use in FHIR STU3, Measure, Cross-version Profile for R4.OperationDefinition for use in FHIR STU3, OperationDefinition))
        12. FamilyMemberHistory.gender
        14. FamilyMemberHistory.gender.extension
        Control0..*
        SlicingThis element introduces a set of slices on FamilyMemberHistory.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. FamilyMemberHistory.gender.extension:sex
          Slice Namesex
          Definition

          R4: FamilyMemberHistory.sex additional types (CodeableConcept) additional types from child elements (coding)

          ShortR4: sex additional types
          Comments

          Element FamilyMemberHistory.sex is mapped to FHIR STU3 element FamilyMemberHistory.gender as SourceIsBroaderThanTarget. The mappings for FamilyMemberHistory.sex do not cover the following types: CodeableConcept. The mappings for FamilyMemberHistory.sex do not cover the following types based on type expansion: coding. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.

          Control0..1
          TypeExtension(R4: sex additional types) (Extension Type: CodeableConcept)
          18. FamilyMemberHistory.reasonReference
          20. FamilyMemberHistory.reasonReference.extension
          Control0..*
          SlicingThis element introduces a set of slices on FamilyMemberHistory.reasonReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. FamilyMemberHistory.reasonReference.extension:reasonReference
            Slice NamereasonReference
            Definition

            R4: FamilyMemberHistory.reasonReference

            ShortR4: reasonReference
            Comments

            Element FamilyMemberHistory.reasonReference is mapped to FHIR STU3 element FamilyMemberHistory.reasonReference as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element FamilyMemberHistory.reasonReference with unmapped reference targets: DiagnosticReport, DocumentReference.

            Control0..*
            TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
            24. FamilyMemberHistory.condition
            26. FamilyMemberHistory.condition.extension
            Control0..*
            SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 28. FamilyMemberHistory.condition.extension:contributedToDeath
              Slice NamecontributedToDeath
              Definition

              R4: FamilyMemberHistory.condition.contributedToDeath (new:boolean)

              ShortR4: Whether the condition contributed to the cause of death (new)
              Comments

              Element FamilyMemberHistory.condition.contributedToDeath has a context of FamilyMemberHistory.condition based on following the parent source element upwards and mapping to FamilyMemberHistory. Element FamilyMemberHistory.condition.contributedToDeath has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

              Control0..1
              TypeExtension(R4: Whether the condition contributed to the cause of death (new)) (Extension Type: boolean)

              Guidance on how to interpret the contents of this table can be foundhere

              0. FamilyMemberHistory
              Definition

              Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

              ShortInformation about patient's relatives, relevant for patient
              Control0..*
              Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
              dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
              fhs-2: Can only have estimatedAge if age[x] is present (age.exists() or estimatedAge.empty())
              fhs-3: Not Done Reason can only be specified if NotDone is "true" (notDone or notDoneReason.exists().not())
              fhs-1: Can have age[x] or born[x], but not both (age.empty() or born.empty())
              2. FamilyMemberHistory.id
              Definition

              The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

              ShortLogical id of this artifact
              Comments

              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

              Control0..1
              Typeid
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              4. FamilyMemberHistory.meta
              Definition

              The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Summarytrue
              6. FamilyMemberHistory.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

              This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

              Control0..1
              Typeuri
              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              8. FamilyMemberHistory.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from Common Languages
              (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

              A human language.

              Additional BindingsPurpose
              All LanguagesMax Binding
              Typecode
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              10. FamilyMemberHistory.text
              Definition

              A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

              Control0..1
              This element is affected by the following invariants: dom-1
              TypeNarrative
              Alternate Namesnarrative, html, xhtml, display
              12. FamilyMemberHistory.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

              Control0..*
              TypeResource
              Alternate Namesinline resources, anonymous resources, contained resources
              14. FamilyMemberHistory.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              SlicingThis element introduces a set of slices on FamilyMemberHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. FamilyMemberHistory.extension:instantiatesUri
                Slice NameinstantiatesUri
                Definition

                R4: FamilyMemberHistory.instantiatesUri (new:uri)

                ShortR4: Instantiates external protocol or definition (new)
                Comments

                Element FamilyMemberHistory.instantiatesUri has a context of FamilyMemberHistory based on following the parent source element upwards and mapping to FamilyMemberHistory. Element FamilyMemberHistory.instantiatesUri has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(R4: Instantiates external protocol or definition (new)) (Extension Type: uri)
                Is Modifierfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                18. FamilyMemberHistory.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                Alternate Namesextensions, user content
                20. FamilyMemberHistory.identifier
                Definition

                This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

                ShortExternal Id(s) for this record
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..*
                TypeIdentifier
                Summarytrue
                Requirements

                Need to allow connection to a wider workflow.

                22. FamilyMemberHistory.definition
                Definition

                A protocol or questionnaire that was adhered to in whole or in part by this event.

                ShortInstantiates protocol or definition
                Control0..*
                TypeReference(PlanDefinition, Questionnaire)
                Summarytrue
                24. FamilyMemberHistory.definition.id
                Definition

                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                26. FamilyMemberHistory.definition.extension
                Definition

                An Extension

                ShortExtension
                Control0..*
                TypeExtension
                SlicingThis element introduces a set of slices on FamilyMemberHistory.definition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 28. FamilyMemberHistory.definition.extension:instantiatesCanonical
                  Slice NameinstantiatesCanonical
                  Definition

                  R4: FamilyMemberHistory.instantiatesCanonical additional types (canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Measure), canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition))

                  ShortR4: Instantiates FHIR protocol or definition additional types
                  Comments

                  Element FamilyMemberHistory.instantiatesCanonical is mapped to FHIR STU3 element FamilyMemberHistory.definition as SourceIsBroaderThanTarget. The mappings for FamilyMemberHistory.instantiatesCanonical do not cover the following types: canonical.

                  Control0..*
                  TypeExtension(R4: Instantiates FHIR protocol or definition additional types) (Extension Type: uri(Cross-version Profile for R4.PlanDefinition for use in FHIR STU3, PlanDefinition, Cross-version Profile for R4.Questionnaire for use in FHIR STU3, Questionnaire, Cross-version Profile for R4.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R4.Measure for use in FHIR STU3, Measure, Cross-version Profile for R4.OperationDefinition for use in FHIR STU3, OperationDefinition))
                  30. FamilyMemberHistory.definition.reference
                  Definition

                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                  ShortLiteral reference, Relative, internal or absolute URL
                  Comments

                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                  Control0..1
                  This element is affected by the following invariants: ref-1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  32. FamilyMemberHistory.definition.identifier
                  Definition

                  An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                  ShortLogical reference, when literal reference is not known
                  Comments

                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Summarytrue
                  34. FamilyMemberHistory.definition.display
                  Definition

                  Plain text narrative that identifies the resource in addition to the resource reference.

                  ShortText alternative for the resource
                  Comments

                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  36. FamilyMemberHistory.status
                  Definition

                  A code specifying the status of the record of the family history of a specific family member.

                  Shortpartial | completed | entered-in-error | health-unknown
                  Comments

                  This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

                  Control1..1
                  BindingThe codes SHALL be taken from FamilyHistoryStatus
                  (required to http://hl7.org/fhir/ValueSet/history-status|3.0.2)

                  A code that identifies the status of the family history record.

                  Typecode
                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  38. FamilyMemberHistory.notDone
                  Definition

                  If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.

                  ShortThe taking of a family member's history did not occur
                  Comments

                  This element is labeled as a modifier because it marks the family member history as a family member history that did not occur. The more attributes are populated, the more constrained the negated statement is. This notDone element is being evaluated and will likely be removed in a subsequent release.

                  Control0..1
                  Typeboolean
                  Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Creating a FamilyMemberHistory where notDone is true is intended for situations where there's a need for a specific statement in the record about something not being done. If the need is merely to indicate that a request wasn't fulfilled, that should be handled using Task.

                  Default Valuefalse
                  40. FamilyMemberHistory.notDoneReason
                  Definition

                  Describes why the family member's history is absent.

                  Shortsubject-unknown | withheld | unable-to-obtain | deferred
                  Comments

                  This notDoneReason element is being evaluated and will likely be replaced in a subsequent release (e.g. dataAbsentReason).

                  Control0..1
                  This element is affected by the following invariants: fhs-3
                  BindingFor example codes, see FamilyHistoryNotDoneReason
                  (example to http://hl7.org/fhir/ValueSet/history-not-done-reason|3.0.2)

                  Codes describing the reason why a family member history was not done.

                  TypeCodeableConcept
                  Summarytrue
                  Requirements

                  This is a separate element to allow it to have a distinct binding from reasonCode.

                  42. FamilyMemberHistory.patient
                  Definition

                  The person who this history concerns.

                  ShortPatient history is about
                  Control1..1
                  TypeReference(Patient)
                  Summarytrue
                  Alternate NamesProband
                  44. FamilyMemberHistory.date
                  Definition

                  The date (and possibly time) when the family member history was taken.

                  ShortWhen history was captured/updated
                  Comments

                  This should be captured even if the same as the date on the List aggregating the full family history.

                  Control0..1
                  TypedateTime
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows determination of how current the summary is.

                  46. FamilyMemberHistory.name
                  Definition

                  This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".

                  ShortThe family member described
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows greater ease in ensuring the same person is being talked about.

                  48. FamilyMemberHistory.relationship
                  Definition

                  The type of relationship this person has to the patient (father, mother, brother etc.).

                  ShortRelationship to the subject
                  Control1..1
                  BindingFor example codes, see FamilyMember|2014-03-26
                  (example to http://hl7.org/fhir/ValueSet/v3-FamilyMember|2014-03-26)

                  The nature of the relationship between the patient and the related person being described in the family member history.

                  TypeCodeableConcept
                  Summarytrue
                  50. FamilyMemberHistory.gender
                  Definition

                  Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.

                  Shortmale | female | other | unknown
                  Control0..1
                  BindingThe codes SHALL be taken from AdministrativeGender
                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|3.0.2)

                  The gender of a person used for administrative purposes.

                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Not all relationship codes imply gender and the relative's gender can be relevant for risk assessments.

                  52. FamilyMemberHistory.gender.id
                  Definition

                  unique id for the element within a resource (for internal references)

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  54. FamilyMemberHistory.gender.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  SlicingThis element introduces a set of slices on FamilyMemberHistory.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 56. FamilyMemberHistory.gender.extension:sex
                    Slice Namesex
                    Definition

                    R4: FamilyMemberHistory.sex additional types (CodeableConcept) additional types from child elements (coding)

                    ShortR4: sex additional types
                    Comments

                    Element FamilyMemberHistory.sex is mapped to FHIR STU3 element FamilyMemberHistory.gender as SourceIsBroaderThanTarget. The mappings for FamilyMemberHistory.sex do not cover the following types: CodeableConcept. The mappings for FamilyMemberHistory.sex do not cover the following types based on type expansion: coding. This element should ideally reflect whether the individual is genetically male or female. However, as reported information based on the knowledge of the patient or reporting friend/relative, there may be situations where the reported sex might not be totally accurate. E.g. 'Aunt Sue' might be XY rather than XX. Questions soliciting this information should be phrased to encourage capture of genetic sex where known. However, systems performing analysis should also allow for the possibility of imprecision with this element.

                    Control0..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(R4: sex additional types) (Extension Type: CodeableConcept)
                    Is Modifierfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    58. FamilyMemberHistory.gender.value
                    Definition

                    Primitive value for code

                    ShortPrimitive value for code
                    Control0..1
                    Typecode
                    XML FormatIn the XML format, this property is represented as an attribute.
                    60. FamilyMemberHistory.born[x]
                    Definition

                    The actual or approximate date of birth of the relative.

                    Short(approximate) date of birth
                    Control0..1
                    This element is affected by the following invariants: fhs-1
                    TypeChoice of: Period, date, string
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Requirements

                    Allows calculation of the relative's age.

                    62. FamilyMemberHistory.age[x]
                    Definition

                    The age of the relative at the time the family member history is recorded.

                    Short(approximate) age
                    Comments

                    use estimatedAge to indicate whether the age is actual or not.

                    Control0..1
                    This element is affected by the following invariants: fhs-1
                    TypeChoice of: Age, Range, string
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians.

                    64. FamilyMemberHistory.estimatedAge
                    Definition

                    If true, indicates that the age value specified is an estimated value.

                    ShortAge is estimated?
                    Comments

                    This element is labeled as a modifier because the fact tha age is estimated can/should change the results of any algorithm that calculates based on the specified age.

                    Control0..1
                    This element is affected by the following invariants: fhs-2
                    Typeboolean
                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Clinicians often prefer to specify an estimaged age rather than an age range.

                    Meaning if MissingIt is unknown whether the age is an estimate or not
                    66. FamilyMemberHistory.deceased[x]
                    Definition

                    Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

                    ShortDead? How old/when?
                    Control0..1
                    TypeChoice of: boolean, Age, Range, date, string
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    68. FamilyMemberHistory.reasonCode
                    Definition

                    Describes why the family member history occurred in coded or textual form.

                    ShortWhy was family member history performed?
                    Comments

                    Textual reasons can be caprued using reasonCode.text.

                    Control0..*
                    BindingFor example codes, see SNOMED CT Clinical Findings
                    (example to http://hl7.org/fhir/ValueSet/clinical-findings|3.0.2)

                    Codes indicating why the family member history was done.

                    TypeCodeableConcept
                    Summarytrue
                    70. FamilyMemberHistory.reasonReference
                    Definition

                    Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

                    ShortWhy was family member history performed?
                    Control0..*
                    TypeReference(Condition, Observation, AllergyIntolerance, QuestionnaireResponse)
                    Summarytrue
                    72. FamilyMemberHistory.reasonReference.id
                    Definition

                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    74. FamilyMemberHistory.reasonReference.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    SlicingThis element introduces a set of slices on FamilyMemberHistory.reasonReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 76. FamilyMemberHistory.reasonReference.extension:reasonReference
                      Slice NamereasonReference
                      Definition

                      R4: FamilyMemberHistory.reasonReference

                      ShortR4: reasonReference
                      Comments

                      Element FamilyMemberHistory.reasonReference is mapped to FHIR STU3 element FamilyMemberHistory.reasonReference as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR R4 element FamilyMemberHistory.reasonReference with unmapped reference targets: DiagnosticReport, DocumentReference.

                      Control0..*
                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                      78. FamilyMemberHistory.reasonReference.reference
                      Definition

                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                      ShortLiteral reference, Relative, internal or absolute URL
                      Comments

                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                      Control0..1
                      This element is affected by the following invariants: ref-1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      80. FamilyMemberHistory.reasonReference.identifier
                      Definition

                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                      ShortLogical reference, when literal reference is not known
                      Comments

                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1
                      TypeIdentifier
                      Summarytrue
                      82. FamilyMemberHistory.reasonReference.display
                      Definition

                      Plain text narrative that identifies the resource in addition to the resource reference.

                      ShortText alternative for the resource
                      Comments

                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      84. FamilyMemberHistory.note
                      Definition

                      This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

                      ShortGeneral note about related person
                      Control0..*
                      TypeAnnotation
                      86. FamilyMemberHistory.condition
                      Definition

                      The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

                      ShortCondition that the related person had
                      Comments

                      If none of the conditions listed have an outcome of "death" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.

                      Control0..*
                      TypeBackboneElement
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                      88. FamilyMemberHistory.condition.id
                      Definition

                      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      90. FamilyMemberHistory.condition.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      SlicingThis element introduces a set of slices on FamilyMemberHistory.condition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 92. FamilyMemberHistory.condition.extension:contributedToDeath
                        Slice NamecontributedToDeath
                        Definition

                        R4: FamilyMemberHistory.condition.contributedToDeath (new:boolean)

                        ShortR4: Whether the condition contributed to the cause of death (new)
                        Comments

                        Element FamilyMemberHistory.condition.contributedToDeath has a context of FamilyMemberHistory.condition based on following the parent source element upwards and mapping to FamilyMemberHistory. Element FamilyMemberHistory.condition.contributedToDeath has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(R4: Whether the condition contributed to the cause of death (new)) (Extension Type: boolean)
                        Is Modifierfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        94. FamilyMemberHistory.condition.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        ShortExtensions that cannot be ignored
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                        Summarytrue
                        Alternate Namesextensions, user content, modifiers
                        96. FamilyMemberHistory.condition.code
                        Definition

                        The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.

                        ShortCondition suffered by relation
                        Control1..1
                        BindingFor example codes, see Condition/Problem/Diagnosis Codes
                        (example to http://hl7.org/fhir/ValueSet/condition-code|3.0.2)

                        Identification of the Condition or diagnosis.

                        TypeCodeableConcept
                        98. FamilyMemberHistory.condition.outcome
                        Definition

                        Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.

                        Shortdeceased | permanent disability | etc.
                        Control0..1
                        BindingFor example codes, see Condition Outcome Codes
                        (example to http://hl7.org/fhir/ValueSet/condition-outcome|3.0.2)

                        The result of the condition for the patient; e.g. death, permanent disability, temporary disability, etc.

                        TypeCodeableConcept
                        100. FamilyMemberHistory.condition.onset[x]
                        Definition

                        Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.

                        ShortWhen condition first manifested
                        Control0..1
                        TypeChoice of: Age, Range, Period, string
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Requirements

                        Age of onset of a condition in relatives is predictive of risk for the patient.

                        102. FamilyMemberHistory.condition.note
                        Definition

                        An area where general notes can be placed about this specific condition.

                        ShortExtra information about condition
                        Control0..*
                        TypeAnnotation