Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED)
0.1.0 - ci-build

Moderne Patient:innenabrechnung und Datenkommunikation on FHIR (MOPED) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MopedPatientKlarnameBund - Detailed Descriptions

Draft as of 2026-05-15

Definitions for the MopedPatientKlarnameBund resource profile.

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

0. Patient
Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

ShortInformation about an individual or animal receiving health care services
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesSubjectOfCare Client Resident
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
mandatory-gemeindecode-for-AUT: Der Gemeindecode ist für inländische Patienten verpflichtend anzugeben (address.where(country = 'AUT').extension.where(url = 'http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-address-municipalityCode').exists())
mandatory-postal-code-for-AUT: Die Postleitzahl ist für inländische Patienten verpflichtend anzugeben (address.where(country = 'AUT').postalCode.exists())
2. Patient.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..01
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Patient.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..01
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Patient.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..0*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
8. Patient.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

Control10..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Patient.extension:citizenship
    Slice Namecitizenship
    Definition

    The patient's legal status as citizen of a country.

    ShortNation(s) where the patient claims citizenship
    Control1..1
    TypeExtension(Patient Citizenship) (Complex Extension)
    Is Modifierfalse
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Patient.extension:citizenship.extension:code
    Slice Namecode
    Definition

    An Extension

    ShortExtensionAdditional content defined by implementations
    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Patient.extension:citizenship.extension:code.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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..0*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 16. Patient.extension:citizenship.extension:code.url
      Definition

      Source of the definition for the extension code - a logical name or a URL.

      Shortidentifies the meaning of the extension
      Comments

      The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

      Control1..1
      Typeuri
      Is Modifierfalse
      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.
      Summaryfalse
      Fixed Valuecode
      18. Patient.extension:citizenship.extension:code.value[x]
      Definition

      Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      ShortStaatsbürgerschaftValue of extension
      Control10..1
      This element is affected by the following invariants: ext-1
      BindingUnless not suitable, these codes SHALL be taken from For codes, see https://termgit.elga.gv.at/ValueSet/elga-laendercodes
      (extensible to https://termgit.elga.gv.at/ValueSet/elga-laendercodes)
      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Obligations
        ObligationsActorSource
        SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Patient.extension:citizenship.extension:period
        Slice Nameperiod
        Definition

        An Extension

        ShortExtensionAdditional content defined by implementations
        Control0..0*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        25. Patient.extension:citizenship.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-citizenship
        27. Patient.extension:citizenship.value[x]
        Definition

        Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

        ShortValue of extension
        Control0..01
        This element is affected by the following invariants: ext-1
        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        29. Patient.extension:PatientReligion
        Slice NamePatientReligion
        Definition

        The patient's professed religious affiliations.

        ShortThe patient's professed religious affiliations
        Control0..0
        TypeExtension(Patient Religion) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        34. Patient.extension:birthPlace
        Slice NamebirthPlace
        Definition

        The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

        ShortPlace of Birth for patient
        Control0..0
        TypeExtension(Patient Birth Place) (Extension Type: Address)
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        39. Patient.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Must Supportfalse
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        41. Patient.identifier
        Definition

        An identifier for this patient.

        ShortAn identifier for this patient
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Requirements

        Patients are almost always assigned specific numerical identifiers.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ type.coding.code
        • 43. Patient.identifier:socialSecurityNumber
          Slice NamesocialSecurityNumber
          Definition

          An identifier for this patient.

          ShortAn identifier for this patient
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..0*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Patients are almost always assigned specific numerical identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          47. Patient.identifier:bPK
          Slice NamebPK
          Definition

          An identifier for this patient.

          ShortAn identifier for this patient
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..0*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Patients are almost always assigned specific numerical identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          51. Patient.identifier:localPatientId
          Slice NamelocalPatientId
          Definition

          An identifier for this patient.

          ShortAn identifier for this patient
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..0*
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Patients are almost always assigned specific numerical identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          55. Patient.active
          Definition

          Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

          It is often used to filter patient lists to exclude inactive patients

          Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

          ShortWhether this patient's record is in active use
          Comments

          If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

          Control0..01
          Typeboolean
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Requirements

          Need to be able to mark a patient record as not to be used because it was created in error.

          Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          57. Patient.name
          Definition

          A name associated with the individual.

          ShortA name associated with the patient
          Comments

          A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

          Control10..1*
          TypeHumanName
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          59. Patient.name.extension
          Definition

          An Extension


          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

          Control10..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 61. Patient.name.extension:data-absent-reason
            Slice Namedata-absent-reason
            Definition

            Provides a reason why the expected value or elements in the element that is extended are missing.

            Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
            Control1..1
            TypeExtension(Data Absent Reason) (Extension Type: code)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            63. Patient.name.extension:data-absent-reason.extension
            Definition

            An Extension


            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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..0*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 65. Patient.name.extension:data-absent-reason.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
              67. Patient.name.extension:data-absent-reason.value[x]
              Definition

              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

              ShortValue of extension
              Control10..1
              This element is affected by the following invariants: ext-1
              BindingThe codes SHALL be taken from For codes, see DataAbsentReason
              (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
              Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Fixed Valuemasked
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              69. Patient.name.use
              Definition

              Identifies the purpose for this name.

              Shortusual | official | temp | nickname | anonymous | old | maiden
              Comments

              Applications can assume that a name is current unless it explicitly says that it is temporary or old.

              Control0..01
              BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|5.0.0
              (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

              The use of a human name.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate name for a particular context of use to be selected from among a set of names.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              71. Patient.name.text
              Definition

              Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

              ShortText representation of the full name
              Comments

              Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

              Control0..01
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              A renderable, unencoded form.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              73. Patient.name.family
              Definition

              The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

              ShortZuname des PatientenFamily name (often called 'Surname')
              Comments

              Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

              Control0..01
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Obligations
                ObligationsActorSource
                SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                Summarytrue
                Alternate Namessurname
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                75. Patient.name.given
                Definition

                Given name.

                ShortVorname des PatientenGiven names (not always 'first'). Includes middle names
                Comments

                If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                Control0..0*
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Obligations
                  ObligationsActorSource
                  SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                  Summarytrue
                  Alternate Namesfirst name, middle name
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  77. Patient.name.prefix
                  Definition

                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                  ShortParts that come before the name
                  Control0..0*
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  79. Patient.name.suffix
                  Definition

                  Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                  ShortParts that come after the name
                  Control0..0*
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  81. Patient.name.period
                  Definition

                  Indicates the period of time when this name was valid for the named person.

                  ShortTime period when name was/is in use
                  Control0..01
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows names to be placed in historical context.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  83. Patient.telecom
                  Definition

                  A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                  ShortA contact detail for the individual
                  Comments

                  A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                  Control0..0*
                  TypeContactPoint
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Requirements

                  People have (primary) ways to contact them in some way such as phone, email.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  86. Patient.gender
                  Definition

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

                  ShortAdministratives Geschlecht des Patientenmale | female | other | unknown
                  Comments

                  The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                  Control10..1
                  BindingThe codes SHALL be taken from AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
                  (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

                  The gender of a person used for administrative purposes.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supporttrue
                  Obligations
                    ObligationsActorSource
                    SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                    Summarytrue
                    Requirements

                    Needed for identification of the individual, in combination with (at least) name and birth date.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. Patient.gender.extension:AdministrativeGenderAddition
                    Slice NameAdministrativeGenderAddition
                    Definition

                    HL7® Austria FHIR® Core Extension for the administrative gender of a person (Patient, Practitioner, ...). The extension is used to add the missing codes and is applied in case the code for administrative gender itself is set to 'other'.

                    ShortAdministrative Gender Addition
                    Control0..1
                    TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    90. Patient.birthDate
                    Definition

                    The date of birth for the individual.

                    ShortGeburtsdatum des PatientenThe date of birth for the individual
                    Comments

                    Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                    Control0..01
                    Typedate
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Obligations
                      ObligationsActorSource
                      SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                      Summarytrue
                      Requirements

                      Age of the individual drives many clinical processes.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      93. Patient.deceased[x]
                      Definition

                      Indicates if the individual is deceased or not.

                      ShortIndicates if the individual is deceased or not
                      Comments

                      If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                      Control0..01
                      Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                      Must Supportfalse
                      Summarytrue
                      Requirements

                      The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 95. Patient.deceased[x]:deceasedBoolean
                        Slice NamedeceasedBoolean
                        Definition

                        Indicates if the individual is deceased or not.

                        ShortIndicates if the individual is deceased or not
                        Comments

                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                        Control0..01
                        Typeboolean, dateTime
                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        97. Patient.deceased[x]:deceasedDateTime
                        Slice NamedeceasedDateTime
                        Definition

                        Indicates if the individual is deceased or not.

                        ShortIndicates if the individual is deceased or not
                        Comments

                        If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                        Control0..01
                        TypedateTime, boolean
                        Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        99. Patient.address
                        Definition

                        An address for the individual.

                        ShortAn address for the individual
                        Comments

                        Patient may have multiple addresses with different uses or applicable periods.

                        Control10..1*
                        TypeAddress(HL7® AT Core Address Profile)
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        101. Patient.address.extension
                        Definition

                        An Extension


                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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..1*
                        TypeExtension
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 103. Patient.address.extension:municipalityCode
                          Slice NamemunicipalityCode
                          Definition

                          HL7® Austria FHIR® Core Extension for the municipality code part of the Austrian address

                          ShortWohnsitz – Gemeindecode
                          Control0..1
                          TypeExtension(Address Municipality Code) (Extension Type: string)
                          Is Modifierfalse
                          Must Supporttrue
                          Obligations
                            ObligationsActorSource
                            SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            105. Patient.address.use
                            Definition

                            The purpose of this address.

                            Shorthome | work | temp | old | billing - purpose of this address
                            Comments

                            Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                            Control0..01
                            BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|5.0.0
                            (required to http://hl7.org/fhir/ValueSet/address-use|5.0.0)

                            The use of an address (home / work / etc.).

                            Typecode
                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Allows an appropriate address to be chosen from a list of many.

                            ExampleGeneral: home
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            107. Patient.address.type
                            Definition

                            Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                            Shortpostal | physical | both
                            Comments

                            The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).


                            The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                            Control0..01
                            BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|5.0.0
                            (required to http://hl7.org/fhir/ValueSet/address-type|5.0.0)

                            The type of an address (physical / postal).

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            ExampleGeneral: both
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            109. Patient.address.text
                            Definition

                            Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                            ShortText representation of the address
                            Comments

                            Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                            Control0..01
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            A renderable, unencoded form.

                            ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            111. Patient.address.line
                            Definition

                            This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way.


                            This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                            ShortStreet name, number, direction & P.O. Box etc.
                            Control0..*
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            ExampleGeneral: 137 Nowhere Street
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            113. Patient.address.line.extension:street
                            Slice Namestreet
                            Definition

                            streetName.

                            ShortstreetName
                            Control0..0
                            TypeExtension(ADXP Street Name) (Extension Type: string)
                            Is Modifierfalse
                            Must Supporttrue
                            Obligations
                              ObligationsActorSource
                              SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              115. Patient.address.line.extension:streetNumber
                              Slice NamestreetNumber
                              Definition

                              Number of the street without the street name

                              ShortNumber of the street
                              Control0..1
                              TypeExtension(ADXP House Number) (Extension Type: string)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              117. Patient.address.line.extension:floorDoorNumber
                              Slice NamefloorDoorNumber
                              Definition

                              Floor and/or door number

                              ShortFloor and/or door number
                              Control0..1
                              TypeExtension(ADXP Additional Locator) (Extension Type: string)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              119. Patient.address.line.extension:additionalInformation
                              Slice NameadditionalInformation
                              Definition

                              Additional information about the street address

                              ShortAdditional Information
                              Control0..1
                              TypeExtension(Address Additional Information) (Extension Type: string)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              121. Patient.address.city
                              Definition

                              The name of the city, town, suburb, village or other community or delivery center.

                              ShortWohnortName of city, town etc.
                              Control0..01
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Obligations
                                ObligationsActorSource
                                SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                Summarytrue
                                Alternate NamesMunicpality
                                ExampleGeneral: Erewhon
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                123. Patient.address.district
                                Definition

                                The name of the administrative area (county).

                                ShortDistrict name (aka county)
                                Comments

                                District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                Control0..01
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesCounty
                                ExampleGeneral: Madison
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                125. Patient.address.state
                                Definition

                                Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                ShortSub-unit of country (abbreviations ok)
                                Control0..01
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesProvince, Territory
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                127. Patient.address.postalCode
                                Definition

                                A postal code designating a region defined by the postal service.

                                ShortWohnsitz – PostleitzahlPostal code for area
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Obligations
                                  ObligationsActorSource
                                  SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                  Summarytrue
                                  Alternate NamesZip
                                  ExampleGeneral: 9132
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  129. Patient.address.country
                                  Definition

                                  Country - a nation as commonly understood or generally accepted.

                                  ShortWohnsitz – StaatCountry (e.g. may be ISO 3166 2 or 3 letter code)
                                  Comments

                                  ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

                                  Control10..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActorSource
                                    SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    131. Patient.address.period
                                    Definition

                                    Time period when address was/is in use.

                                    ShortTime period when address was/is in use
                                    Control0..01
                                    TypePeriod
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

                                    Allows addresses to be placed in historical context.

                                    ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    133. Patient.maritalStatus
                                    Definition

                                    This field contains a patient's most recent marital (civil) status.

                                    ShortMarital (civil) status of a patient
                                    Control0..01
                                    BindingUnless not suitable, these codes SHALL be taken from MaritalStatusCodeshttp://hl7.org/fhir/ValueSet/marital-status|5.0.0
                                    (extensible to http://hl7.org/fhir/ValueSet/marital-status|5.0.0)

                                    The domestic partnership status of a person.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Requirements

                                    Most, if not all systems capture it.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    135. Patient.multipleBirth[x]
                                    Definition

                                    Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                    ShortWhether patient is part of a multiple birth
                                    Comments

                                    Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                    Control0..01
                                    Is Modifierfalse
                                    Must Supportfalse
                                    Summaryfalse
                                    Requirements

                                    For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                    • type @ $this
                                    • 137. Patient.multipleBirth[x]:multipleBirthBoolean
                                      Slice NamemultipleBirthBoolean
                                      Definition

                                      Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                      ShortWhether patient is part of a multiple birth
                                      Comments

                                      Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                      Control0..01
                                      Typeboolean, integer
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      139. Patient.multipleBirth[x]:multipleBirthInteger
                                      Slice NamemultipleBirthInteger
                                      Definition

                                      Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                      ShortWhether patient is part of a multiple birth
                                      Comments

                                      Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                      Control0..01
                                      Typeinteger, boolean
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      141. Patient.photo
                                      Definition

                                      Image of the patient.

                                      ShortImage of the patient
                                      Comments

                                      Guidelines:

                                      • Use id photos, not clinical photos.
                                      • Limit dimensions to thumbnail.
                                      • Keep byte count low to ease resource updates.
                                      Control0..0*
                                      TypeAttachment
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      143. Patient.contact
                                      Definition

                                      A contact party (e.g. guardian, partner, friend) for the patient.

                                      ShortA contact party (e.g. guardian, partner, friend) for the patient
                                      Comments

                                      Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                      Control0..0*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      Need to track people you can contact about the patient.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                      146. Patient.communication
                                      Definition

                                      A language which may be used to communicate with the patient about his or her health.

                                      ShortA language which may be used to communicate with the patient about his or her health
                                      Comments

                                      If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                      Control0..0*
                                      TypeBackboneElement
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Requirements

                                      If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      150. Patient.generalPractitioner
                                      Definition

                                      Patient's nominated care provider.

                                      ShortPatient's nominated primary care provider
                                      Comments

                                      This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                      Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                      Control0..0*
                                      TypeReference(Organization, Practitioner, PractitionerRole)
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate NamescareProvider
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      152. Patient.managingOrganization
                                      Definition

                                      Organization that is the custodian of the patient record.

                                      ShortOrganization that is the custodian of the patient record
                                      Comments

                                      There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                      Control0..01
                                      TypeReference(Organization)
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Requirements

                                      Need to know who recognizes this patient record, manages and updates it.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      154. Patient.link
                                      Definition

                                      Link to a Patient or RelatedPerson resource that concerns the same actual individual.

                                      ShortLink to a Patient or RelatedPerson resource that concerns the same actual individual
                                      Comments

                                      There is no assumption that linked patient records have mutual links.

                                      Control0..0*
                                      TypeBackboneElement
                                      Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                      Must Supportfalse
                                      Summarytrue
                                      Requirements

                                      There are multiple use cases:

                                      • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                      • Distribution of patient information across multiple servers.
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

                                      0. Patient
                                      2. Patient.extension
                                      Control1..?
                                      4. Patient.extension:citizenship
                                      Slice Namecitizenship
                                      Control1..?
                                      6. Patient.name
                                      8. Patient.name.extension
                                      Control1..?
                                      10. Patient.name.extension:data-absent-reason
                                      Slice Namedata-absent-reason
                                      Control1..1
                                      TypeExtension(Data Absent Reason) (Extension Type: code)
                                      12. Patient.name.extension:data-absent-reason.value[x]
                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                      Fixed Valuemasked
                                      14. Patient.name.family
                                      Control0..0
                                      16. Patient.name.given
                                      Control0..0
                                      18. Patient.birthDate
                                      Control0..0
                                      20. Patient.address
                                      Control1..?
                                      22. Patient.address.line
                                      24. Patient.address.line.extension:street
                                      Slice Namestreet
                                      Control0..0
                                      26. Patient.address.city
                                      Control0..0
                                      28. Patient.address.country
                                      Control1..?

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

                                      0. Patient
                                      Definition

                                      Demographics and other administrative information about an individual or animal receiving care or other health-related services.

                                      ShortInformation about an individual or animal receiving health care services
                                      Control0..*
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate NamesSubjectOfCare Client Resident
                                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                      dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                      mandatory-gemeindecode-for-AUT: Der Gemeindecode ist für inländische Patienten verpflichtend anzugeben (address.where(country = 'AUT').extension.where(url = 'http://hl7.at/fhir/HL7ATCoreProfiles/5.0.0/StructureDefinition/at-core-ext-address-municipalityCode').exists())
                                      mandatory-postal-code-for-AUT: Die Postleitzahl ist für inländische Patienten verpflichtend anzugeben (address.where(country = 'AUT').postalCode.exists())
                                      2. Patient.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

                                      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                                      Control0..1
                                      Typeid
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      4. Patient.meta
                                      Definition

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

                                      ShortMetadata about the resource
                                      Control0..1
                                      TypeMeta
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      6. Patient.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                      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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

                                      Control0..0
                                      Typeuri
                                      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      8. Patient.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..0
                                      BindingThe codes SHALL be taken from AllLanguages
                                      (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                      IETF language tag for a human language

                                      Typecode
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      10. Patient.text
                                      Definition

                                      A human-readable narrative that contains a summary of the resource and can 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 a 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 information is added later.

                                      Control0..1
                                      This element is affected by the following invariants: dom-6
                                      TypeNarrative
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate Namesnarrative, html, xhtml, display
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      12. Patient.contained
                                      Definition

                                      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                                      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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

                                      Control0..0
                                      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                                      TypeResource
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Alternate Namesinline resources, anonymous resources, contained resources
                                      14. Patient.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control1..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Must Supportfalse
                                      Summaryfalse
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Patient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 16. Patient.extension:citizenship
                                        Slice Namecitizenship
                                        Definition

                                        The patient's legal status as citizen of a country.

                                        ShortNation(s) where the patient claims citizenship
                                        Control1..1
                                        TypeExtension(Patient Citizenship) (Complex Extension)
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        18. Patient.extension:citizenship.id
                                        Definition

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

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        This element is affected by the following invariants: ele-1
                                        Typeid
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        20. Patient.extension:citizenship.extension
                                        Definition

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

                                        ShortAdditional 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
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        SlicingThis element introduces a set of slices on Patient.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 22. Patient.extension:citizenship.extension:code
                                          Slice Namecode
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..1
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          24. Patient.extension:citizenship.extension:code.id
                                          Definition

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

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          Typeid
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          26. Patient.extension:citizenship.extension:code.extension
                                          Definition

                                          An Extension

                                          ShortExtension
                                          Control0..0
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 28. Patient.extension:citizenship.extension:code.url
                                            Definition

                                            Source of the definition for the extension code - a logical name or a URL.

                                            Shortidentifies the meaning of the extension
                                            Comments

                                            The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                            Control1..1
                                            Typeuri
                                            Is Modifierfalse
                                            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.
                                            Summaryfalse
                                            Fixed Valuecode
                                            30. Patient.extension:citizenship.extension:code.value[x]
                                            Definition

                                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                            ShortStaatsbürgerschaft
                                            Control1..1
                                            This element is affected by the following invariants: ext-1
                                            BindingUnless not suitable, these codes SHALL be taken from https://termgit.elga.gv.at/ValueSet/elga-laendercodes
                                            (extensible to https://termgit.elga.gv.at/ValueSet/elga-laendercodes)
                                            TypeCodeableConcept
                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                            Is Modifierfalse
                                            Obligations
                                              ObligationsActorSource
                                              SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              32. Patient.extension:citizenship.extension:period
                                              Slice Nameperiod
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..0
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              38. Patient.extension:citizenship.url
                                              Definition

                                              Source of the definition for the extension code - a logical name or a URL.

                                              Shortidentifies the meaning of the extension
                                              Comments

                                              The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-citizenship
                                              40. Patient.extension:citizenship.value[x]
                                              Definition

                                              Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                              ShortValue of extension
                                              Control0..0
                                              This element is affected by the following invariants: ext-1
                                              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              42. Patient.extension:PatientReligion
                                              Slice NamePatientReligion
                                              Definition

                                              The patient's professed religious affiliations.

                                              ShortThe patient's professed religious affiliations
                                              Control0..0
                                              TypeExtension(Patient Religion) (Extension Type: CodeableConcept)
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              48. Patient.extension:birthPlace
                                              Slice NamebirthPlace
                                              Definition

                                              The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

                                              ShortPlace of Birth for patient
                                              Control0..0
                                              TypeExtension(Patient Birth Place) (Extension Type: Address)
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              54. Patient.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

                                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                              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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              56. Patient.identifier
                                              Definition

                                              An identifier for this patient.

                                              ShortAn identifier for this patient
                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                              Control0..*
                                              TypeIdentifier
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summarytrue
                                              Requirements

                                              Patients are almost always assigned specific numerical identifiers.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ type.coding.code
                                              • 58. Patient.identifier:socialSecurityNumber
                                                Slice NamesocialSecurityNumber
                                                Definition

                                                An identifier for this patient.

                                                ShortAn identifier for this patient
                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..0
                                                TypeIdentifier
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Patients are almost always assigned specific numerical identifiers.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                85. Patient.identifier:bPK
                                                Slice NamebPK
                                                Definition

                                                An identifier for this patient.

                                                ShortAn identifier for this patient
                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..0
                                                TypeIdentifier
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Patients are almost always assigned specific numerical identifiers.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                112. Patient.identifier:localPatientId
                                                Slice NamelocalPatientId
                                                Definition

                                                An identifier for this patient.

                                                ShortAn identifier for this patient
                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                Control0..0
                                                TypeIdentifier
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Patients are almost always assigned specific numerical identifiers.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                133. Patient.active
                                                Definition

                                                Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.

                                                It is often used to filter patient lists to exclude inactive patients

                                                Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

                                                ShortWhether this patient's record is in active use
                                                Comments

                                                If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

                                                Control0..0
                                                Typeboolean
                                                Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Need to be able to mark a patient record as not to be used because it was created in error.

                                                Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                135. Patient.name
                                                Definition

                                                A name associated with the individual.

                                                ShortA name associated with the patient
                                                Comments

                                                A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

                                                Control1..1
                                                TypeHumanName
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summarytrue
                                                Requirements

                                                Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                137. Patient.name.id
                                                Definition

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

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                This element is affected by the following invariants: ele-1
                                                Typeid
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                139. Patient.name.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control1..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on Patient.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 141. Patient.name.extension:data-absent-reason
                                                  Slice Namedata-absent-reason
                                                  Definition

                                                  Provides a reason why the expected value or elements in the element that is extended are missing.

                                                  Shortunknown | asked | temp | notasked | masked | unsupported | astext | error
                                                  Control1..1
                                                  TypeExtension(Data Absent Reason) (Extension Type: code)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  143. Patient.name.extension:data-absent-reason.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  145. Patient.name.extension:data-absent-reason.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..0
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on Patient.name.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 147. Patient.name.extension:data-absent-reason.url
                                                    Definition

                                                    Source of the definition for the extension code - a logical name or a URL.

                                                    Shortidentifies the meaning of the extension
                                                    Comments

                                                    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                                                    Control1..1
                                                    Typeuri
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    Fixed Valuehttp://hl7.org/fhir/StructureDefinition/data-absent-reason
                                                    149. Patient.name.extension:data-absent-reason.value[x]
                                                    Definition

                                                    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                                                    ShortValue of extension
                                                    Control1..1
                                                    This element is affected by the following invariants: ext-1
                                                    BindingThe codes SHALL be taken from DataAbsentReason
                                                    (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
                                                    Typecode
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summaryfalse
                                                    Fixed Valuemasked
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    151. Patient.name.use
                                                    Definition

                                                    Identifies the purpose for this name.

                                                    Shortusual | official | temp | nickname | anonymous | old | maiden
                                                    Comments

                                                    Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                                    Control0..0
                                                    BindingThe codes SHALL be taken from NameUse
                                                    (required to http://hl7.org/fhir/ValueSet/name-use|5.0.0)

                                                    The use of a human name.

                                                    Typecode
                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    Allows the appropriate name for a particular context of use to be selected from among a set of names.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    153. Patient.name.text
                                                    Definition

                                                    Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.

                                                    ShortText representation of the full name
                                                    Comments

                                                    Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                    Control0..0
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

                                                    A renderable, unencoded form.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    155. Patient.name.family
                                                    Definition

                                                    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                                    ShortZuname des Patienten
                                                    Comments

                                                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                                    Control0..0
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supporttrue
                                                    Obligations
                                                      ObligationsActorSource
                                                      SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                      Summarytrue
                                                      Alternate Namessurname
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      157. Patient.name.given
                                                      Definition

                                                      Given name.

                                                      ShortVorname des Patienten
                                                      Comments

                                                      If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

                                                      Control0..0
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Obligations
                                                        ObligationsActorSource
                                                        SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                        Summarytrue
                                                        Alternate Namesfirst name, middle name
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        159. Patient.name.prefix
                                                        Definition

                                                        Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                                        ShortParts that come before the name
                                                        Control0..0
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        161. Patient.name.suffix
                                                        Definition

                                                        Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                                        ShortParts that come after the name
                                                        Control0..0
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        163. Patient.name.period
                                                        Definition

                                                        Indicates the period of time when this name was valid for the named person.

                                                        ShortTime period when name was/is in use
                                                        Control0..0
                                                        TypePeriod
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Requirements

                                                        Allows names to be placed in historical context.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        165. Patient.telecom
                                                        Definition

                                                        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

                                                        ShortA contact detail for the individual
                                                        Comments

                                                        A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

                                                        Control0..0
                                                        TypeContactPoint
                                                        Is Modifierfalse
                                                        Must Supportfalse
                                                        Summarytrue
                                                        Requirements

                                                        People have (primary) ways to contact them in some way such as phone, email.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        174. Patient.gender
                                                        Definition

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

                                                        ShortAdministratives Geschlecht des Patienten
                                                        Comments

                                                        The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.

                                                        Control1..1
                                                        BindingThe codes SHALL be taken from AdministrativeGender
                                                        (required to http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0)

                                                        The gender of a person used for administrative purposes.

                                                        Typecode
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Must Supporttrue
                                                        Obligations
                                                          ObligationsActorSource
                                                          SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                          Summarytrue
                                                          Requirements

                                                          Needed for identification of the individual, in combination with (at least) name and birth date.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          176. Patient.gender.id
                                                          Definition

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

                                                          Shortxml:id (or equivalent in JSON)
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          178. Patient.gender.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          SlicingThis element introduces a set of slices on Patient.gender.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 180. Patient.gender.extension:AdministrativeGenderAddition
                                                            Slice NameAdministrativeGenderAddition
                                                            Definition

                                                            HL7® Austria FHIR® Core Extension for the administrative gender of a person (Patient, Practitioner, ...). The extension is used to add the missing codes and is applied in case the code for administrative gender itself is set to 'other'.

                                                            ShortAdministrative Gender Addition
                                                            Control0..1
                                                            TypeExtension(Administrative Gender Addition) (Extension Type: Coding)
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            182. Patient.gender.value
                                                            Definition

                                                            Primitive value for code

                                                            ShortPrimitive value for code
                                                            Control0..1
                                                            Typecode
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            184. Patient.birthDate
                                                            Definition

                                                            The date of birth for the individual.

                                                            ShortGeburtsdatum des Patienten
                                                            Comments

                                                            Partial dates are allowed if the specific date of birth is unknown. There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).

                                                            Control0..0
                                                            Typedate
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActorSource
                                                              SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                              Summarytrue
                                                              Requirements

                                                              Age of the individual drives many clinical processes.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              190. Patient.deceased[x]
                                                              Definition

                                                              Indicates if the individual is deceased or not.

                                                              ShortIndicates if the individual is deceased or not
                                                              Comments

                                                              If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                              Control0..0
                                                              Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Requirements

                                                              The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                              • type @ $this
                                                              • 192. Patient.deceased[x]:deceasedBoolean
                                                                Slice NamedeceasedBoolean
                                                                Definition

                                                                Indicates if the individual is deceased or not.

                                                                ShortIndicates if the individual is deceased or not
                                                                Comments

                                                                If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                Control0..0
                                                                Typeboolean
                                                                Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Requirements

                                                                The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                194. Patient.deceased[x]:deceasedDateTime
                                                                Slice NamedeceasedDateTime
                                                                Definition

                                                                Indicates if the individual is deceased or not.

                                                                ShortIndicates if the individual is deceased or not
                                                                Comments

                                                                If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

                                                                Control0..0
                                                                TypedateTime
                                                                Is Modifiertrue because This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Requirements

                                                                The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                196. Patient.address
                                                                Definition

                                                                An address for the individual.

                                                                ShortAn address for the individual
                                                                Comments

                                                                Patient may have multiple addresses with different uses or applicable periods.

                                                                Control1..1
                                                                TypeAddress(HL7® AT Core Address Profile)
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Summarytrue
                                                                Requirements

                                                                May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                198. Patient.address.id
                                                                Definition

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typeid
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                200. Patient.address.extension
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..1
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on Patient.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 202. Patient.address.extension:municipalityCode
                                                                  Slice NamemunicipalityCode
                                                                  Definition

                                                                  HL7® Austria FHIR® Core Extension for the municipality code part of the Austrian address

                                                                  ShortWohnsitz – Gemeindecode
                                                                  Control0..1
                                                                  TypeExtension(Address Municipality Code) (Extension Type: string)
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Obligations
                                                                    ObligationsActorSource
                                                                    SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    204. Patient.address.use
                                                                    Definition

                                                                    The purpose of this address.

                                                                    Shorthome | work | temp | old | billing - purpose of this address
                                                                    Comments

                                                                    Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                                                    Control0..0
                                                                    BindingThe codes SHALL be taken from AddressUse
                                                                    (required to http://hl7.org/fhir/ValueSet/address-use|5.0.0)

                                                                    The use of an address (home / work / etc.).

                                                                    Typecode
                                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Requirements

                                                                    Allows an appropriate address to be chosen from a list of many.

                                                                    ExampleGeneral: home
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    206. Patient.address.type
                                                                    Definition

                                                                    Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                                                    Shortpostal | physical | both
                                                                    Comments

                                                                    The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

                                                                    Control0..0
                                                                    BindingThe codes SHALL be taken from AddressType
                                                                    (required to http://hl7.org/fhir/ValueSet/address-type|5.0.0)

                                                                    The type of an address (physical / postal).

                                                                    Typecode
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    ExampleGeneral: both
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    208. Patient.address.text
                                                                    Definition

                                                                    Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.

                                                                    ShortText representation of the address
                                                                    Comments

                                                                    Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

                                                                    Control0..0
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Requirements

                                                                    A renderable, unencoded form.

                                                                    ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    210. Patient.address.line
                                                                    Definition

                                                                    This component contains the street name, street number, floor and/or door number or additonal information (e.g. street direction, P.O. Box number, delivery hints, and similar address information). This information can be split into structured values in the line-components each defined by international ISO extensions. If these extensions are used then the information they contain has to be written in a concatenated way in the line element itself as well. This makes the usage easier for systems which don't use address data in a structured way.

                                                                    ShortStreet name, number, direction & P.O. Box etc.
                                                                    Control0..*
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    ExampleGeneral: 137 Nowhere Street
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    212. Patient.address.line.id
                                                                    Definition

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

                                                                    Shortxml:id (or equivalent in JSON)
                                                                    Control0..1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    214. Patient.address.line.extension
                                                                    Definition

                                                                    An Extension

                                                                    ShortExtension
                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    SlicingThis element introduces a set of slices on Patient.address.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 216. Patient.address.line.extension:street
                                                                      Slice Namestreet
                                                                      Definition

                                                                      streetName.

                                                                      ShortstreetName
                                                                      Control0..0
                                                                      TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                      Is Modifierfalse
                                                                      Must Supporttrue
                                                                      Obligations
                                                                        ObligationsActorSource
                                                                        SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        218. Patient.address.line.extension:streetNumber
                                                                        Slice NamestreetNumber
                                                                        Definition

                                                                        Number of the street without the street name

                                                                        ShortNumber of the street
                                                                        Control0..1
                                                                        TypeExtension(ADXP House Number) (Extension Type: string)
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        220. Patient.address.line.extension:floorDoorNumber
                                                                        Slice NamefloorDoorNumber
                                                                        Definition

                                                                        Floor and/or door number

                                                                        ShortFloor and/or door number
                                                                        Control0..1
                                                                        TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        222. Patient.address.line.extension:additionalInformation
                                                                        Slice NameadditionalInformation
                                                                        Definition

                                                                        Additional information about the street address

                                                                        ShortAdditional Information
                                                                        Control0..1
                                                                        TypeExtension(Address Additional Information) (Extension Type: string)
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        224. Patient.address.line.value
                                                                        Definition

                                                                        The actual value

                                                                        ShortPrimitive value for string
                                                                        Control0..1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        Max Length:1048576
                                                                        226. Patient.address.city
                                                                        Definition

                                                                        The name of the city, town, suburb, village or other community or delivery center.

                                                                        ShortWohnort
                                                                        Control0..0
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Must Supporttrue
                                                                        Obligations
                                                                          ObligationsActorSource
                                                                          SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                                          Summarytrue
                                                                          Alternate NamesMunicpality
                                                                          ExampleGeneral: Erewhon
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          228. Patient.address.district
                                                                          Definition

                                                                          The name of the administrative area (county).

                                                                          ShortDistrict name (aka county)
                                                                          Comments

                                                                          District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                                                          Control0..0
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Alternate NamesCounty
                                                                          ExampleGeneral: Madison
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          230. Patient.address.state
                                                                          Definition

                                                                          Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

                                                                          ShortSub-unit of country (abbreviations ok)
                                                                          Control0..0
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Alternate NamesProvince, Territory
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          232. Patient.address.postalCode
                                                                          Definition

                                                                          A postal code designating a region defined by the postal service.

                                                                          ShortWohnsitz – Postleitzahl
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Must Supporttrue
                                                                          Obligations
                                                                            ObligationsActorSource
                                                                            SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                                            Summarytrue
                                                                            Alternate NamesZip
                                                                            ExampleGeneral: 9132
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            234. Patient.address.country
                                                                            Definition

                                                                            Country - a nation as commonly understood or generally accepted.

                                                                            ShortWohnsitz – Staat
                                                                            Comments

                                                                            ISO 3166 2- or 3- letter codes MAY be used in place of a human readable country name.

                                                                            Control1..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                            Must Supporttrue
                                                                            Obligations
                                                                              ObligationsActorSource
                                                                              SHALL:populateMoped KA Actorfrom MOPED Basis Patient mit Klarname
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              236. Patient.address.period
                                                                              Definition

                                                                              Time period when address was/is in use.

                                                                              ShortTime period when address was/is in use
                                                                              Control0..0
                                                                              TypePeriod
                                                                              Is Modifierfalse
                                                                              Summarytrue
                                                                              Requirements

                                                                              Allows addresses to be placed in historical context.

                                                                              ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              238. Patient.maritalStatus
                                                                              Definition

                                                                              This field contains a patient's most recent marital (civil) status.

                                                                              ShortMarital (civil) status of a patient
                                                                              Control0..0
                                                                              BindingUnless not suitable, these codes SHALL be taken from MaritalStatusCodes
                                                                              (extensible to http://hl7.org/fhir/ValueSet/marital-status|5.0.0)

                                                                              The domestic partnership status of a person.

                                                                              TypeCodeableConcept
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              Most, if not all systems capture it.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              251. Patient.multipleBirth[x]
                                                                              Definition

                                                                              Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                              ShortWhether patient is part of a multiple birth
                                                                              Comments

                                                                              Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                              Control0..0
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

                                                                              For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              SlicingThis element introduces a set of slices on Patient.multipleBirth[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                                                                              • type @ $this
                                                                              • 253. Patient.multipleBirth[x]:multipleBirthBoolean
                                                                                Slice NamemultipleBirthBoolean
                                                                                Definition

                                                                                Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                ShortWhether patient is part of a multiple birth
                                                                                Comments

                                                                                Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                Control0..0
                                                                                Typeboolean
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                255. Patient.multipleBirth[x]:multipleBirthInteger
                                                                                Slice NamemultipleBirthInteger
                                                                                Definition

                                                                                Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).

                                                                                ShortWhether patient is part of a multiple birth
                                                                                Comments

                                                                                Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).

                                                                                Control0..0
                                                                                Typeinteger
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                257. Patient.photo
                                                                                Definition

                                                                                Image of the patient.

                                                                                ShortImage of the patient
                                                                                Comments

                                                                                Guidelines:

                                                                                • Use id photos, not clinical photos.
                                                                                • Limit dimensions to thumbnail.
                                                                                • Keep byte count low to ease resource updates.
                                                                                Control0..0
                                                                                TypeAttachment
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                259. Patient.contact
                                                                                Definition

                                                                                A contact party (e.g. guardian, partner, friend) for the patient.

                                                                                ShortA contact party (e.g. guardian, partner, friend) for the patient
                                                                                Comments

                                                                                Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

                                                                                Control0..0
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                Need to track people you can contact about the patient.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                pat-1: SHALL at least contain a contact's details or a reference to an organization (name.exists() or telecom.exists() or address.exists() or organization.exists())
                                                                                322. Patient.communication
                                                                                Definition

                                                                                A language which may be used to communicate with the patient about his or her health.

                                                                                ShortA language which may be used to communicate with the patient about his or her health
                                                                                Comments

                                                                                If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

                                                                                Control0..0
                                                                                TypeBackboneElement
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

                                                                                If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                329. Patient.generalPractitioner
                                                                                Definition

                                                                                Patient's nominated care provider.

                                                                                ShortPatient's nominated primary care provider
                                                                                Comments

                                                                                This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues.

                                                                                Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.

                                                                                Control0..0
                                                                                TypeReference(Organization, Practitioner, PractitionerRole)
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Alternate NamescareProvider
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                331. Patient.managingOrganization
                                                                                Definition

                                                                                Organization that is the custodian of the patient record.

                                                                                ShortOrganization that is the custodian of the patient record
                                                                                Comments

                                                                                There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

                                                                                Control0..0
                                                                                TypeReference(Organization)
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summarytrue
                                                                                Requirements

                                                                                Need to know who recognizes this patient record, manages and updates it.

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                333. Patient.link
                                                                                Definition

                                                                                Link to a Patient or RelatedPerson resource that concerns the same actual individual.

                                                                                ShortLink to a Patient or RelatedPerson resource that concerns the same actual individual
                                                                                Comments

                                                                                There is no assumption that linked patient records have mutual links.

                                                                                Control0..0
                                                                                TypeBackboneElement
                                                                                Is Modifiertrue because This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'
                                                                                Must Supportfalse
                                                                                Summarytrue
                                                                                Requirements

                                                                                There are multiple use cases:

                                                                                • Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and
                                                                                • Distribution of patient information across multiple servers.
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))