MII Implementierungsleitfaden Kerndatensatz Basis
2027.0.0-ballot - Germany

This page is part of the MII Implementation Guide Core Dataset Base (v2027.0.0-ballot: 2027 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Ressourcenprofil: MII PR Person Patient - Detaillierte Beschreibungen

Active Stand: 2026-09-01

Definitionen für das mii-pr-person-patient ressourcenprofil

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
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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-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())
mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden (gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').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

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

Control0..1
Typeidstring
Is Modifierfalse
Must Supporttrue
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 Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Patient.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.


A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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 it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
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()))
10. 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 manageable, 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..*
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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. 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.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Patient Birth Place) (Extension Type: Address)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Patient.extension:birthPlace.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 manageable, 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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 16. Patient.extension:birthPlace.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
      Must Supporttrue
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace
      18. Patient.extension:birthPlace.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
      TypeAddress, date, Meta, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Patient.extension:birthPlace.value[x].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..1
      BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

      The use of an address.

      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()))
      22. Patient.extension:birthPlace.value[x].country
      Definition

      Country - a nation as commonly understood or generally accepted.

      ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
      Comments

      ISO 3166 3 letter codes can be used in place of a human readable country name.

      Control0..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Patient.extension:birthPlace.value[x].country.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 manageable, 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..*
      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())
      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.value[x].country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 26. Patient.extension:birthPlace.value[x].country.extension:countryCode
        Slice NamecountryCode
        Definition

        Provides a coded expression for the content represented in a string.

        Shortcode for string
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Coded string) (Extension Type: Coding)
        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())
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. Patient.extension:birthPlace.value[x].country.extension:countryCode.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 manageable, 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.value[x].country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 30. Patient.extension:birthPlace.value[x].country.extension:countryCode.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/iso21090-codedString
          32. Patient.extension:birthPlace.value[x].country.extension:countryCode.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
          BindingThe codes SHOULD be taken from For codes, see Iso3166-1-2
          (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2)
          TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          34. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].system
          Definition

          The identification of the code system that defines the meaning of the symbol in the code.

          ShortIdentity of the terminology system
          Comments

          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

          Control0..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to be unambiguous about the source of the definition of the symbol.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].code
          Definition

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          ShortSymbol in syntax defined by the system
          Control0..1
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to refer to a particular code in the system.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. Patient.extension:patient-citizenship
          Slice Namepatient-citizenship
          Definition

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

          Control0..*
          This element is affected by the following invariants: ele-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())
          40. Patient.extension:patient-citizenship.extension:code
          Slice Namecode
          Definition

          An Extension

          ShortExtensionAdditional content defined by implementations
          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())
          42. Patient.extension:patient-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 manageable, 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
          • 44. Patient.extension:patient-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
            Must Supporttrue
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuecode
            46. Patient.extension:patient-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).

            ShortValue of extension
            Control10..1
            BindingThe codes SHOULD be taken from For codes, see CountryValueSet
            (preferred to http://hl7.org/fhir/ValueSet/country)
            TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. Patient.extension:patient-citizenship.extension:code.value[x].coding
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control0..*
            TypeCoding
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. Patient.extension:patient-citizenship.extension:code.value[x].coding.system
            Definition

            The identification of the code system that defines the meaning of the symbol in the code.

            ShortIdentity of the terminology system
            Comments

            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to be unambiguous about the source of the definition of the symbol.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Patient.extension:patient-citizenship.extension:code.value[x].coding.code
            Definition

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

            ShortSymbol in syntax defined by the system
            Control0..1
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to refer to a particular code in the system.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. Patient.extension:patient-citizenship.extension:period
            Slice Nameperiod
            Definition

            An Extension

            ShortExtensionAdditional content defined by implementations
            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())
            56. Patient.extension:patient-citizenship.extension:period.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 manageable, 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
            • 58. Patient.extension:patient-citizenship.extension:period.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
              Must Supporttrue
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valueperiod
              60. Patient.extension:patient-citizenship.extension:period.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
              TypePeriod, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              62. Patient.extension:patient-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
              Must Supporttrue
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-citizenship
              64. Patient.extension:patient-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
              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
              66. Patient.extension:patient-nationality
              Slice Namepatient-nationality
              Definition

              The nationality of the patient.

              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension(Patient Nationality) (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())
              68. Patient.extension:patient-nationality.extension:code
              Slice Namecode
              Definition

              An Extension

              ShortExtensionAdditional content defined by implementations
              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())
              70. Patient.extension:patient-nationality.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 manageable, 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
              • 72. Patient.extension:patient-nationality.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
                Must Supporttrue
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuecode
                74. Patient.extension:patient-nationality.extension:code.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
                TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                76. Patient.extension:patient-nationality.extension:code.value[x].coding
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                Control0..*
                TypeCoding
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Allows for alternative encodings within a code system, and translations to other code systems.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                78. Patient.extension:patient-nationality.extension:code.value[x].coding.system
                Definition

                The identification of the code system that defines the meaning of the symbol in the code.

                ShortIdentity of the terminology system
                Comments

                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                Control0..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Need to be unambiguous about the source of the definition of the symbol.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                80. Patient.extension:patient-nationality.extension:code.value[x].coding.code
                Definition

                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                ShortSymbol in syntax defined by the system
                Control0..1
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Need to refer to a particular code in the system.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                82. Patient.extension:patient-nationality.extension:period
                Slice Nameperiod
                Definition

                An Extension

                ShortExtensionAdditional content defined by implementations
                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())
                84. Patient.extension:patient-nationality.extension:period.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 manageable, 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
                • 86. Patient.extension:patient-nationality.extension:period.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
                  Must Supporttrue
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valueperiod
                  88. Patient.extension:patient-nationality.extension:period.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
                  TypePeriod, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Must Supporttrue
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  90. Patient.extension:patient-nationality.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
                  Must Supporttrue
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-nationality
                  92. Patient.extension:patient-nationality.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
                  TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                  94. Patient.extension:recordedSexOrGender
                  Slice NamerecordedSexOrGender
                  Definition

                  A sex or gender property for the individual from a document or other record

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension(Person Recorded Sex Or Gender) (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())
                  96. Patient.extension:recordedSexOrGender.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 manageable, 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.

                  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.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 98. Patient.extension:recordedSexOrGender.extension:value
                    Slice Namevalue
                    Definition

                    An Extension

                    ShortExtensionAdditional content defined by implementations
                    Control10..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())
                    100. Patient.extension:recordedSexOrGender.extension:value.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 manageable, 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
                    • 102. Patient.extension:recordedSexOrGender.extension:value.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
                      Must Supporttrue
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valuevalue
                      104. Patient.extension:recordedSexOrGender.extension:value.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
                      BindingThe codes SHOULD be taken from For codes, see MII VS Person Recorded Sex or Gender SNOMED
                      (preferred to https://www.medizininformatik-initiative.de/fhir/modul-person/ValueSet/mii-vs-person-recordedsexorgender-snomed)
                      TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Must Supporttrue
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      106. Patient.extension:recordedSexOrGender.extension:value.value[x].coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                      Control0..*
                      TypeCoding
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Allows for alternative encodings within a code system, and translations to other code systems.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      108. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortIdentity of the terminology system
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      110. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control0..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. Patient.extension:recordedSexOrGender.extension:type
                      Slice Nametype
                      Definition

                      An Extension

                      ShortExtensionAdditional content defined by implementations
                      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())
                      114. Patient.extension:recordedSexOrGender.extension:type.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 manageable, 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
                      • 116. Patient.extension:recordedSexOrGender.extension:type.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
                        Must Supporttrue
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed Valuetype
                        118. Patient.extension:recordedSexOrGender.extension:type.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
                        BindingFor example codes, see For codes, see Recorded Sex Or Gender Type
                        (example to http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type)
                        TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        120. Patient.extension:recordedSexOrGender.extension:type.value[x].coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control0..*
                        TypeCoding
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        122. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.system
                        Definition

                        The identification of the code system that defines the meaning of the symbol in the code.

                        ShortIdentity of the terminology system
                        Comments

                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to be unambiguous about the source of the definition of the symbol.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.code
                        Definition

                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                        ShortSymbol in syntax defined by the system
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. Patient.extension:recordedSexOrGender.extension:effectivePeriod
                        Slice NameeffectivePeriod
                        Definition

                        The time period during which the recorded sex or gender value applies to the individual

                        ShortWhen the recorded sex or gender value appliesAdditional 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())
                        128. Patient.extension:recordedSexOrGender.extension:effectivePeriod.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 manageable, 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
                        • 130. Patient.extension:recordedSexOrGender.extension:effectivePeriod.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 ValueeffectivePeriod
                          132. Patient.extension:recordedSexOrGender.extension:acquisitionDate
                          Slice NameacquisitionDate
                          Definition

                          An Extension

                          ShortExtensionAdditional content defined by implementations
                          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())
                          134. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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 manageable, 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
                          • 136. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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
                            Must Supporttrue
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed ValueacquisitionDate
                            138. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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
                            TypedateTime, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                            Must Supporttrue
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            140. Patient.extension:recordedSexOrGender.extension:source
                            Slice Namesource
                            Definition

                            A reference to the source of the Recorded Sex or Gender value.

                            ShortThe source of the Recorded Sex or Gender value.Additional content defined by implementations
                            Comments

                            Unlike the sourceDocument element, this element can reference non-document sources including applications, organisations or individuals. For example, if the Recored Sex or Gender value is recorded in a national patient identifier system this element may reference that system. This element can also be the source of the document referred to in the sourceDocument element. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.

                            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())
                            142. Patient.extension:recordedSexOrGender.extension:source.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 manageable, 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
                            • 144. Patient.extension:recordedSexOrGender.extension:source.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 Valuesource
                              146. Patient.extension:recordedSexOrGender.extension:source.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
                              TypeChoice of: CodeableConcept, Reference(Organization, Device, RelatedPerson, Practitioner), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              148. Patient.extension:recordedSexOrGender.extension:sourceDocument
                              Slice NamesourceDocument
                              Definition

                              The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.

                              ShortThe document the sex or gender property was acquired from.Additional content defined by implementations
                              Comments

                              For example, if a driver's license is scanned, this property may reference that scanned document. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.

                              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())
                              150. Patient.extension:recordedSexOrGender.extension:sourceDocument.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 manageable, 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
                              • 152. Patient.extension:recordedSexOrGender.extension:sourceDocument.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 ValuesourceDocument
                                154. Patient.extension:recordedSexOrGender.extension:sourceDocument.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
                                TypeChoice of: CodeableConcept, Reference(DocumentReference), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                156. Patient.extension:recordedSexOrGender.extension:sourceField
                                Slice NamesourceField
                                Definition

                                The name of the field within the source document where this sex or gender property is initially recorded.

                                ShortThe name of the field within the source document where this sex or gender property is initially recorded.Additional content defined by implementations
                                Comments

                                For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided. If the semantics of the field are known, they may be described in the comment. For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.

                                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())
                                158. Patient.extension:recordedSexOrGender.extension:sourceField.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 manageable, 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
                                • 160. Patient.extension:recordedSexOrGender.extension:sourceField.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 ValuesourceField
                                  162. Patient.extension:recordedSexOrGender.extension:sourceField.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
                                  Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  164. Patient.extension:recordedSexOrGender.extension:jurisdiction
                                  Slice Namejurisdiction
                                  Definition

                                  Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired.

                                  ShortWho issued the document where the sex or gender was aquiredAdditional content defined by implementations
                                  Comments

                                  For example, a individual's driver's license or passport would be issued by a specific state or country.

                                  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())
                                  166. Patient.extension:recordedSexOrGender.extension:jurisdiction.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 manageable, 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
                                  • 168. Patient.extension:recordedSexOrGender.extension:jurisdiction.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 Valuejurisdiction
                                    170. Patient.extension:recordedSexOrGender.extension:jurisdiction.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
                                    BindingUnless not suitable, these codes SHALL be taken from For codes, see Jurisdiction ValueSet
                                    (extensible to http://terminology.hl7.org/ValueSet/jurisdiction)
                                    TypeCodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    172. Patient.extension:recordedSexOrGender.extension:comment
                                    Slice Namecomment
                                    Definition

                                    Further explanation about the context or source of the recorded sex or gender value

                                    ShortContext or source information about the recorded sex or genderAdditional 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())
                                    174. Patient.extension:recordedSexOrGender.extension:comment.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 manageable, 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
                                    • 176. Patient.extension:recordedSexOrGender.extension:comment.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 Valuecomment
                                      178. Patient.extension:recordedSexOrGender.extension:comment.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
                                      Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, 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
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      180. Patient.extension:recordedSexOrGender.extension:genderElementQualifier
                                      Slice NamegenderElementQualifier
                                      Definition

                                      Instances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context.

                                      ShortWhether this recorded sex or gender value qualifies the .gender element.Additional 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())
                                      182. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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 manageable, 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
                                      • 184. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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 ValuegenderElementQualifier
                                        186. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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
                                        Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, 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
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        188. Patient.extension:recordedSexOrGender.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
                                        Must Supporttrue
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
                                        190. Patient.extension:recordedSexOrGender.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
                                        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                                        192. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                        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
                                        Summaryfalse
                                        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())
                                        194. Patient.identifier
                                        Definition

                                        Ein Identifikator für den/die Patient*in


                                        An identifier for this patient.

                                        ShortPatienten-IdentifikatorAn identifier for this patient
                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..*
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Must Supporttrue
                                        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:
                                        • pattern @ $this
                                        • 196. Patient.identifier:versichertenId
                                          Slice NameversichertenId
                                          Definition

                                          Krankenversichertennummer, unabhängig, ob GKV, PKV oder Sonderkostenträger


                                          An identifier for this patient.

                                          ShortKrankenversichertennummerAn identifier for this patient
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1*
                                          TypeIdentifier(Identifier-Profil für die 10-stellige Krankenversichertennummer)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "type" : {
                                              "coding" : [{
                                                "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis",
                                                "code" : "KVZ10"
                                              }]
                                            }
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          198. Patient.identifier:versichertenId.use
                                          Definition

                                          The purpose of this identifier.

                                          Shortusual | official | temp | secondary | old (If known)
                                          Comments

                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                          Identifies the purpose for this identifier, if known .

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

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

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          200. Patient.identifier:versichertenId.type
                                          Definition

                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                          ShortDescription of identifier
                                          Comments

                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Identifier Type Kvid DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
                                          (required to http://fhir.de/ValueSet/identifier-type-kvid-de-basis)

                                          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows users to make use of identifiers when the identifier system is not known.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          kvid-2: Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden (($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not())
                                          202. Patient.identifier:versichertenId.type.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          204. Patient.identifier:versichertenId.type.coding.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control0..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          206. Patient.identifier:versichertenId.type.coding.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control0..1
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          208. Patient.identifier:versichertenId.system
                                          Definition

                                          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                          ShortThe namespace for the identifier value
                                          Comments

                                          Identifier.system is always case sensitive.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                          Fixed Valuehttp://fhir.de/sid/gkv/kvid-10
                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          210. Patient.identifier:versichertenId.value
                                          Definition

                                          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                          ShortThe value that is unique
                                          Comments

                                          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          ExampleGeneral: 123456
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen (matches('^[A-Z][0-9]{9}$'))
                                          212. Patient.identifier:versichertenId.assigner
                                          Definition

                                          Organization that issued/manages the identifier.

                                          ShortOrganization that issued id (may be just text)
                                          Comments

                                          The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          TypeReference(Organization, Organization)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ref-1: SHALL have a contained resource if a local reference is provided (reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)))
                                          214. Patient.identifier:versichertenId.assigner.identifier
                                          Definition

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

                                          ShortLogical reference, when literal reference is not known
                                          Comments

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

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

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

                                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control10..1
                                          TypeIdentifier(Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR))
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          216. Patient.identifier:versichertenId.assigner.identifier.use
                                          Definition

                                          The purpose of this identifier.

                                          Shortusual | official | temp | secondary | old (If known)
                                          Comments

                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                          Identifies the purpose for this identifier, if known .

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

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

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          218. Patient.identifier:versichertenId.assigner.identifier.type
                                          Definition

                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                          ShortDescription of identifier
                                          Comments

                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          BindingUnless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
                                          (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

                                          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows users to make use of identifiers when the identifier system is not known.

                                          Pattern Value{
                                            "coding" : [{
                                              "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                              "code" : "XX"
                                            }]
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          220. Patient.identifier:versichertenId.assigner.identifier.type.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          222. Patient.identifier:versichertenId.assigner.identifier.type.coding.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control0..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          224. Patient.identifier:versichertenId.assigner.identifier.type.coding.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control0..1
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          226. Patient.identifier:versichertenId.assigner.identifier.system
                                          Definition

                                          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                          ShortThe namespace for the identifier value
                                          Comments

                                          Identifier.system is always case sensitive.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                          Fixed Valuehttp://fhir.de/sid/arge-ik/iknr
                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          228. Patient.identifier:versichertenId.assigner.identifier.value
                                          Definition

                                          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                          ShortThe value that is unique
                                          Comments

                                          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          ExampleGeneral: 123456
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ik-1: Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein (matches('^[0-9]{9}$'))
                                          230. Patient.identifier:pid
                                          Slice Namepid
                                          Definition

                                          Patientenidentifikator innerhalb einer Organisation


                                          An identifier for this patient.

                                          ShortPatientenidentifikationAn identifier for this patient
                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..*
                                          TypeIdentifier(Identifier-Profil für die Abbildung einer Patienten-ID)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Patients are almost always assigned specific numerical identifiers.

                                          Pattern Value{
                                            "type" : {
                                              "coding" : [{
                                                "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                "code" : "MR"
                                              }]
                                            }
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          232. Patient.identifier:pid.use
                                          Definition

                                          The purpose of this identifier.

                                          Shortusual | official | temp | secondary | old (If known)
                                          Comments

                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                          Identifies the purpose for this identifier, if known .

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

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

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          234. Patient.identifier:pid.type
                                          Definition

                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                          ShortDescription of identifier
                                          Comments

                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          BindingUnless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSethttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
                                          (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

                                          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows users to make use of identifiers when the identifier system is not known.

                                          Pattern Value{
                                            "coding" : [{
                                              "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                              "code" : "MR"
                                            }]
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          236. Patient.identifier:pid.type.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          238. Patient.identifier:pid.type.coding.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control0..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          240. Patient.identifier:pid.type.coding.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control0..1
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          242. Patient.identifier:pid.system
                                          Definition

                                          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                          ShortThe namespace for the identifier value
                                          Comments

                                          Identifier.system is always case sensitive.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          244. Patient.identifier:pid.value
                                          Definition

                                          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                          ShortThe value that is unique
                                          Comments

                                          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                          Control10..1
                                          This element is affected by the following invariants: ele-1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          ExampleGeneral: 123456
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          246. Patient.identifier:pid.assigner
                                          Definition

                                          Organization that issued/manages the identifier.

                                          ShortOrganization that issued id (may be just text)
                                          Comments

                                          The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                          Control0..1
                                          This element is affected by the following invariants: ele-1
                                          TypeReference(Organization, Organization)
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ref-1: SHALL have a contained resource if a local reference is provided (reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)))
                                          248. Patient.identifier:pid.assigner.identifier
                                          Definition

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

                                          ShortLogical reference, when literal reference is not known
                                          Comments

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

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

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

                                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          TypeIdentifier
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          250. Patient.identifier:pid.assigner.identifier.use
                                          Definition

                                          The purpose of this identifier.

                                          Shortusual | official | temp | secondary | old (If known)
                                          Comments

                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                          Control0..1
                                          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                          Identifies the purpose for this identifier, if known .

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

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

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          252. Patient.identifier:pid.assigner.identifier.type
                                          Definition

                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                          ShortDescription of identifier
                                          Comments

                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                          Control0..1
                                          BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
                                          (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                                          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows users to make use of identifiers when the identifier system is not known.

                                          Pattern Value{
                                            "coding" : [{
                                              "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                              "code" : "XX"
                                            }]
                                          }
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          254. Patient.identifier:pid.assigner.identifier.type.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..*
                                          TypeCoding
                                          Is Modifierfalse
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          256. Patient.identifier:pid.assigner.identifier.type.coding.system
                                          Definition

                                          The identification of the code system that defines the meaning of the symbol in the code.

                                          ShortIdentity of the terminology system
                                          Comments

                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                          Control0..1
                                          Typeuri
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to be unambiguous about the source of the definition of the symbol.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          258. Patient.identifier:pid.assigner.identifier.type.coding.code
                                          Definition

                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                          ShortSymbol in syntax defined by the system
                                          Control0..1
                                          Typecode
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Must Supporttrue
                                          Summarytrue
                                          Requirements

                                          Need to refer to a particular code in the system.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          260. Patient.identifier:pid.assigner.identifier.system
                                          Definition

                                          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                          ShortThe namespace for the identifier value
                                          Comments

                                          Identifier.system is always case sensitive.

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

                                          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                          ExampleGeneral: http://www.acme.com/identifiers/patient
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          mii-pat-2: Entweder IKNR oder MII Core Location Identifier muss verwendet werden ($this = 'http://fhir.de/sid/arge-ik/iknr' or $this = 'https://www.medizininformatik-initiative.de/fhir/core/CodeSystem/core-location-identifier')
                                          262. 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..1
                                          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
                                          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()))
                                          264. Patient.name
                                          Definition

                                          Name der Patientin oder des Patienten


                                          A name associated with the individual.

                                          ShortNameA 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.

                                          Control0..*
                                          TypeHumanName
                                          Is Modifierfalse
                                          Must Supporttrue
                                          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()))
                                          SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • pattern @ $this
                                          • 266. Patient.name:name
                                            Slice Namename
                                            Definition

                                            Personenname mit in Deutschland üblichen Namensbestandteilen


                                            A name associated with the individual.

                                            ShortPersonennameA 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.

                                            Control0..1*
                                            TypeHumanName(HumanName, deutsches Basisprofil)
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

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

                                            Pattern Value{
                                              "use" : "official"
                                            }
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            268. Patient.name: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.

                                            Control10..1
                                            This element is affected by the following invariants: ele-1
                                            BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                                            (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                            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
                                            Must Supporttrue
                                            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()))
                                            270. Patient.name:name.family
                                            Definition

                                            Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.


                                            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.

                                            ShortFamiliennameFamily name (often called 'Surname')
                                            Comments

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

                                            Control10..1
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Alternate Namessurname
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            272. Patient.name:name.family.extension:namenszusatz
                                            Slice Namenamenszusatz
                                            Definition

                                            Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

                                            ShortNamenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
                                            Comments

                                            Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            274. Patient.name:name.family.extension:nachname
                                            Slice Namenachname
                                            Definition

                                            The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                            ShortPortion derived from person's own surname
                                            Comments

                                            If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Own Name) (Extension Type: string)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            276. Patient.name:name.family.extension:vorsatzwort
                                            Slice Namevorsatzwort
                                            Definition

                                            The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                            ShortVoorvoegsel derived from person's own surname
                                            Comments

                                            An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Own Prefix) (Extension Type: string)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            278. Patient.name:name.given
                                            Definition

                                            Vorname der Person


                                            Given name.

                                            ShortVornameGiven 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.

                                            Control10..*
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Alternate Namesfirst name, middle name
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            280. Patient.name:name.prefix
                                            Definition

                                            Namensteile vor dem Vornamen, z.B. akademischer Titel.


                                            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.

                                            ShortNamensteile vor dem VornamenParts that come before the name
                                            Comments

                                            Note that FHIR strings SHALL NOT exceed 1MB in size

                                            Control0..*
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            282. Patient.name:name.prefix.extension:prefix-qualifier
                                            Slice Nameprefix-qualifier
                                            Definition

                                            A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

                                            ShortLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
                                            Comments

                                            Used to indicate additional information about the name part and how it should be used.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(EN Qualifier) (Extension Type: code)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            284. Patient.name:geburtsname
                                            Slice Namegeburtsname
                                            Definition

                                            Name, der vor einer Namensänderung aufgrund von Heirat verwendet wurde


                                            A name associated with the individual.

                                            ShortGeburtsnameA 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.

                                            Control0..1*
                                            TypeHumanName(HumanName, deutsches Basisprofil)
                                            Is Modifierfalse
                                            Must Supporttrue
                                            Summarytrue
                                            Requirements

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

                                            Pattern Value{
                                              "use" : "maiden"
                                            }
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            286. Patient.name:geburtsname.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.

                                            Control10..1
                                            This element is affected by the following invariants: ele-1
                                            BindingThe codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1
                                            (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                            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
                                            Must Supporttrue
                                            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()))
                                            288. Patient.name:geburtsname.family
                                            Definition

                                            Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.


                                            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.

                                            ShortFamiliennameFamily name (often called 'Surname')
                                            Comments

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

                                            Control10..1
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Must Supporttrue
                                            Summarytrue
                                            Alternate Namessurname
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            290. Patient.name:geburtsname.family.extension:namenszusatz
                                            Slice Namenamenszusatz
                                            Definition

                                            Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

                                            ShortNamenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
                                            Comments

                                            Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            292. Patient.name:geburtsname.family.extension:nachname
                                            Slice Namenachname
                                            Definition

                                            The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                            ShortPortion derived from person's own surname
                                            Comments

                                            If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Own Name) (Extension Type: string)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            294. Patient.name:geburtsname.family.extension:vorsatzwort
                                            Slice Namevorsatzwort
                                            Definition

                                            The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                            ShortVoorvoegsel derived from person's own surname
                                            Comments

                                            An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.

                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            TypeExtension(Own Prefix) (Extension Type: string)
                                            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())
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            296. Patient.name:geburtsname.given
                                            Definition

                                            Vorname der Person


                                            Given name.

                                            ShortVornameGiven 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*
                                            This element is affected by the following invariants: ele-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Alternate Namesfirst name, middle name
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            298. Patient.name:geburtsname.prefix
                                            Definition

                                            Namensteile vor dem Vornamen, z.B. akademischer Titel.


                                            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.

                                            ShortNamensteile vor dem VornamenParts that come before the name
                                            Comments

                                            Note that FHIR strings SHALL NOT exceed 1MB in size

                                            Control0..0*
                                            This element is affected by the following invariants: ele-1
                                            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()))
                                            301. Patient.gender
                                            Definition

                                            männlich | weiblich | andere | unbekannt | unbestimmt | divers


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

                                            ShortAdministratives Geschlechtmale | 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.

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

                                            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
                                            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()))
                                            303. Patient.gender.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 manageable, 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..*
                                            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())
                                            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
                                            • 305. Patient.gender.extension:other-amtlich
                                              Slice Nameother-amtlich
                                              Definition

                                              Extension zur genaueren Differenzierung des administrativen Geschlechts

                                              ShortExtension Administratives Geschlecht
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding)
                                              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())
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              307. Patient.gender.extension:other-amtlich.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 manageable, 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..0*
                                              This element is affected by the following invariants: ele-1
                                              TypeExtension
                                              Is Modifierfalse
                                              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())
                                              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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 309. Patient.gender.extension:other-amtlich.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
                                                Must Supporttrue
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Fixed Valuehttp://fhir.de/StructureDefinition/gender-amtlich-de
                                                311. Patient.gender.extension:other-amtlich.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: ele-1
                                                BindingThe codes SHALL be taken from For codes, see GenderOtherDE ValueSet
                                                (required to http://fhir.de/ValueSet/gender-other-de)
                                                TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                Is Modifierfalse
                                                Must Supporttrue
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist (%resource.where(gender='other').exists())
                                                313. Patient.gender.extension:other-amtlich.value[x].system
                                                Definition

                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                ShortIdentity of the terminology system
                                                Comments

                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                Control0..1
                                                Typeuri
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Need to be unambiguous about the source of the definition of the symbol.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                315. Patient.gender.extension:other-amtlich.value[x].code
                                                Definition

                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                ShortSymbol in syntax defined by the system
                                                Control0..1
                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                Summarytrue
                                                Requirements

                                                Need to refer to a particular code in the system.

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

                                                Das Geburtsdatum der Patientin oder des Patienten


                                                The date of birth for the individual.

                                                ShortGeburtsdatumThe date of birth for the individual
                                                Comments

                                                At least an estimated year should be provided as a guess if the real DOB 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..1
                                                Typedate
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Must Supporttrue
                                                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()))
                                                LOINC Code21112-8
                                                319. Patient.birthDate.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 manageable, 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..*
                                                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())
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 321. Patient.birthDate.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
                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  TypeExtension(Data Absent Reason) (Extension Type: code)
                                                  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())
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  323. Patient.deceased[x]
                                                  Definition

                                                  Gibt an, ob die Person verstorben ist oder nicht


                                                  Indicates if the individual is deceased or not.

                                                  ShortVerstorbenIndicates 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..1
                                                  TypeChoice of: boolean, dateTime
                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                  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 Supporttrue
                                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                                  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
                                                  • 325. 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..1
                                                    Typeboolean, dateTime
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    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 Supporttrue
                                                    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()))
                                                    327. 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..1
                                                    TypedateTime, boolean
                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                    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 Supporttrue
                                                    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()))
                                                    329. Patient.address
                                                    Definition

                                                    Eine Adresse der Patientin oder des Patienten


                                                    An address for the individual.

                                                    ShortAdresseAn address for the individual
                                                    Comments

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

                                                    Control0..*
                                                    TypeAddress
                                                    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()))
                                                    SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • pattern @ $this
                                                    • 331. Patient.address:Strassenanschrift
                                                      Slice NameStrassenanschrift
                                                      Definition

                                                      Eine Straßenanschrift der Patientin oder des Patienten


                                                      An address for the individual.

                                                      ShortStraßenanschriftAn address for the individual
                                                      Comments

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

                                                      Control0..*
                                                      TypeAddress(Adresse, deutsches Basisprofil)
                                                      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.

                                                      Pattern Value{
                                                        "type" : "both"
                                                      }
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                      333. Patient.address:Strassenanschrift.extension:Stadtteil
                                                      Slice NameStadtteil
                                                      Definition

                                                      A subsection of a municipality.

                                                      Shortprecinct
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(ADXP Precinct) (Extension Type: string)
                                                      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())
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      335. Patient.address:Strassenanschrift.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..1
                                                      This element is affected by the following invariants: ele-1
                                                      BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                                                      (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                      The use of an address.

                                                      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()))
                                                      337. Patient.address:Strassenanschrift.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).

                                                      Control10..1
                                                      This element is affected by the following invariants: ele-1
                                                      BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
                                                      (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                      The type of an address (physical / postal).

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

                                                      Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postfach strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.


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

                                                      ShortStraßenname mit Hausnummer oder Postfach sowie weitere Angaben zur ZustellungStreet name, number, direction & P.O. Box etc.
                                                      Comments

                                                      Note that FHIR strings SHALL NOT exceed 1MB in size

                                                      Control10..3*
                                                      This element is affected by the following invariants: ele-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      ExampleGeneral: 137 Nowhere Street
                                                      Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      341. Patient.address:Strassenanschrift.line.extension:Strasse
                                                      Slice NameStrasse
                                                      Definition

                                                      streetName.

                                                      ShortstreetName
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(ADXP Street Name) (Extension Type: string)
                                                      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())
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      343. Patient.address:Strassenanschrift.line.extension:Hausnummer
                                                      Slice NameHausnummer
                                                      Definition

                                                      The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                                                      ShorthouseNumber
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(ADXP House Number) (Extension Type: string)
                                                      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())
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      345. Patient.address:Strassenanschrift.line.extension:Adresszusatz
                                                      Slice NameAdresszusatz
                                                      Definition

                                                      This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

                                                      ShortadditionalLocator
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                      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())
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      347. Patient.address:Strassenanschrift.line.extension:Postfach
                                                      Slice NamePostfach
                                                      Definition

                                                      A numbered box located in a post station.

                                                      ShortpostBox
                                                      Control0..0
                                                      This element is affected by the following invariants: ele-1
                                                      TypeExtension(ADXP Post Box) (Extension Type: string)
                                                      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())
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      349. Patient.address:Strassenanschrift.city
                                                      Definition

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

                                                      ShortName of city, town etc.
                                                      Comments

                                                      Note that FHIR strings SHALL NOT exceed 1MB in size

                                                      Control10..1
                                                      This element is affected by the following invariants: ele-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Alternate NamesMunicpality
                                                      ExampleGeneral: Erewhon
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      351. Patient.address:Strassenanschrift.city.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 manageable, 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..*
                                                      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())
                                                      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.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 353. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel
                                                        Slice Namegemeindeschluessel
                                                        Definition

                                                        Optional Extension Element - found in all resources.

                                                        ShortOptional Extensions Element
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension(ExtensionDestatisAgs) (Extension Type: Coding)
                                                        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())
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        355. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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 manageable, 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..0*
                                                        This element is affected by the following invariants: ele-1
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        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())
                                                        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.city.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 357. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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
                                                          Must Supporttrue
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Fixed Valuehttp://fhir.de/StructureDefinition/destatis/ags
                                                          359. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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: ele-1
                                                          TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                          Is Modifierfalse
                                                          Must Supporttrue
                                                          ExampleAGS Hildesheim: { "system" : "http://fhir.de/sid/destatis/ags", "code" : "03254021" }
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          361. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].system
                                                          Definition

                                                          The identification of the code system that defines the meaning of the symbol in the code.

                                                          ShortIdentity of the terminology system
                                                          Comments

                                                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                          Control10..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typeuri
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Requirements

                                                          Need to be unambiguous about the source of the definition of the symbol.

                                                          Fixed Valuehttp://fhir.de/sid/destatis/ags
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          363. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code
                                                          Definition

                                                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                          ShortSymbol in syntax defined by the system
                                                          Comments

                                                          Note that FHIR strings SHALL NOT exceed 1MB in size

                                                          Control10..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typecode
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Requirements

                                                          Need to refer to a particular code in the system.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ags-extension-1: Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen ($this.matches('^[0-9]{8}$'))
                                                          365. Patient.address:Strassenanschrift.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
                                                          This element is affected by the following invariants: ele-1
                                                          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()))
                                                          367. Patient.address:Strassenanschrift.postalCode
                                                          Definition

                                                          Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen


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

                                                          ShortPostleitzahlPostal code for area
                                                          Comments

                                                          Note that FHIR strings SHALL NOT exceed 1MB in size

                                                          Control10..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Alternate NamesZip
                                                          ExampleGeneral: 9132
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          369. Patient.address:Strassenanschrift.country
                                                          Definition

                                                          Staatsangabe (ohne festgeschriebenen Wertevorrat)


                                                          Country - a nation as commonly understood or generally accepted.

                                                          ShortStaatCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                          Comments

                                                          ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                          Control10..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supporttrue
                                                          Summarytrue
                                                          ExampleBeispiel für textuelle Landesangabe: Deutschland
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          371. Patient.address:Strassenanschrift.country.extension:countryCode
                                                          Slice NamecountryCode
                                                          Definition

                                                          Kodierte Angabe des Länderkennzeichens nach ISO 3166-1.

                                                          ShortLänderkennzeichen nach ISO 3166-1
                                                          Comments

                                                          Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert.

                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          TypeExtension(Coded string) (Extension Type: Coding)
                                                          Alternate Namesextensions, user content
                                                          ExampleBeispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" }
                                                          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())
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          373. Patient.address:Strassenanschrift.country.extension:countryCode.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 manageable, 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..0*
                                                          This element is affected by the following invariants: ele-1
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          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())
                                                          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.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 375. Patient.address:Strassenanschrift.country.extension:countryCode.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.
                                                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-codedString
                                                            377. Patient.address:Strassenanschrift.country.extension:countryCode.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: ele-1
                                                            BindingThe codes SHALL be taken from For codes, see Iso3166-1-2
                                                            (required to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

                                                            A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.

                                                            TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                            Is Modifierfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            379. Patient.address:Postfach
                                                            Slice NamePostfach
                                                            Definition

                                                            Eine Postfachanschrift der Patientin oder des Patienten


                                                            An address for the individual.

                                                            ShortPostfachAn address for the individual
                                                            Comments

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

                                                            Control0..*
                                                            TypeAddress(Adresse, deutsches Basisprofil)
                                                            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.

                                                            Pattern Value{
                                                              "type" : "postal"
                                                            }
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                            381. Patient.address:Postfach.extension:Stadtteil
                                                            Slice NameStadtteil
                                                            Definition

                                                            A subsection of a municipality.

                                                            Shortprecinct
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(ADXP Precinct) (Extension Type: string)
                                                            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())
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            383. Patient.address:Postfach.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..1
                                                            This element is affected by the following invariants: ele-1
                                                            BindingThe codes SHALL be taken from AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1
                                                            (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                            The use of an address.

                                                            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()))
                                                            385. Patient.address:Postfach.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).

                                                            Control10..1
                                                            This element is affected by the following invariants: ele-1
                                                            BindingThe codes SHALL be taken from AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1
                                                            (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                            The type of an address (physical / postal).

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

                                                            Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postfach strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.


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

                                                            ShortStraßenname mit Hausnummer oder Postfach sowie weitere Angaben zur ZustellungStreet name, number, direction & P.O. Box etc.
                                                            Comments

                                                            Note that FHIR strings SHALL NOT exceed 1MB in size

                                                            Control10..3*
                                                            This element is affected by the following invariants: ele-1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            ExampleGeneral: 137 Nowhere Street
                                                            Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            389. Patient.address:Postfach.line.extension:Strasse
                                                            Slice NameStrasse
                                                            Definition

                                                            streetName.

                                                            ShortstreetName
                                                            Control0..0
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(ADXP Street Name) (Extension Type: string)
                                                            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())
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            391. Patient.address:Postfach.line.extension:Hausnummer
                                                            Slice NameHausnummer
                                                            Definition

                                                            The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                                                            ShorthouseNumber
                                                            Control0..0
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(ADXP House Number) (Extension Type: string)
                                                            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())
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            393. Patient.address:Postfach.line.extension:Adresszusatz
                                                            Slice NameAdresszusatz
                                                            Definition

                                                            This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

                                                            ShortadditionalLocator
                                                            Control0..0
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                            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())
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            395. Patient.address:Postfach.line.extension:Postfach
                                                            Slice NamePostfach
                                                            Definition

                                                            A numbered box located in a post station.

                                                            ShortpostBox
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            TypeExtension(ADXP Post Box) (Extension Type: string)
                                                            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())
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            397. Patient.address:Postfach.city
                                                            Definition

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

                                                            ShortName of city, town etc.
                                                            Comments

                                                            Note that FHIR strings SHALL NOT exceed 1MB in size

                                                            Control10..1
                                                            This element is affected by the following invariants: ele-1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Must Supporttrue
                                                            Summarytrue
                                                            Alternate NamesMunicpality
                                                            ExampleGeneral: Erewhon
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            399. Patient.address:Postfach.city.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 manageable, 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..*
                                                            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())
                                                            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.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 401. Patient.address:Postfach.city.extension:gemeindeschluessel
                                                              Slice Namegemeindeschluessel
                                                              Definition

                                                              Optional Extension Element - found in all resources.

                                                              ShortOptional Extensions Element
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              TypeExtension(ExtensionDestatisAgs) (Extension Type: Coding)
                                                              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())
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              403. Patient.address:Postfach.city.extension:gemeindeschluessel.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 manageable, 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..0*
                                                              This element is affected by the following invariants: ele-1
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              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())
                                                              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.city.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 405. Patient.address:Postfach.city.extension:gemeindeschluessel.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
                                                                Must Supporttrue
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Fixed Valuehttp://fhir.de/StructureDefinition/destatis/ags
                                                                407. Patient.address:Postfach.city.extension:gemeindeschluessel.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: ele-1
                                                                TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                ExampleAGS Hildesheim: { "system" : "http://fhir.de/sid/destatis/ags", "code" : "03254021" }
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                409. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].system
                                                                Definition

                                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                                ShortIdentity of the terminology system
                                                                Comments

                                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                Control10..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typeuri
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supporttrue
                                                                Summarytrue
                                                                Requirements

                                                                Need to be unambiguous about the source of the definition of the symbol.

                                                                Fixed Valuehttp://fhir.de/sid/destatis/ags
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                411. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code
                                                                Definition

                                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                ShortSymbol in syntax defined by the system
                                                                Comments

                                                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                Control10..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typecode
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supporttrue
                                                                Summarytrue
                                                                Requirements

                                                                Need to refer to a particular code in the system.

                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ags-extension-1: Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen ($this.matches('^[0-9]{8}$'))
                                                                413. Patient.address:Postfach.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
                                                                This element is affected by the following invariants: ele-1
                                                                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()))
                                                                415. Patient.address:Postfach.postalCode
                                                                Definition

                                                                Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen


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

                                                                ShortPostleitzahlPostal code for area
                                                                Comments

                                                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                Control10..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supporttrue
                                                                Summarytrue
                                                                Alternate NamesZip
                                                                ExampleGeneral: 9132
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                417. Patient.address:Postfach.country
                                                                Definition

                                                                Staatsangabe (ohne festgeschriebenen Wertevorrat)


                                                                Country - a nation as commonly understood or generally accepted.

                                                                ShortStaatCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                                                Comments

                                                                ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                Control10..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typestring
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supporttrue
                                                                Summarytrue
                                                                ExampleBeispiel für textuelle Landesangabe: Deutschland
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                419. Patient.address:Postfach.country.extension:countryCode
                                                                Slice NamecountryCode
                                                                Definition

                                                                Kodierte Angabe des Länderkennzeichens nach ISO 3166-1.

                                                                ShortLänderkennzeichen nach ISO 3166-1
                                                                Comments

                                                                Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert.

                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                TypeExtension(Coded string) (Extension Type: Coding)
                                                                Alternate Namesextensions, user content
                                                                ExampleBeispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" }
                                                                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())
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                421. Patient.address:Postfach.country.extension:countryCode.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 manageable, 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..0*
                                                                This element is affected by the following invariants: ele-1
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                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())
                                                                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.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 423. Patient.address:Postfach.country.extension:countryCode.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.
                                                                  Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-codedString
                                                                  425. Patient.address:Postfach.country.extension:countryCode.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: ele-1
                                                                  BindingThe codes SHALL be taken from For codes, see Iso3166-1-2
                                                                  (required to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

                                                                  A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.

                                                                  TypeCoding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                  Is Modifierfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  427. Patient.link
                                                                  Definition

                                                                  Verweis auf eine andere Patientenressource, die die gleiche tatsächliche Person betrifft


                                                                  Link to another patient resource that concerns the same actual patient.

                                                                  ShortVerweisLink to another patient resource that concerns the same actual person
                                                                  Comments

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

                                                                  Control0..*
                                                                  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 Supporttrue
                                                                  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()))
                                                                  429. Patient.link.modifierExtension
                                                                  Definition

                                                                  May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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 even if unrecognized
                                                                  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 element that contains them
                                                                  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, modifiers
                                                                  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())
                                                                  431. Patient.link.other
                                                                  Definition

                                                                  The other patient resource that the link refers to.

                                                                  ShortThe other patient or related person resource that the link refers to
                                                                  Comments

                                                                  Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                  Control1..1
                                                                  TypeReference(Patient, RelatedPerson)
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Must Support TypesNo must-support rules about the choice of types/profiles
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  433. Patient.link.type
                                                                  Definition

                                                                  The type of link between this patient resource and another patient resource.

                                                                  Shortreplaced-by | replaces | refer | seealso
                                                                  Control1..1
                                                                  BindingThe codes SHALL be taken from LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1
                                                                  (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                                                  The type of link between this patient resource and another patient resource.

                                                                  Typecode
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  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
                                                                  Invariantsmii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden (gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').exists())
                                                                  2. Patient.id
                                                                  Must Supporttrue
                                                                  4. Patient.meta
                                                                  Must Supporttrue
                                                                  6. Patient.meta.profile
                                                                  Must Supporttrue
                                                                  8. Patient.extension
                                                                  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:birthPlace
                                                                    Slice NamebirthPlace
                                                                    Control0..1
                                                                    TypeExtension(Patient Birth Place) (Extension Type: Address)
                                                                    Must Supporttrue
                                                                    12. Patient.extension:birthPlace.url
                                                                    Must Supporttrue
                                                                    14. Patient.extension:birthPlace.value[x]
                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                    Must Supporttrue
                                                                    16. Patient.extension:birthPlace.value[x].country
                                                                    Must Supporttrue
                                                                    18. Patient.extension:birthPlace.value[x].country.extension
                                                                    SlicingThis element introduces a set of slices on Patient.extension.value[x].country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 20. Patient.extension:birthPlace.value[x].country.extension:countryCode
                                                                      Slice NamecountryCode
                                                                      Control0..1
                                                                      TypeExtension(Coded string) (Extension Type: Coding)
                                                                      Must Supporttrue
                                                                      22. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x]
                                                                      BindingThe codes SHOULD be taken from Iso3166-1-2
                                                                      (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2)
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      24. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].system
                                                                      Must Supporttrue
                                                                      26. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].code
                                                                      Must Supporttrue
                                                                      28. Patient.extension:patient-citizenship
                                                                      Slice Namepatient-citizenship
                                                                      Control0..*
                                                                      TypeExtension(Patient Citizenship) (Complex Extension)
                                                                      Must Supporttrue
                                                                      30. Patient.extension:patient-citizenship.extension:code
                                                                      Slice Namecode
                                                                      Must Supporttrue
                                                                      32. Patient.extension:patient-citizenship.extension:code.url
                                                                      Must Supporttrue
                                                                      34. Patient.extension:patient-citizenship.extension:code.value[x]
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      36. Patient.extension:patient-citizenship.extension:code.value[x].coding
                                                                      Must Supporttrue
                                                                      38. Patient.extension:patient-citizenship.extension:code.value[x].coding.system
                                                                      Must Supporttrue
                                                                      40. Patient.extension:patient-citizenship.extension:code.value[x].coding.code
                                                                      Must Supporttrue
                                                                      42. Patient.extension:patient-citizenship.extension:period
                                                                      Slice Nameperiod
                                                                      Must Supporttrue
                                                                      44. Patient.extension:patient-citizenship.extension:period.url
                                                                      Must Supporttrue
                                                                      46. Patient.extension:patient-citizenship.extension:period.value[x]
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      48. Patient.extension:patient-citizenship.url
                                                                      Must Supporttrue
                                                                      50. Patient.extension:patient-nationality
                                                                      Slice Namepatient-nationality
                                                                      Control0..*
                                                                      TypeExtension(Patient Nationality) (Complex Extension)
                                                                      Must Supporttrue
                                                                      52. Patient.extension:patient-nationality.extension:code
                                                                      Slice Namecode
                                                                      Must Supporttrue
                                                                      54. Patient.extension:patient-nationality.extension:code.url
                                                                      Must Supporttrue
                                                                      56. Patient.extension:patient-nationality.extension:code.value[x]
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      58. Patient.extension:patient-nationality.extension:code.value[x].coding
                                                                      Must Supporttrue
                                                                      60. Patient.extension:patient-nationality.extension:code.value[x].coding.system
                                                                      Must Supporttrue
                                                                      62. Patient.extension:patient-nationality.extension:code.value[x].coding.code
                                                                      Must Supporttrue
                                                                      64. Patient.extension:patient-nationality.extension:period
                                                                      Slice Nameperiod
                                                                      Must Supporttrue
                                                                      66. Patient.extension:patient-nationality.extension:period.url
                                                                      Must Supporttrue
                                                                      68. Patient.extension:patient-nationality.extension:period.value[x]
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      70. Patient.extension:patient-nationality.url
                                                                      Must Supporttrue
                                                                      72. Patient.extension:recordedSexOrGender
                                                                      Slice NamerecordedSexOrGender
                                                                      Control0..*
                                                                      TypeExtension(Person Recorded Sex Or Gender) (Complex Extension)
                                                                      Must Supporttrue
                                                                      74. Patient.extension:recordedSexOrGender.extension:value
                                                                      Slice Namevalue
                                                                      Must Supporttrue
                                                                      76. Patient.extension:recordedSexOrGender.extension:value.url
                                                                      Must Supporttrue
                                                                      78. Patient.extension:recordedSexOrGender.extension:value.value[x]
                                                                      BindingThe codes SHOULD be taken from MII VS Person Recorded Sex or Gender SNOMED
                                                                      (preferred to https://www.medizininformatik-initiative.de/fhir/modul-person/ValueSet/mii-vs-person-recordedsexorgender-snomed)
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      80. Patient.extension:recordedSexOrGender.extension:value.value[x].coding
                                                                      Must Supporttrue
                                                                      82. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.system
                                                                      Must Supporttrue
                                                                      84. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.code
                                                                      Must Supporttrue
                                                                      86. Patient.extension:recordedSexOrGender.extension:type
                                                                      Slice Nametype
                                                                      Must Supporttrue
                                                                      88. Patient.extension:recordedSexOrGender.extension:type.url
                                                                      Must Supporttrue
                                                                      90. Patient.extension:recordedSexOrGender.extension:type.value[x]
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      92. Patient.extension:recordedSexOrGender.extension:type.value[x].coding
                                                                      Must Supporttrue
                                                                      94. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.system
                                                                      Must Supporttrue
                                                                      96. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.code
                                                                      Must Supporttrue
                                                                      98. Patient.extension:recordedSexOrGender.extension:acquisitionDate
                                                                      Slice NameacquisitionDate
                                                                      Must Supporttrue
                                                                      100. Patient.extension:recordedSexOrGender.extension:acquisitionDate.url
                                                                      Must Supporttrue
                                                                      102. Patient.extension:recordedSexOrGender.extension:acquisitionDate.value[x]
                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                      Must Supporttrue
                                                                      104. Patient.extension:recordedSexOrGender.url
                                                                      Must Supporttrue
                                                                      106. Patient.identifier
                                                                      Definition

                                                                      Ein Identifikator für den/die Patient*in

                                                                      ShortPatienten-Identifikator
                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                      Must Supporttrue
                                                                      SlicingThis element introduces a set of slices on Patient.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • pattern @ $this
                                                                      • 108. Patient.identifier:versichertenId
                                                                        Slice NameversichertenId
                                                                        Definition

                                                                        Krankenversichertennummer, unabhängig, ob GKV, PKV oder Sonderkostenträger

                                                                        ShortKrankenversichertennummer
                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                        Control0..1
                                                                        TypeIdentifier(Identifier-Profil für die 10-stellige Krankenversichertennummer)
                                                                        Must Supporttrue
                                                                        Pattern Value{
                                                                          "type" : {
                                                                            "coding" : [{
                                                                              "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis",
                                                                              "code" : "KVZ10"
                                                                            }]
                                                                          }
                                                                        }
                                                                        110. Patient.identifier:versichertenId.type
                                                                        Control1..?
                                                                        Must Supporttrue
                                                                        112. Patient.identifier:versichertenId.type.coding
                                                                        Must Supporttrue
                                                                        114. Patient.identifier:versichertenId.type.coding.system
                                                                        Must Supporttrue
                                                                        116. Patient.identifier:versichertenId.type.coding.code
                                                                        Must Supporttrue
                                                                        118. Patient.identifier:versichertenId.system
                                                                        Must Supporttrue
                                                                        120. Patient.identifier:versichertenId.value
                                                                        Must Supporttrue
                                                                        122. Patient.identifier:versichertenId.assigner
                                                                        Control1..?
                                                                        Must Supporttrue
                                                                        124. Patient.identifier:versichertenId.assigner.identifier
                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                        Control1..?
                                                                        TypeIdentifier(Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR))
                                                                        Must Supporttrue
                                                                        126. Patient.identifier:versichertenId.assigner.identifier.type
                                                                        Must Supporttrue
                                                                        128. Patient.identifier:versichertenId.assigner.identifier.type.coding
                                                                        Must Supporttrue
                                                                        130. Patient.identifier:versichertenId.assigner.identifier.type.coding.system
                                                                        Must Supporttrue
                                                                        132. Patient.identifier:versichertenId.assigner.identifier.type.coding.code
                                                                        Must Supporttrue
                                                                        134. Patient.identifier:versichertenId.assigner.identifier.system
                                                                        Must Supporttrue
                                                                        136. Patient.identifier:versichertenId.assigner.identifier.value
                                                                        Must Supporttrue
                                                                        138. Patient.identifier:pid
                                                                        Slice Namepid
                                                                        Definition

                                                                        Patientenidentifikator innerhalb einer Organisation

                                                                        ShortPatientenidentifikation
                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                        Control0..*
                                                                        TypeIdentifier(Identifier-Profil für die Abbildung einer Patienten-ID)
                                                                        Must Supporttrue
                                                                        Pattern Value{
                                                                          "type" : {
                                                                            "coding" : [{
                                                                              "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                                              "code" : "MR"
                                                                            }]
                                                                          }
                                                                        }
                                                                        140. Patient.identifier:pid.type
                                                                        Must Supporttrue
                                                                        142. Patient.identifier:pid.type.coding
                                                                        Must Supporttrue
                                                                        144. Patient.identifier:pid.type.coding.system
                                                                        Must Supporttrue
                                                                        146. Patient.identifier:pid.type.coding.code
                                                                        Must Supporttrue
                                                                        148. Patient.identifier:pid.system
                                                                        Must Supporttrue
                                                                        150. Patient.identifier:pid.value
                                                                        Must Supporttrue
                                                                        152. Patient.identifier:pid.assigner
                                                                        Must Supporttrue
                                                                        154. Patient.identifier:pid.assigner.identifier
                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                        Must Supporttrue
                                                                        156. Patient.identifier:pid.assigner.identifier.type
                                                                        Must Supporttrue
                                                                        Pattern Value{
                                                                          "coding" : [{
                                                                            "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                                            "code" : "XX"
                                                                          }]
                                                                        }
                                                                        158. Patient.identifier:pid.assigner.identifier.type.coding
                                                                        Must Supporttrue
                                                                        160. Patient.identifier:pid.assigner.identifier.type.coding.system
                                                                        Must Supporttrue
                                                                        162. Patient.identifier:pid.assigner.identifier.type.coding.code
                                                                        Must Supporttrue
                                                                        164. Patient.identifier:pid.assigner.identifier.system
                                                                        Invariantsmii-pat-2: Entweder IKNR oder MII Core Location Identifier muss verwendet werden ($this = 'http://fhir.de/sid/arge-ik/iknr' or $this = 'https://www.medizininformatik-initiative.de/fhir/core/CodeSystem/core-location-identifier')
                                                                        166. Patient.name
                                                                        Definition

                                                                        Name der Patientin oder des Patienten

                                                                        ShortName
                                                                        Must Supporttrue
                                                                        SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • pattern @ $this
                                                                        • 168. Patient.name:name
                                                                          Slice Namename
                                                                          Definition

                                                                          Personenname mit in Deutschland üblichen Namensbestandteilen

                                                                          ShortPersonenname
                                                                          Control0..1
                                                                          TypeHumanName(HumanName, deutsches Basisprofil)
                                                                          Must Supporttrue
                                                                          Pattern Value{
                                                                            "use" : "official"
                                                                          }
                                                                          170. Patient.name:name.use
                                                                          Control1..?
                                                                          Must Supporttrue
                                                                          172. Patient.name:name.family
                                                                          Control1..?
                                                                          Must Supporttrue
                                                                          174. Patient.name:name.family.extension:namenszusatz
                                                                          Slice Namenamenszusatz
                                                                          Must Supporttrue
                                                                          176. Patient.name:name.family.extension:nachname
                                                                          Slice Namenachname
                                                                          Must Supporttrue
                                                                          178. Patient.name:name.family.extension:vorsatzwort
                                                                          Slice Namevorsatzwort
                                                                          Must Supporttrue
                                                                          180. Patient.name:name.given
                                                                          Control1..?
                                                                          Must Supporttrue
                                                                          182. Patient.name:name.prefix
                                                                          Must Supporttrue
                                                                          184. Patient.name:name.prefix.extension:prefix-qualifier
                                                                          Slice Nameprefix-qualifier
                                                                          Must Supporttrue
                                                                          186. Patient.name:geburtsname
                                                                          Slice Namegeburtsname
                                                                          Definition

                                                                          Name, der vor einer Namensänderung aufgrund von Heirat verwendet wurde

                                                                          ShortGeburtsname
                                                                          Control0..1
                                                                          TypeHumanName(HumanName, deutsches Basisprofil)
                                                                          Must Supporttrue
                                                                          Pattern Value{
                                                                            "use" : "maiden"
                                                                          }
                                                                          188. Patient.name:geburtsname.use
                                                                          Control1..?
                                                                          Must Supporttrue
                                                                          190. Patient.name:geburtsname.family
                                                                          Control1..?
                                                                          Must Supporttrue
                                                                          192. Patient.name:geburtsname.family.extension:namenszusatz
                                                                          Slice Namenamenszusatz
                                                                          Must Supporttrue
                                                                          194. Patient.name:geburtsname.family.extension:nachname
                                                                          Slice Namenachname
                                                                          Must Supporttrue
                                                                          196. Patient.name:geburtsname.family.extension:vorsatzwort
                                                                          Slice Namevorsatzwort
                                                                          Must Supporttrue
                                                                          198. Patient.name:geburtsname.given
                                                                          Control0..0
                                                                          200. Patient.name:geburtsname.prefix
                                                                          Control0..0
                                                                          203. Patient.gender
                                                                          Definition

                                                                          männlich | weiblich | andere | unbekannt | unbestimmt | divers

                                                                          ShortAdministratives Geschlecht
                                                                          Must Supporttrue
                                                                          205. Patient.gender.extension
                                                                          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
                                                                          • 207. Patient.gender.extension:other-amtlich
                                                                            Slice Nameother-amtlich
                                                                            Definition

                                                                            Extension zur genaueren Differenzierung des administrativen Geschlechts

                                                                            ShortExtension Administratives Geschlecht
                                                                            Control0..1
                                                                            TypeExtension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding)
                                                                            Must Supporttrue
                                                                            209. Patient.gender.extension:other-amtlich.url
                                                                            Must Supporttrue
                                                                            211. Patient.gender.extension:other-amtlich.value[x]
                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                            Must Supporttrue
                                                                            213. Patient.gender.extension:other-amtlich.value[x].system
                                                                            Must Supporttrue
                                                                            215. Patient.gender.extension:other-amtlich.value[x].code
                                                                            Must Supporttrue
                                                                            217. Patient.birthDate
                                                                            Definition

                                                                            Das Geburtsdatum der Patientin oder des Patienten

                                                                            ShortGeburtsdatum
                                                                            Must Supporttrue
                                                                            LOINC Code
                                                                            219. Patient.birthDate.extension
                                                                            SlicingThis element introduces a set of slices on Patient.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 221. Patient.birthDate.extension:data-absent-reason
                                                                              Slice Namedata-absent-reason
                                                                              Control0..1
                                                                              TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                              Must Supporttrue
                                                                              223. Patient.deceased[x]
                                                                              Definition

                                                                              Gibt an, ob die Person verstorben ist oder nicht

                                                                              ShortVerstorben
                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                              Must Supporttrue
                                                                              SlicingThis element introduces a set of slices on Patient.deceased[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • type @ $this
                                                                              • 225. Patient.deceased[x]:deceasedBoolean
                                                                                Slice NamedeceasedBoolean
                                                                                Control0..1
                                                                                Typeboolean
                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supporttrue
                                                                                227. Patient.deceased[x]:deceasedDateTime
                                                                                Slice NamedeceasedDateTime
                                                                                Control0..1
                                                                                TypedateTime
                                                                                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Must Supporttrue
                                                                                229. Patient.address
                                                                                Definition

                                                                                Eine Adresse der Patientin oder des Patienten

                                                                                ShortAdresse
                                                                                Must Supporttrue
                                                                                SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • pattern @ $this
                                                                                • 231. Patient.address:Strassenanschrift
                                                                                  Slice NameStrassenanschrift
                                                                                  Definition

                                                                                  Eine Straßenanschrift der Patientin oder des Patienten

                                                                                  ShortStraßenanschrift
                                                                                  Control0..*
                                                                                  TypeAddress(Adresse, deutsches Basisprofil)
                                                                                  Must Supporttrue
                                                                                  Pattern Value{
                                                                                    "type" : "both"
                                                                                  }
                                                                                  Invariantspat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                                                  233. Patient.address:Strassenanschrift.extension:Stadtteil
                                                                                  Slice NameStadtteil
                                                                                  Must Supporttrue
                                                                                  235. Patient.address:Strassenanschrift.type
                                                                                  Control1..?
                                                                                  Must Supporttrue
                                                                                  237. Patient.address:Strassenanschrift.line
                                                                                  Control1..?
                                                                                  Must Supporttrue
                                                                                  239. Patient.address:Strassenanschrift.line.extension:Strasse
                                                                                  Slice NameStrasse
                                                                                  Must Supporttrue
                                                                                  241. Patient.address:Strassenanschrift.line.extension:Hausnummer
                                                                                  Slice NameHausnummer
                                                                                  Must Supporttrue
                                                                                  243. Patient.address:Strassenanschrift.line.extension:Adresszusatz
                                                                                  Slice NameAdresszusatz
                                                                                  Must Supporttrue
                                                                                  245. Patient.address:Strassenanschrift.line.extension:Postfach
                                                                                  Slice NamePostfach
                                                                                  Control0..0
                                                                                  Must Supporttrue
                                                                                  247. Patient.address:Strassenanschrift.city
                                                                                  Control1..?
                                                                                  Must Supporttrue
                                                                                  249. Patient.address:Strassenanschrift.city.extension
                                                                                  SlicingThis element introduces a set of slices on Patient.address.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                  • value @ url
                                                                                  • 251. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel
                                                                                    Slice Namegemeindeschluessel
                                                                                    Control0..1
                                                                                    TypeExtension(ExtensionDestatisAgs) (Extension Type: Coding)
                                                                                    Must Supporttrue
                                                                                    253. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.url
                                                                                    Must Supporttrue
                                                                                    255. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x]
                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                    Must Supporttrue
                                                                                    257. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].system
                                                                                    Must Supporttrue
                                                                                    259. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code
                                                                                    Must Supporttrue
                                                                                    261. Patient.address:Strassenanschrift.postalCode
                                                                                    Control1..?
                                                                                    Must Supporttrue
                                                                                    263. Patient.address:Strassenanschrift.country
                                                                                    Control1..?
                                                                                    Must Supporttrue
                                                                                    265. Patient.address:Postfach
                                                                                    Slice NamePostfach
                                                                                    Definition

                                                                                    Eine Postfachanschrift der Patientin oder des Patienten

                                                                                    ShortPostfach
                                                                                    Control0..*
                                                                                    TypeAddress(Adresse, deutsches Basisprofil)
                                                                                    Must Supporttrue
                                                                                    Pattern Value{
                                                                                      "type" : "postal"
                                                                                    }
                                                                                    Invariantspat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                                                    267. Patient.address:Postfach.extension:Stadtteil
                                                                                    Slice NameStadtteil
                                                                                    Must Supporttrue
                                                                                    269. Patient.address:Postfach.type
                                                                                    Control1..?
                                                                                    Must Supporttrue
                                                                                    271. Patient.address:Postfach.line
                                                                                    Control1..?
                                                                                    Must Supporttrue
                                                                                    273. Patient.address:Postfach.line.extension:Strasse
                                                                                    Slice NameStrasse
                                                                                    Control0..0
                                                                                    275. Patient.address:Postfach.line.extension:Hausnummer
                                                                                    Slice NameHausnummer
                                                                                    Control0..0
                                                                                    277. Patient.address:Postfach.line.extension:Adresszusatz
                                                                                    Slice NameAdresszusatz
                                                                                    Control0..0
                                                                                    279. Patient.address:Postfach.line.extension:Postfach
                                                                                    Slice NamePostfach
                                                                                    Must Supporttrue
                                                                                    281. Patient.address:Postfach.city
                                                                                    Control1..?
                                                                                    Must Supporttrue
                                                                                    283. Patient.address:Postfach.city.extension
                                                                                    SlicingThis element introduces a set of slices on Patient.address.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                    • value @ url
                                                                                    • 285. Patient.address:Postfach.city.extension:gemeindeschluessel
                                                                                      Slice Namegemeindeschluessel
                                                                                      Control0..1
                                                                                      TypeExtension(ExtensionDestatisAgs) (Extension Type: Coding)
                                                                                      Must Supporttrue
                                                                                      287. Patient.address:Postfach.city.extension:gemeindeschluessel.url
                                                                                      Must Supporttrue
                                                                                      289. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x]
                                                                                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                      Must Supporttrue
                                                                                      291. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].system
                                                                                      Must Supporttrue
                                                                                      293. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code
                                                                                      Must Supporttrue
                                                                                      295. Patient.address:Postfach.postalCode
                                                                                      Control1..?
                                                                                      Must Supporttrue
                                                                                      297. Patient.address:Postfach.country
                                                                                      Control1..?
                                                                                      Must Supporttrue
                                                                                      299. Patient.link
                                                                                      Definition

                                                                                      Verweis auf eine andere Patientenressource, die die gleiche tatsächliche Person betrifft

                                                                                      ShortVerweis
                                                                                      Must Supporttrue
                                                                                      301. Patient.link.other
                                                                                      Must Supporttrue
                                                                                      303. Patient.link.type
                                                                                      Must Supporttrue

                                                                                      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
                                                                                      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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                                                                                      dom-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())
                                                                                      mii-pat-1: Falls die Geschlechtsangabe 'other' gewählt wird, muss die amtliche Differenzierung per Extension angegeben werden (gender.exists() and gender='other' implies gender.extension('http://fhir.de/StructureDefinition/gender-amtlich-de').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

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

                                                                                      Control0..1
                                                                                      Typeid
                                                                                      Is Modifierfalse
                                                                                      Must Supporttrue
                                                                                      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 Supporttrue
                                                                                      Summarytrue
                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                      6. Patient.meta.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
                                                                                      Typestring
                                                                                      Is Modifierfalse
                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                      Summaryfalse
                                                                                      8. Patient.meta.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 manageable, 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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                      • value @ url
                                                                                      • 10. Patient.meta.versionId
                                                                                        Definition

                                                                                        The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                                                                                        ShortVersion specific identifier
                                                                                        Comments

                                                                                        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                                                                                        Control0..1
                                                                                        Typeid
                                                                                        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()))
                                                                                        12. Patient.meta.lastUpdated
                                                                                        Definition

                                                                                        When the resource last changed - e.g. when the version changed.

                                                                                        ShortWhen the resource version last changed
                                                                                        Comments

                                                                                        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                                                                                        Control0..1
                                                                                        Typeinstant
                                                                                        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()))
                                                                                        14. Patient.meta.source
                                                                                        Definition

                                                                                        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                                                                                        ShortIdentifies where the resource comes from
                                                                                        Comments

                                                                                        In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                                                                                        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                                                                                        Control0..1
                                                                                        Typeuri
                                                                                        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()))
                                                                                        16. Patient.meta.profile
                                                                                        Definition

                                                                                        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                                                                                        ShortProfiles this resource claims to conform to
                                                                                        Comments

                                                                                        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                                                                                        Control0..*
                                                                                        Typecanonical(StructureDefinition)
                                                                                        Is Modifierfalse
                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                        Must Supporttrue
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        18. Patient.meta.security
                                                                                        Definition

                                                                                        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                                                                                        ShortSecurity Labels applied to this resource
                                                                                        Comments

                                                                                        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                                                        Control0..*
                                                                                        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                                                                                        (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

                                                                                        Security Labels from the Healthcare Privacy and Security Classification System.

                                                                                        TypeCoding
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        20. Patient.meta.tag
                                                                                        Definition

                                                                                        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                                                                                        ShortTags applied to this resource
                                                                                        Comments

                                                                                        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                                                                                        Control0..*
                                                                                        BindingFor example codes, see CommonTags
                                                                                        (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

                                                                                        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                                                                                        TypeCoding
                                                                                        Is Modifierfalse
                                                                                        Summarytrue
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        22. 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 it's narrative along with other profiles, value sets, etc.

                                                                                        Control0..1
                                                                                        Typeuri
                                                                                        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                                                                                        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()))
                                                                                        24. 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..1
                                                                                        BindingThe codes SHOULD be taken from CommonLanguages
                                                                                        (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                                                                        A human language.

                                                                                        Additional BindingsPurpose
                                                                                        AllLanguagesMax Binding
                                                                                        Typecode
                                                                                        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()))
                                                                                        26. 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 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
                                                                                        TypeNarrative
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Alternate Namesnarrative, html, xhtml, display
                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                        28. Patient.contained
                                                                                        Definition

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

                                                                                        ShortContained, inline Resources
                                                                                        Comments

                                                                                        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                                                                                        Control0..*
                                                                                        TypeResource
                                                                                        Is Modifierfalse
                                                                                        Summaryfalse
                                                                                        Alternate Namesinline resources, anonymous resources, contained resources
                                                                                        30. Patient.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                        • value @ url
                                                                                        • 32. 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.

                                                                                          Control0..1
                                                                                          This element is affected by the following invariants: ele-1
                                                                                          TypeExtension(Patient Birth Place) (Extension Type: Address)
                                                                                          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())
                                                                                          34. Patient.extension:birthPlace.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
                                                                                          Typestring
                                                                                          Is Modifierfalse
                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                          Summaryfalse
                                                                                          36. Patient.extension:birthPlace.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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                          • value @ url
                                                                                          • 38. Patient.extension:birthPlace.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
                                                                                            Must Supporttrue
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-birthPlace
                                                                                            40. Patient.extension:birthPlace.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
                                                                                            TypeAddress
                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                            Is Modifierfalse
                                                                                            Must Supporttrue
                                                                                            Summaryfalse
                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                            42. Patient.extension:birthPlace.value[x].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
                                                                                            Typestring
                                                                                            Is Modifierfalse
                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                            Summaryfalse
                                                                                            44. Patient.extension:birthPlace.value[x].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 manageable, 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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                            • value @ url
                                                                                            • 46. Patient.extension:birthPlace.value[x].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..1
                                                                                              BindingThe codes SHALL be taken from AddressUse
                                                                                              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                                                              The use of an address.

                                                                                              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()))
                                                                                              48. Patient.extension:birthPlace.value[x].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..1
                                                                                              BindingThe codes SHALL be taken from AddressType
                                                                                              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                                                              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()))
                                                                                              50. Patient.extension:birthPlace.value[x].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..1
                                                                                              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()))
                                                                                              52. Patient.extension:birthPlace.value[x].line
                                                                                              Definition

                                                                                              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()))
                                                                                              54. Patient.extension:birthPlace.value[x].city
                                                                                              Definition

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

                                                                                              ShortName of city, town etc.
                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summarytrue
                                                                                              Alternate NamesMunicpality
                                                                                              ExampleGeneral: Erewhon
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              56. Patient.extension:birthPlace.value[x].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..1
                                                                                              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()))
                                                                                              58. Patient.extension:birthPlace.value[x].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..1
                                                                                              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()))
                                                                                              60. Patient.extension:birthPlace.value[x].postalCode
                                                                                              Definition

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

                                                                                              ShortPostal code for area
                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Summarytrue
                                                                                              Alternate NamesZip
                                                                                              ExampleGeneral: 9132
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              62. Patient.extension:birthPlace.value[x].country
                                                                                              Definition

                                                                                              Country - a nation as commonly understood or generally accepted.

                                                                                              Comments

                                                                                              ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                                              Control0..1
                                                                                              Typestring
                                                                                              Is Modifierfalse
                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                              Must Supporttrue
                                                                                              Summarytrue
                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                              64. Patient.extension:birthPlace.value[x].country.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
                                                                                              66. Patient.extension:birthPlace.value[x].country.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.extension.value[x].country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                              • value @ url
                                                                                              • 68. Patient.extension:birthPlace.value[x].country.extension:countryCode
                                                                                                Slice NamecountryCode
                                                                                                Definition

                                                                                                Provides a coded expression for the content represented in a string.

                                                                                                Shortcode for string
                                                                                                Control0..1
                                                                                                This element is affected by the following invariants: ele-1
                                                                                                TypeExtension(Coded string) (Extension Type: Coding)
                                                                                                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())
                                                                                                70. Patient.extension:birthPlace.value[x].country.extension:countryCode.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
                                                                                                Typestring
                                                                                                Is Modifierfalse
                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                Summaryfalse
                                                                                                72. Patient.extension:birthPlace.value[x].country.extension:countryCode.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.value[x].country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                • value @ url
                                                                                                • 74. Patient.extension:birthPlace.value[x].country.extension:countryCode.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/iso21090-codedString
                                                                                                  76. Patient.extension:birthPlace.value[x].country.extension:countryCode.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
                                                                                                  BindingThe codes SHOULD be taken from Iso3166-1-2
                                                                                                  (preferred to http://hl7.org/fhir/ValueSet/iso3166-1-2)
                                                                                                  TypeCoding
                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                  Is Modifierfalse
                                                                                                  Must Supporttrue
                                                                                                  Summaryfalse
                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                  78. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].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
                                                                                                  Typestring
                                                                                                  Is Modifierfalse
                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                  Summaryfalse
                                                                                                  80. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].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 manageable, 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.value[x].country.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                  • value @ url
                                                                                                  • 82. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].system
                                                                                                    Definition

                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                    ShortIdentity of the terminology system
                                                                                                    Comments

                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                    Control0..1
                                                                                                    Typeuri
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Must Supporttrue
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    84. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].version
                                                                                                    Definition

                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                    ShortVersion of the system - if relevant
                                                                                                    Comments

                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                    Control0..1
                                                                                                    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()))
                                                                                                    86. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].code
                                                                                                    Definition

                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                    Control0..1
                                                                                                    Typecode
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Must Supporttrue
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Need to refer to a particular code in the system.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    88. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].display
                                                                                                    Definition

                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                    ShortRepresentation defined by the system
                                                                                                    Control0..1
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                    Summarytrue
                                                                                                    Requirements

                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    90. Patient.extension:birthPlace.value[x].country.extension:countryCode.value[x].userSelected
                                                                                                    Definition

                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                    Comments

                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                    92. Patient.extension:birthPlace.value[x].country.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
                                                                                                    94. Patient.extension:birthPlace.value[x].period
                                                                                                    Definition

                                                                                                    Time period when address was/is in use.

                                                                                                    ShortTime period when address was/is in use
                                                                                                    Control0..1
                                                                                                    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()))
                                                                                                    96. Patient.extension:patient-citizenship
                                                                                                    Slice Namepatient-citizenship
                                                                                                    Definition

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

                                                                                                    Control0..*
                                                                                                    This element is affected by the following invariants: ele-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())
                                                                                                    98. Patient.extension:patient-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
                                                                                                    Typestring
                                                                                                    Is Modifierfalse
                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                    Summaryfalse
                                                                                                    100. Patient.extension:patient-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 manageable, 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
                                                                                                    • 102. Patient.extension:patient-citizenship.extension:code
                                                                                                      Slice Namecode
                                                                                                      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())
                                                                                                      104. Patient.extension:patient-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
                                                                                                      Typestring
                                                                                                      Is Modifierfalse
                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                      Summaryfalse
                                                                                                      106. Patient.extension:patient-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
                                                                                                      • 108. Patient.extension:patient-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
                                                                                                        Must Supporttrue
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        Fixed Valuecode
                                                                                                        110. Patient.extension:patient-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).

                                                                                                        ShortValue of extension
                                                                                                        Control1..1
                                                                                                        BindingThe codes SHOULD be taken from CountryValueSet
                                                                                                        (preferred to http://hl7.org/fhir/ValueSet/country)
                                                                                                        TypeCodeableConcept
                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                        Is Modifierfalse
                                                                                                        Must Supporttrue
                                                                                                        Summaryfalse
                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                        112. Patient.extension:patient-citizenship.extension:code.value[x].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
                                                                                                        Typestring
                                                                                                        Is Modifierfalse
                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                        Summaryfalse
                                                                                                        114. Patient.extension:patient-citizenship.extension:code.value[x].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 manageable, 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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                        • value @ url
                                                                                                        • 116. Patient.extension:patient-citizenship.extension:code.value[x].coding
                                                                                                          Definition

                                                                                                          A reference to a code defined by a terminology system.

                                                                                                          ShortCode defined by a terminology system
                                                                                                          Comments

                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                          Control0..*
                                                                                                          TypeCoding
                                                                                                          Is Modifierfalse
                                                                                                          Must Supporttrue
                                                                                                          Summarytrue
                                                                                                          Requirements

                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                          118. Patient.extension:patient-citizenship.extension:code.value[x].coding.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
                                                                                                          Typestring
                                                                                                          Is Modifierfalse
                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                          Summaryfalse
                                                                                                          120. Patient.extension:patient-citizenship.extension:code.value[x].coding.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 manageable, 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.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                          • value @ url
                                                                                                          • 122. Patient.extension:patient-citizenship.extension:code.value[x].coding.system
                                                                                                            Definition

                                                                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                            ShortIdentity of the terminology system
                                                                                                            Comments

                                                                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                            Control0..1
                                                                                                            Typeuri
                                                                                                            Is Modifierfalse
                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                            Must Supporttrue
                                                                                                            Summarytrue
                                                                                                            Requirements

                                                                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            124. Patient.extension:patient-citizenship.extension:code.value[x].coding.version
                                                                                                            Definition

                                                                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                            ShortVersion of the system - if relevant
                                                                                                            Comments

                                                                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                            Control0..1
                                                                                                            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()))
                                                                                                            126. Patient.extension:patient-citizenship.extension:code.value[x].coding.code
                                                                                                            Definition

                                                                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                            ShortSymbol in syntax defined by the system
                                                                                                            Control0..1
                                                                                                            Typecode
                                                                                                            Is Modifierfalse
                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                            Must Supporttrue
                                                                                                            Summarytrue
                                                                                                            Requirements

                                                                                                            Need to refer to a particular code in the system.

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            128. Patient.extension:patient-citizenship.extension:code.value[x].coding.display
                                                                                                            Definition

                                                                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                            ShortRepresentation defined by the system
                                                                                                            Control0..1
                                                                                                            Typestring
                                                                                                            Is Modifierfalse
                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                            Summarytrue
                                                                                                            Requirements

                                                                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            130. Patient.extension:patient-citizenship.extension:code.value[x].coding.userSelected
                                                                                                            Definition

                                                                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                            ShortIf this coding was chosen directly by the user
                                                                                                            Comments

                                                                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            132. Patient.extension:patient-citizenship.extension:code.value[x].text
                                                                                                            Definition

                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                            ShortPlain text representation of the concept
                                                                                                            Comments

                                                                                                            Very often the text is the same as a displayName of one of the codings.

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

                                                                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                            134. Patient.extension:patient-citizenship.extension:period
                                                                                                            Slice Nameperiod
                                                                                                            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())
                                                                                                            136. Patient.extension:patient-citizenship.extension:period.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
                                                                                                            Typestring
                                                                                                            Is Modifierfalse
                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                            Summaryfalse
                                                                                                            138. Patient.extension:patient-citizenship.extension:period.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
                                                                                                            • 140. Patient.extension:patient-citizenship.extension:period.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
                                                                                                              Must Supporttrue
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              Fixed Valueperiod
                                                                                                              142. Patient.extension:patient-citizenship.extension:period.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
                                                                                                              TypePeriod
                                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                              Is Modifierfalse
                                                                                                              Must Supporttrue
                                                                                                              Summaryfalse
                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                              144. Patient.extension:patient-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
                                                                                                              Must Supporttrue
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-citizenship
                                                                                                              146. Patient.extension:patient-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
                                                                                                              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                                                                                                              148. Patient.extension:patient-nationality
                                                                                                              Slice Namepatient-nationality
                                                                                                              Definition

                                                                                                              The nationality of the patient.

                                                                                                              Control0..*
                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                              TypeExtension(Patient Nationality) (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())
                                                                                                              150. Patient.extension:patient-nationality.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
                                                                                                              Typestring
                                                                                                              Is Modifierfalse
                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                              Summaryfalse
                                                                                                              152. Patient.extension:patient-nationality.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 manageable, 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
                                                                                                              • 154. Patient.extension:patient-nationality.extension:code
                                                                                                                Slice Namecode
                                                                                                                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())
                                                                                                                156. Patient.extension:patient-nationality.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
                                                                                                                Typestring
                                                                                                                Is Modifierfalse
                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                Summaryfalse
                                                                                                                158. Patient.extension:patient-nationality.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
                                                                                                                • 160. Patient.extension:patient-nationality.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
                                                                                                                  Must Supporttrue
                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                  Summaryfalse
                                                                                                                  Fixed Valuecode
                                                                                                                  162. Patient.extension:patient-nationality.extension:code.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
                                                                                                                  TypeCodeableConcept
                                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                  Is Modifierfalse
                                                                                                                  Must Supporttrue
                                                                                                                  Summaryfalse
                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                  164. Patient.extension:patient-nationality.extension:code.value[x].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
                                                                                                                  Typestring
                                                                                                                  Is Modifierfalse
                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                  Summaryfalse
                                                                                                                  166. Patient.extension:patient-nationality.extension:code.value[x].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 manageable, 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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                  • value @ url
                                                                                                                  • 168. Patient.extension:patient-nationality.extension:code.value[x].coding
                                                                                                                    Definition

                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                    ShortCode defined by a terminology system
                                                                                                                    Comments

                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                    Control0..*
                                                                                                                    TypeCoding
                                                                                                                    Is Modifierfalse
                                                                                                                    Must Supporttrue
                                                                                                                    Summarytrue
                                                                                                                    Requirements

                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                    170. Patient.extension:patient-nationality.extension:code.value[x].coding.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
                                                                                                                    Typestring
                                                                                                                    Is Modifierfalse
                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                    Summaryfalse
                                                                                                                    172. Patient.extension:patient-nationality.extension:code.value[x].coding.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 manageable, 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.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                    • value @ url
                                                                                                                    • 174. Patient.extension:patient-nationality.extension:code.value[x].coding.system
                                                                                                                      Definition

                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                      ShortIdentity of the terminology system
                                                                                                                      Comments

                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                      Control0..1
                                                                                                                      Typeuri
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supporttrue
                                                                                                                      Summarytrue
                                                                                                                      Requirements

                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      176. Patient.extension:patient-nationality.extension:code.value[x].coding.version
                                                                                                                      Definition

                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                      Comments

                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                      Control0..1
                                                                                                                      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()))
                                                                                                                      178. Patient.extension:patient-nationality.extension:code.value[x].coding.code
                                                                                                                      Definition

                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                      Control0..1
                                                                                                                      Typecode
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Must Supporttrue
                                                                                                                      Summarytrue
                                                                                                                      Requirements

                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      180. Patient.extension:patient-nationality.extension:code.value[x].coding.display
                                                                                                                      Definition

                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                      ShortRepresentation defined by the system
                                                                                                                      Control0..1
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                      Summarytrue
                                                                                                                      Requirements

                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      182. Patient.extension:patient-nationality.extension:code.value[x].coding.userSelected
                                                                                                                      Definition

                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                      Comments

                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      184. Patient.extension:patient-nationality.extension:code.value[x].text
                                                                                                                      Definition

                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                      ShortPlain text representation of the concept
                                                                                                                      Comments

                                                                                                                      Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                      186. Patient.extension:patient-nationality.extension:period
                                                                                                                      Slice Nameperiod
                                                                                                                      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())
                                                                                                                      188. Patient.extension:patient-nationality.extension:period.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
                                                                                                                      Typestring
                                                                                                                      Is Modifierfalse
                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                      Summaryfalse
                                                                                                                      190. Patient.extension:patient-nationality.extension:period.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
                                                                                                                      • 192. Patient.extension:patient-nationality.extension:period.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
                                                                                                                        Must Supporttrue
                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                        Summaryfalse
                                                                                                                        Fixed Valueperiod
                                                                                                                        194. Patient.extension:patient-nationality.extension:period.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
                                                                                                                        TypePeriod
                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                        Is Modifierfalse
                                                                                                                        Must Supporttrue
                                                                                                                        Summaryfalse
                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                        196. Patient.extension:patient-nationality.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
                                                                                                                        Must Supporttrue
                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                        Summaryfalse
                                                                                                                        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/patient-nationality
                                                                                                                        198. Patient.extension:patient-nationality.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
                                                                                                                        TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                                                                                                                        200. Patient.extension:recordedSexOrGender
                                                                                                                        Slice NamerecordedSexOrGender
                                                                                                                        Definition

                                                                                                                        A sex or gender property for the individual from a document or other record

                                                                                                                        Control0..*
                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                        TypeExtension(Person Recorded Sex Or Gender) (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())
                                                                                                                        202. Patient.extension:recordedSexOrGender.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
                                                                                                                        Typestring
                                                                                                                        Is Modifierfalse
                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                        Summaryfalse
                                                                                                                        204. Patient.extension:recordedSexOrGender.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 manageable, 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.

                                                                                                                        Control1..*
                                                                                                                        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
                                                                                                                        • 206. Patient.extension:recordedSexOrGender.extension:value
                                                                                                                          Slice Namevalue
                                                                                                                          Definition

                                                                                                                          An Extension

                                                                                                                          ShortExtension
                                                                                                                          Control1..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())
                                                                                                                          208. Patient.extension:recordedSexOrGender.extension:value.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
                                                                                                                          Typestring
                                                                                                                          Is Modifierfalse
                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                          Summaryfalse
                                                                                                                          210. Patient.extension:recordedSexOrGender.extension:value.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
                                                                                                                          • 212. Patient.extension:recordedSexOrGender.extension:value.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
                                                                                                                            Must Supporttrue
                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                            Summaryfalse
                                                                                                                            Fixed Valuevalue
                                                                                                                            214. Patient.extension:recordedSexOrGender.extension:value.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
                                                                                                                            BindingThe codes SHOULD be taken from MII VS Person Recorded Sex or Gender SNOMED
                                                                                                                            (preferred to https://www.medizininformatik-initiative.de/fhir/modul-person/ValueSet/mii-vs-person-recordedsexorgender-snomed)
                                                                                                                            TypeCodeableConcept
                                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                            Is Modifierfalse
                                                                                                                            Must Supporttrue
                                                                                                                            Summaryfalse
                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                            216. Patient.extension:recordedSexOrGender.extension:value.value[x].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
                                                                                                                            Typestring
                                                                                                                            Is Modifierfalse
                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                            Summaryfalse
                                                                                                                            218. Patient.extension:recordedSexOrGender.extension:value.value[x].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 manageable, 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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                            • value @ url
                                                                                                                            • 220. Patient.extension:recordedSexOrGender.extension:value.value[x].coding
                                                                                                                              Definition

                                                                                                                              A reference to a code defined by a terminology system.

                                                                                                                              ShortCode defined by a terminology system
                                                                                                                              Comments

                                                                                                                              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                              Control0..*
                                                                                                                              TypeCoding
                                                                                                                              Is Modifierfalse
                                                                                                                              Must Supporttrue
                                                                                                                              Summarytrue
                                                                                                                              Requirements

                                                                                                                              Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                              222. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.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
                                                                                                                              Typestring
                                                                                                                              Is Modifierfalse
                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                              Summaryfalse
                                                                                                                              224. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.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 manageable, 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.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                              • value @ url
                                                                                                                              • 226. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.system
                                                                                                                                Definition

                                                                                                                                The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                ShortIdentity of the terminology system
                                                                                                                                Comments

                                                                                                                                The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                Control0..1
                                                                                                                                Typeuri
                                                                                                                                Is Modifierfalse
                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Requirements

                                                                                                                                Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                228. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.version
                                                                                                                                Definition

                                                                                                                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                ShortVersion of the system - if relevant
                                                                                                                                Comments

                                                                                                                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                Control0..1
                                                                                                                                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()))
                                                                                                                                230. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.code
                                                                                                                                Definition

                                                                                                                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                ShortSymbol in syntax defined by the system
                                                                                                                                Control0..1
                                                                                                                                Typecode
                                                                                                                                Is Modifierfalse
                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                Must Supporttrue
                                                                                                                                Summarytrue
                                                                                                                                Requirements

                                                                                                                                Need to refer to a particular code in the system.

                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                232. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.display
                                                                                                                                Definition

                                                                                                                                A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                ShortRepresentation defined by the system
                                                                                                                                Control0..1
                                                                                                                                Typestring
                                                                                                                                Is Modifierfalse
                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                Summarytrue
                                                                                                                                Requirements

                                                                                                                                Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                234. Patient.extension:recordedSexOrGender.extension:value.value[x].coding.userSelected
                                                                                                                                Definition

                                                                                                                                Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                ShortIf this coding was chosen directly by the user
                                                                                                                                Comments

                                                                                                                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                                                                                A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                ShortPlain text representation of the concept
                                                                                                                                Comments

                                                                                                                                Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                                The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                238. Patient.extension:recordedSexOrGender.extension:type
                                                                                                                                Slice Nametype
                                                                                                                                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())
                                                                                                                                240. Patient.extension:recordedSexOrGender.extension:type.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
                                                                                                                                Typestring
                                                                                                                                Is Modifierfalse
                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                Summaryfalse
                                                                                                                                242. Patient.extension:recordedSexOrGender.extension:type.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
                                                                                                                                • 244. Patient.extension:recordedSexOrGender.extension:type.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
                                                                                                                                  Must Supporttrue
                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                  Summaryfalse
                                                                                                                                  Fixed Valuetype
                                                                                                                                  246. Patient.extension:recordedSexOrGender.extension:type.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
                                                                                                                                  BindingFor example codes, see Recorded Sex Or Gender Type
                                                                                                                                  (example to http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type)
                                                                                                                                  TypeCodeableConcept
                                                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                  Is Modifierfalse
                                                                                                                                  Must Supporttrue
                                                                                                                                  Summaryfalse
                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                  248. Patient.extension:recordedSexOrGender.extension:type.value[x].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
                                                                                                                                  Typestring
                                                                                                                                  Is Modifierfalse
                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                  Summaryfalse
                                                                                                                                  250. Patient.extension:recordedSexOrGender.extension:type.value[x].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 manageable, 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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                  • value @ url
                                                                                                                                  • 252. Patient.extension:recordedSexOrGender.extension:type.value[x].coding
                                                                                                                                    Definition

                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                    Comments

                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                    Control0..*
                                                                                                                                    TypeCoding
                                                                                                                                    Is Modifierfalse
                                                                                                                                    Must Supporttrue
                                                                                                                                    Summarytrue
                                                                                                                                    Requirements

                                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                    254. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.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
                                                                                                                                    Typestring
                                                                                                                                    Is Modifierfalse
                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                    Summaryfalse
                                                                                                                                    256. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.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 manageable, 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.value[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                    • value @ url
                                                                                                                                    • 258. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.system
                                                                                                                                      Definition

                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                      Comments

                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                      Control0..1
                                                                                                                                      Typeuri
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      260. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.version
                                                                                                                                      Definition

                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                      Comments

                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                      Control0..1
                                                                                                                                      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()))
                                                                                                                                      262. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.code
                                                                                                                                      Definition

                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                      Control0..1
                                                                                                                                      Typecode
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Must Supporttrue
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      264. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.display
                                                                                                                                      Definition

                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                      Control0..1
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                      Summarytrue
                                                                                                                                      Requirements

                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      266. Patient.extension:recordedSexOrGender.extension:type.value[x].coding.userSelected
                                                                                                                                      Definition

                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                      Comments

                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      268. Patient.extension:recordedSexOrGender.extension:type.value[x].text
                                                                                                                                      Definition

                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                      Comments

                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                      270. Patient.extension:recordedSexOrGender.extension:effectivePeriod
                                                                                                                                      Slice NameeffectivePeriod
                                                                                                                                      Definition

                                                                                                                                      The time period during which the recorded sex or gender value applies to the individual

                                                                                                                                      ShortWhen the recorded sex or gender value applies
                                                                                                                                      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())
                                                                                                                                      272. Patient.extension:recordedSexOrGender.extension:effectivePeriod.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
                                                                                                                                      Typestring
                                                                                                                                      Is Modifierfalse
                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                      Summaryfalse
                                                                                                                                      274. Patient.extension:recordedSexOrGender.extension:effectivePeriod.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
                                                                                                                                      • 276. Patient.extension:recordedSexOrGender.extension:effectivePeriod.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 ValueeffectivePeriod
                                                                                                                                        278. Patient.extension:recordedSexOrGender.extension:effectivePeriod.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..1
                                                                                                                                        TypePeriod
                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                        Is Modifierfalse
                                                                                                                                        Summaryfalse
                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                        280. Patient.extension:recordedSexOrGender.extension:acquisitionDate
                                                                                                                                        Slice NameacquisitionDate
                                                                                                                                        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())
                                                                                                                                        282. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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
                                                                                                                                        Typestring
                                                                                                                                        Is Modifierfalse
                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                        Summaryfalse
                                                                                                                                        284. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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
                                                                                                                                        • 286. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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
                                                                                                                                          Must Supporttrue
                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                          Summaryfalse
                                                                                                                                          Fixed ValueacquisitionDate
                                                                                                                                          288. Patient.extension:recordedSexOrGender.extension:acquisitionDate.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
                                                                                                                                          TypedateTime
                                                                                                                                          [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
                                                                                                                                          Must Supporttrue
                                                                                                                                          Summaryfalse
                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                          290. Patient.extension:recordedSexOrGender.extension:source
                                                                                                                                          Slice Namesource
                                                                                                                                          Definition

                                                                                                                                          A reference to the source of the Recorded Sex or Gender value.

                                                                                                                                          ShortThe source of the Recorded Sex or Gender value.
                                                                                                                                          Comments

                                                                                                                                          Unlike the sourceDocument element, this element can reference non-document sources including applications, organisations or individuals. For example, if the Recored Sex or Gender value is recorded in a national patient identifier system this element may reference that system. This element can also be the source of the document referred to in the sourceDocument element. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.

                                                                                                                                          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())
                                                                                                                                          292. Patient.extension:recordedSexOrGender.extension:source.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
                                                                                                                                          Typestring
                                                                                                                                          Is Modifierfalse
                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                          Summaryfalse
                                                                                                                                          294. Patient.extension:recordedSexOrGender.extension:source.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
                                                                                                                                          • 296. Patient.extension:recordedSexOrGender.extension:source.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 Valuesource
                                                                                                                                            298. Patient.extension:recordedSexOrGender.extension:source.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
                                                                                                                                            TypeChoice of: CodeableConcept, Reference(Organization, Device, RelatedPerson, Practitioner)
                                                                                                                                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                            Is Modifierfalse
                                                                                                                                            Summaryfalse
                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                            300. Patient.extension:recordedSexOrGender.extension:sourceDocument
                                                                                                                                            Slice NamesourceDocument
                                                                                                                                            Definition

                                                                                                                                            The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.

                                                                                                                                            ShortThe document the sex or gender property was acquired from.
                                                                                                                                            Comments

                                                                                                                                            For example, if a driver's license is scanned, this property may reference that scanned document. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.

                                                                                                                                            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())
                                                                                                                                            302. Patient.extension:recordedSexOrGender.extension:sourceDocument.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
                                                                                                                                            Typestring
                                                                                                                                            Is Modifierfalse
                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                            Summaryfalse
                                                                                                                                            304. Patient.extension:recordedSexOrGender.extension:sourceDocument.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
                                                                                                                                            • 306. Patient.extension:recordedSexOrGender.extension:sourceDocument.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 ValuesourceDocument
                                                                                                                                              308. Patient.extension:recordedSexOrGender.extension:sourceDocument.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
                                                                                                                                              TypeChoice of: CodeableConcept, Reference(DocumentReference)
                                                                                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                              Is Modifierfalse
                                                                                                                                              Summaryfalse
                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                              310. Patient.extension:recordedSexOrGender.extension:sourceField
                                                                                                                                              Slice NamesourceField
                                                                                                                                              Definition

                                                                                                                                              The name of the field within the source document where this sex or gender property is initially recorded.

                                                                                                                                              ShortThe name of the field within the source document where this sex or gender property is initially recorded.
                                                                                                                                              Comments

                                                                                                                                              For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided. If the semantics of the field are known, they may be described in the comment. For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.

                                                                                                                                              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())
                                                                                                                                              312. Patient.extension:recordedSexOrGender.extension:sourceField.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
                                                                                                                                              Typestring
                                                                                                                                              Is Modifierfalse
                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                              Summaryfalse
                                                                                                                                              314. Patient.extension:recordedSexOrGender.extension:sourceField.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
                                                                                                                                              • 316. Patient.extension:recordedSexOrGender.extension:sourceField.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 ValuesourceField
                                                                                                                                                318. Patient.extension:recordedSexOrGender.extension:sourceField.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
                                                                                                                                                Typestring
                                                                                                                                                [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
                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                320. Patient.extension:recordedSexOrGender.extension:jurisdiction
                                                                                                                                                Slice Namejurisdiction
                                                                                                                                                Definition

                                                                                                                                                Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired.

                                                                                                                                                ShortWho issued the document where the sex or gender was aquired
                                                                                                                                                Comments

                                                                                                                                                For example, a individual's driver's license or passport would be issued by a specific state or country.

                                                                                                                                                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())
                                                                                                                                                322. Patient.extension:recordedSexOrGender.extension:jurisdiction.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
                                                                                                                                                Typestring
                                                                                                                                                Is Modifierfalse
                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                Summaryfalse
                                                                                                                                                324. Patient.extension:recordedSexOrGender.extension:jurisdiction.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
                                                                                                                                                • 326. Patient.extension:recordedSexOrGender.extension:jurisdiction.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 Valuejurisdiction
                                                                                                                                                  328. Patient.extension:recordedSexOrGender.extension:jurisdiction.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
                                                                                                                                                  BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
                                                                                                                                                  (extensible to http://terminology.hl7.org/ValueSet/jurisdiction)
                                                                                                                                                  TypeCodeableConcept
                                                                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  Summaryfalse
                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                  330. Patient.extension:recordedSexOrGender.extension:comment
                                                                                                                                                  Slice Namecomment
                                                                                                                                                  Definition

                                                                                                                                                  Further explanation about the context or source of the recorded sex or gender value

                                                                                                                                                  ShortContext or source information about the recorded sex or gender
                                                                                                                                                  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())
                                                                                                                                                  332. Patient.extension:recordedSexOrGender.extension:comment.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
                                                                                                                                                  Typestring
                                                                                                                                                  Is Modifierfalse
                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                  Summaryfalse
                                                                                                                                                  334. Patient.extension:recordedSexOrGender.extension:comment.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
                                                                                                                                                  • 336. Patient.extension:recordedSexOrGender.extension:comment.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 Valuecomment
                                                                                                                                                    338. Patient.extension:recordedSexOrGender.extension:comment.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
                                                                                                                                                    Typestring
                                                                                                                                                    [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
                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                    340. Patient.extension:recordedSexOrGender.extension:genderElementQualifier
                                                                                                                                                    Slice NamegenderElementQualifier
                                                                                                                                                    Definition

                                                                                                                                                    Instances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context.

                                                                                                                                                    ShortWhether this recorded sex or gender value qualifies the .gender element.
                                                                                                                                                    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())
                                                                                                                                                    342. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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
                                                                                                                                                    Typestring
                                                                                                                                                    Is Modifierfalse
                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                    Summaryfalse
                                                                                                                                                    344. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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
                                                                                                                                                    • 346. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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 ValuegenderElementQualifier
                                                                                                                                                      348. Patient.extension:recordedSexOrGender.extension:genderElementQualifier.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
                                                                                                                                                      Typeboolean
                                                                                                                                                      [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
                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                      350. Patient.extension:recordedSexOrGender.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
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                      Summaryfalse
                                                                                                                                                      Fixed Valuehttp://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
                                                                                                                                                      352. Patient.extension:recordedSexOrGender.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
                                                                                                                                                      TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, 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()))
                                                                                                                                                      354. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                                                                                                                                      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
                                                                                                                                                      Summaryfalse
                                                                                                                                                      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())
                                                                                                                                                      356. Patient.identifier
                                                                                                                                                      Definition

                                                                                                                                                      Ein Identifikator für den/die Patient*in

                                                                                                                                                      ShortPatienten-Identifikator
                                                                                                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                      Control0..*
                                                                                                                                                      TypeIdentifier
                                                                                                                                                      Is Modifierfalse
                                                                                                                                                      Must Supporttrue
                                                                                                                                                      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:
                                                                                                                                                      • pattern @ $this
                                                                                                                                                      • 358. Patient.identifier:versichertenId
                                                                                                                                                        Slice NameversichertenId
                                                                                                                                                        Definition

                                                                                                                                                        Krankenversichertennummer, unabhängig, ob GKV, PKV oder Sonderkostenträger

                                                                                                                                                        ShortKrankenversichertennummer
                                                                                                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                        Control0..1
                                                                                                                                                        TypeIdentifier(Identifier-Profil für die 10-stellige Krankenversichertennummer)
                                                                                                                                                        Is Modifierfalse
                                                                                                                                                        Must Supporttrue
                                                                                                                                                        Summarytrue
                                                                                                                                                        Requirements

                                                                                                                                                        Patients are almost always assigned specific numerical identifiers.

                                                                                                                                                        Pattern Value{
                                                                                                                                                          "type" : {
                                                                                                                                                            "coding" : [{
                                                                                                                                                              "system" : "http://fhir.de/CodeSystem/identifier-type-de-basis",
                                                                                                                                                              "code" : "KVZ10"
                                                                                                                                                            }]
                                                                                                                                                          }
                                                                                                                                                        }
                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                        360. Patient.identifier:versichertenId.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
                                                                                                                                                        Typestring
                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                        362. Patient.identifier:versichertenId.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 manageable, 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..*
                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                        TypeExtension
                                                                                                                                                        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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                        • value @ url
                                                                                                                                                        • 364. Patient.identifier:versichertenId.use
                                                                                                                                                          Definition

                                                                                                                                                          The purpose of this identifier.

                                                                                                                                                          Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                          Comments

                                                                                                                                                          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                          Control0..1
                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                          BindingThe codes SHALL be taken from IdentifierUse
                                                                                                                                                          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                                                                                          Identifies the purpose for this identifier, if known .

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

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

                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          366. Patient.identifier:versichertenId.type
                                                                                                                                                          Definition

                                                                                                                                                          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                          ShortDescription of identifier
                                                                                                                                                          Comments

                                                                                                                                                          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                          Control1..1
                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                          BindingThe codes SHALL be taken from Identifier Type Kvid DeBasis ValueSet
                                                                                                                                                          (required to http://fhir.de/ValueSet/identifier-type-kvid-de-basis)

                                                                                                                                                          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                          TypeCodeableConcept
                                                                                                                                                          Must Supporttrue
                                                                                                                                                          Summarytrue
                                                                                                                                                          Requirements

                                                                                                                                                          Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                          kvid-2: Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden (($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not())
                                                                                                                                                          368. Patient.identifier:versichertenId.type.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
                                                                                                                                                          Typestring
                                                                                                                                                          Is Modifierfalse
                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                          Summaryfalse
                                                                                                                                                          370. Patient.identifier:versichertenId.type.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 manageable, 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.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                          • value @ url
                                                                                                                                                          • 372. Patient.identifier:versichertenId.type.coding
                                                                                                                                                            Definition

                                                                                                                                                            A reference to a code defined by a terminology system.

                                                                                                                                                            ShortCode defined by a terminology system
                                                                                                                                                            Comments

                                                                                                                                                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                            Control0..*
                                                                                                                                                            TypeCoding
                                                                                                                                                            Is Modifierfalse
                                                                                                                                                            Must Supporttrue
                                                                                                                                                            Summarytrue
                                                                                                                                                            Requirements

                                                                                                                                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                            374. Patient.identifier:versichertenId.type.coding.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
                                                                                                                                                            Typestring
                                                                                                                                                            Is Modifierfalse
                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                            Summaryfalse
                                                                                                                                                            376. Patient.identifier:versichertenId.type.coding.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 manageable, 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.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                            • value @ url
                                                                                                                                                            • 378. Patient.identifier:versichertenId.type.coding.system
                                                                                                                                                              Definition

                                                                                                                                                              The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                              ShortIdentity of the terminology system
                                                                                                                                                              Comments

                                                                                                                                                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                              Control0..1
                                                                                                                                                              Typeuri
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              380. Patient.identifier:versichertenId.type.coding.version
                                                                                                                                                              Definition

                                                                                                                                                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                              ShortVersion of the system - if relevant
                                                                                                                                                              Comments

                                                                                                                                                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                              Control0..1
                                                                                                                                                              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()))
                                                                                                                                                              382. Patient.identifier:versichertenId.type.coding.code
                                                                                                                                                              Definition

                                                                                                                                                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                              ShortSymbol in syntax defined by the system
                                                                                                                                                              Control0..1
                                                                                                                                                              Typecode
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Need to refer to a particular code in the system.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              384. Patient.identifier:versichertenId.type.coding.display
                                                                                                                                                              Definition

                                                                                                                                                              A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                              ShortRepresentation defined by the system
                                                                                                                                                              Control0..1
                                                                                                                                                              Typestring
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              386. Patient.identifier:versichertenId.type.coding.userSelected
                                                                                                                                                              Definition

                                                                                                                                                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                              ShortIf this coding was chosen directly by the user
                                                                                                                                                              Comments

                                                                                                                                                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                                                                                                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                              ShortPlain text representation of the concept
                                                                                                                                                              Comments

                                                                                                                                                              Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                                                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              390. Patient.identifier:versichertenId.system
                                                                                                                                                              Definition

                                                                                                                                                              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                              ShortThe namespace for the identifier value
                                                                                                                                                              Comments

                                                                                                                                                              Identifier.system is always case sensitive.

                                                                                                                                                              Control1..1
                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                              Typeuri
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Requirements

                                                                                                                                                              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                              Fixed Valuehttp://fhir.de/sid/gkv/kvid-10
                                                                                                                                                              ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              392. Patient.identifier:versichertenId.value
                                                                                                                                                              Definition

                                                                                                                                                              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                              ShortThe value that is unique
                                                                                                                                                              Comments

                                                                                                                                                              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                              Control1..1
                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                              Typestring
                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              ExampleGeneral: 123456
                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen (matches('^[A-Z][0-9]{9}$'))
                                                                                                                                                              394. Patient.identifier:versichertenId.period
                                                                                                                                                              Definition

                                                                                                                                                              Time period during which identifier is/was valid for use.

                                                                                                                                                              ShortTime period when id is/was valid for use
                                                                                                                                                              Comments

                                                                                                                                                              A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                              Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                              Control0..1
                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                              TypePeriod
                                                                                                                                                              Summarytrue
                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                              396. Patient.identifier:versichertenId.assigner
                                                                                                                                                              Definition

                                                                                                                                                              Organization that issued/manages the identifier.

                                                                                                                                                              ShortOrganization that issued id (may be just text)
                                                                                                                                                              Comments

                                                                                                                                                              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                              Control1..1
                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                              TypeReference(Organization)
                                                                                                                                                              Must Supporttrue
                                                                                                                                                              Summarytrue
                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                              ref-1: SHALL have a contained resource if a local reference is provided (reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)))
                                                                                                                                                              398. Patient.identifier:versichertenId.assigner.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
                                                                                                                                                              Typestring
                                                                                                                                                              Is Modifierfalse
                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                              Summaryfalse
                                                                                                                                                              400. Patient.identifier:versichertenId.assigner.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 manageable, 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.identifier.assigner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                              • value @ url
                                                                                                                                                              • 402. Patient.identifier:versichertenId.assigner.reference
                                                                                                                                                                Definition

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

                                                                                                                                                                ShortLiteral reference, Relative, internal or absolute URL
                                                                                                                                                                Comments

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

                                                                                                                                                                Control0..1
                                                                                                                                                                This element is affected by the following invariants: ref-1
                                                                                                                                                                Typestring
                                                                                                                                                                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()))
                                                                                                                                                                404. Patient.identifier:versichertenId.assigner.type
                                                                                                                                                                Definition

                                                                                                                                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                                                                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                                                                                                ShortType the reference refers to (e.g. "Patient")
                                                                                                                                                                Comments

                                                                                                                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                                                                                                Control0..1
                                                                                                                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                                                                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                                                                                                Aa resource (or, for logical models, the URI of the logical model).

                                                                                                                                                                Typeuri
                                                                                                                                                                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()))
                                                                                                                                                                406. Patient.identifier:versichertenId.assigner.identifier
                                                                                                                                                                Definition

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

                                                                                                                                                                ShortLogical reference, when literal reference is not known
                                                                                                                                                                Comments

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

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

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

                                                                                                                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                Control1..1
                                                                                                                                                                TypeIdentifier(Identifier-Profil für die Abbildung eines Institutionskennzeichens (IKNR))
                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                Must Supporttrue
                                                                                                                                                                Summarytrue
                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                408. Patient.identifier:versichertenId.assigner.identifier.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
                                                                                                                                                                Typestring
                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                410. Patient.identifier:versichertenId.assigner.identifier.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 manageable, 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..*
                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                TypeExtension
                                                                                                                                                                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.identifier.assigner.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                • value @ url
                                                                                                                                                                • 412. Patient.identifier:versichertenId.assigner.identifier.use
                                                                                                                                                                  Definition

                                                                                                                                                                  The purpose of this identifier.

                                                                                                                                                                  Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                                  Comments

                                                                                                                                                                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                                  Control0..1
                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                  BindingThe codes SHALL be taken from IdentifierUse
                                                                                                                                                                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                                                                                                  Identifies the purpose for this identifier, if known .

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

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

                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  414. Patient.identifier:versichertenId.assigner.identifier.type
                                                                                                                                                                  Definition

                                                                                                                                                                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                  ShortDescription of identifier
                                                                                                                                                                  Comments

                                                                                                                                                                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                                  Control0..1
                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
                                                                                                                                                                  (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

                                                                                                                                                                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                  TypeCodeableConcept
                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                  Summarytrue
                                                                                                                                                                  Requirements

                                                                                                                                                                  Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                                  Pattern Value{
                                                                                                                                                                    "coding" : [{
                                                                                                                                                                      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                                                                                                                                      "code" : "XX"
                                                                                                                                                                    }]
                                                                                                                                                                  }
                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                  416. Patient.identifier:versichertenId.assigner.identifier.type.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
                                                                                                                                                                  Typestring
                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                  Summaryfalse
                                                                                                                                                                  418. Patient.identifier:versichertenId.assigner.identifier.type.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 manageable, 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.identifier.assigner.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                  • value @ url
                                                                                                                                                                  • 420. Patient.identifier:versichertenId.assigner.identifier.type.coding
                                                                                                                                                                    Definition

                                                                                                                                                                    A reference to a code defined by a terminology system.

                                                                                                                                                                    ShortCode defined by a terminology system
                                                                                                                                                                    Comments

                                                                                                                                                                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                    Control0..*
                                                                                                                                                                    TypeCoding
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                    Summarytrue
                                                                                                                                                                    Requirements

                                                                                                                                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                    422. Patient.identifier:versichertenId.assigner.identifier.type.coding.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
                                                                                                                                                                    Typestring
                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                    Summaryfalse
                                                                                                                                                                    424. Patient.identifier:versichertenId.assigner.identifier.type.coding.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 manageable, 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.identifier.assigner.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                    • value @ url
                                                                                                                                                                    • 426. Patient.identifier:versichertenId.assigner.identifier.type.coding.system
                                                                                                                                                                      Definition

                                                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                                                      Comments

                                                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                      Control0..1
                                                                                                                                                                      Typeuri
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Requirements

                                                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      428. Patient.identifier:versichertenId.assigner.identifier.type.coding.version
                                                                                                                                                                      Definition

                                                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                                                      Comments

                                                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                      Control0..1
                                                                                                                                                                      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()))
                                                                                                                                                                      430. Patient.identifier:versichertenId.assigner.identifier.type.coding.code
                                                                                                                                                                      Definition

                                                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                                                      Control0..1
                                                                                                                                                                      Typecode
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Requirements

                                                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      432. Patient.identifier:versichertenId.assigner.identifier.type.coding.display
                                                                                                                                                                      Definition

                                                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                                                      Control0..1
                                                                                                                                                                      Typestring
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Requirements

                                                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      434. Patient.identifier:versichertenId.assigner.identifier.type.coding.userSelected
                                                                                                                                                                      Definition

                                                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                                                      Comments

                                                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      436. Patient.identifier:versichertenId.assigner.identifier.type.text
                                                                                                                                                                      Definition

                                                                                                                                                                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                      ShortPlain text representation of the concept
                                                                                                                                                                      Comments

                                                                                                                                                                      Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                                                                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      438. Patient.identifier:versichertenId.assigner.identifier.system
                                                                                                                                                                      Definition

                                                                                                                                                                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                                      ShortThe namespace for the identifier value
                                                                                                                                                                      Comments

                                                                                                                                                                      Identifier.system is always case sensitive.

                                                                                                                                                                      Control1..1
                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                      Typeuri
                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Requirements

                                                                                                                                                                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                                      Fixed Valuehttp://fhir.de/sid/arge-ik/iknr
                                                                                                                                                                      ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      440. Patient.identifier:versichertenId.assigner.identifier.value
                                                                                                                                                                      Definition

                                                                                                                                                                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                                      ShortThe value that is unique
                                                                                                                                                                      Comments

                                                                                                                                                                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                                      Control1..1
                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                      Typestring
                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      ExampleGeneral: 123456
                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      ik-1: Eine IK muss eine numerische 9-stellige Zeichenkette (mit Prüfziffer) sein (matches('^[0-9]{9}$'))
                                                                                                                                                                      442. Patient.identifier:versichertenId.assigner.identifier.period
                                                                                                                                                                      Definition

                                                                                                                                                                      Time period during which identifier is/was valid for use.

                                                                                                                                                                      ShortTime period when id is/was valid for use
                                                                                                                                                                      Comments

                                                                                                                                                                      A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                                      Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                                      Control0..1
                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                      TypePeriod
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                                      444. Patient.identifier:versichertenId.assigner.identifier.assigner
                                                                                                                                                                      Definition

                                                                                                                                                                      Organization that issued/manages the identifier.

                                                                                                                                                                      ShortOrganization that issued id (may be just text)
                                                                                                                                                                      Comments

                                                                                                                                                                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                                      Control0..1
                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                      TypeReference(Organization)
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      ref-1: SHALL have a contained resource if a local reference is provided (reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)))
                                                                                                                                                                      446. Patient.identifier:versichertenId.assigner.display
                                                                                                                                                                      Definition

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

                                                                                                                                                                      ShortText alternative for the resource
                                                                                                                                                                      Comments

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

                                                                                                                                                                      Control0..1
                                                                                                                                                                      Typestring
                                                                                                                                                                      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()))
                                                                                                                                                                      448. Patient.identifier:pid
                                                                                                                                                                      Slice Namepid
                                                                                                                                                                      Definition

                                                                                                                                                                      Patientenidentifikator innerhalb einer Organisation

                                                                                                                                                                      ShortPatientenidentifikation
                                                                                                                                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                      Control0..*
                                                                                                                                                                      TypeIdentifier(Identifier-Profil für die Abbildung einer Patienten-ID)
                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                      Summarytrue
                                                                                                                                                                      Requirements

                                                                                                                                                                      Patients are almost always assigned specific numerical identifiers.

                                                                                                                                                                      Pattern Value{
                                                                                                                                                                        "type" : {
                                                                                                                                                                          "coding" : [{
                                                                                                                                                                            "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                                                                                                                                            "code" : "MR"
                                                                                                                                                                          }]
                                                                                                                                                                        }
                                                                                                                                                                      }
                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                      450. Patient.identifier:pid.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
                                                                                                                                                                      Typestring
                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                      452. Patient.identifier:pid.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 manageable, 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..*
                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                      TypeExtension
                                                                                                                                                                      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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                      • value @ url
                                                                                                                                                                      • 454. Patient.identifier:pid.use
                                                                                                                                                                        Definition

                                                                                                                                                                        The purpose of this identifier.

                                                                                                                                                                        Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                                        Comments

                                                                                                                                                                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                                        Control0..1
                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                        BindingThe codes SHALL be taken from IdentifierUse
                                                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                                                                                                        Identifies the purpose for this identifier, if known .

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

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

                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        456. Patient.identifier:pid.type
                                                                                                                                                                        Definition

                                                                                                                                                                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                        ShortDescription of identifier
                                                                                                                                                                        Comments

                                                                                                                                                                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                                        Control1..1
                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type DeBasis ValueSet
                                                                                                                                                                        (extensible to http://fhir.de/ValueSet/identifier-type-de-basis)

                                                                                                                                                                        A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                        Summarytrue
                                                                                                                                                                        Requirements

                                                                                                                                                                        Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                                        Pattern Value{
                                                                                                                                                                          "coding" : [{
                                                                                                                                                                            "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                                                                                                                                            "code" : "MR"
                                                                                                                                                                          }]
                                                                                                                                                                        }
                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                        458. Patient.identifier:pid.type.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
                                                                                                                                                                        Typestring
                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                        Summaryfalse
                                                                                                                                                                        460. Patient.identifier:pid.type.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 manageable, 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.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                        • value @ url
                                                                                                                                                                        • 462. Patient.identifier:pid.type.coding
                                                                                                                                                                          Definition

                                                                                                                                                                          A reference to a code defined by a terminology system.

                                                                                                                                                                          ShortCode defined by a terminology system
                                                                                                                                                                          Comments

                                                                                                                                                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                          Control0..*
                                                                                                                                                                          TypeCoding
                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                          Summarytrue
                                                                                                                                                                          Requirements

                                                                                                                                                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                          464. Patient.identifier:pid.type.coding.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
                                                                                                                                                                          Typestring
                                                                                                                                                                          Is Modifierfalse
                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                          Summaryfalse
                                                                                                                                                                          466. Patient.identifier:pid.type.coding.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 manageable, 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.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                          • value @ url
                                                                                                                                                                          • 468. Patient.identifier:pid.type.coding.system
                                                                                                                                                                            Definition

                                                                                                                                                                            The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                            ShortIdentity of the terminology system
                                                                                                                                                                            Comments

                                                                                                                                                                            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                            Control0..1
                                                                                                                                                                            Typeuri
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            470. Patient.identifier:pid.type.coding.version
                                                                                                                                                                            Definition

                                                                                                                                                                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                            ShortVersion of the system - if relevant
                                                                                                                                                                            Comments

                                                                                                                                                                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                            NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                            Control0..1
                                                                                                                                                                            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()))
                                                                                                                                                                            472. Patient.identifier:pid.type.coding.code
                                                                                                                                                                            Definition

                                                                                                                                                                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                            ShortSymbol in syntax defined by the system
                                                                                                                                                                            Control0..1
                                                                                                                                                                            Typecode
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Need to refer to a particular code in the system.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            474. Patient.identifier:pid.type.coding.display
                                                                                                                                                                            Definition

                                                                                                                                                                            A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                            ShortRepresentation defined by the system
                                                                                                                                                                            Control0..1
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            476. Patient.identifier:pid.type.coding.userSelected
                                                                                                                                                                            Definition

                                                                                                                                                                            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                            ShortIf this coding was chosen directly by the user
                                                                                                                                                                            Comments

                                                                                                                                                                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                                                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                                                                                                                            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                            ShortPlain text representation of the concept
                                                                                                                                                                            Comments

                                                                                                                                                                            Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                                                                            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            480. Patient.identifier:pid.system
                                                                                                                                                                            Definition

                                                                                                                                                                            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                                            ShortThe namespace for the identifier value
                                                                                                                                                                            Comments

                                                                                                                                                                            Identifier.system is always case sensitive.

                                                                                                                                                                            Control1..1
                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                            Typeuri
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Requirements

                                                                                                                                                                            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                                            ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            482. Patient.identifier:pid.value
                                                                                                                                                                            Definition

                                                                                                                                                                            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                                            ShortThe value that is unique
                                                                                                                                                                            Comments

                                                                                                                                                                            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                                            Control1..1
                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                            Typestring
                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            ExampleGeneral: 123456
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            484. Patient.identifier:pid.period
                                                                                                                                                                            Definition

                                                                                                                                                                            Time period during which identifier is/was valid for use.

                                                                                                                                                                            ShortTime period when id is/was valid for use
                                                                                                                                                                            Comments

                                                                                                                                                                            A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                                            Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                                            Control0..1
                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                            TypePeriod
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                                            486. Patient.identifier:pid.assigner
                                                                                                                                                                            Definition

                                                                                                                                                                            Organization that issued/manages the identifier.

                                                                                                                                                                            ShortOrganization that issued id (may be just text)
                                                                                                                                                                            Comments

                                                                                                                                                                            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                                            Control0..1
                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                            TypeReference(Organization)
                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                            Summarytrue
                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                            ref-1: SHALL have a contained resource if a local reference is provided (reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource)))
                                                                                                                                                                            488. Patient.identifier:pid.assigner.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
                                                                                                                                                                            Typestring
                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                            Summaryfalse
                                                                                                                                                                            490. Patient.identifier:pid.assigner.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 manageable, 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.identifier.assigner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                            • value @ url
                                                                                                                                                                            • 492. Patient.identifier:pid.assigner.reference
                                                                                                                                                                              Definition

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

                                                                                                                                                                              ShortLiteral reference, Relative, internal or absolute URL
                                                                                                                                                                              Comments

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

                                                                                                                                                                              Control0..1
                                                                                                                                                                              This element is affected by the following invariants: ref-1
                                                                                                                                                                              Typestring
                                                                                                                                                                              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()))
                                                                                                                                                                              494. Patient.identifier:pid.assigner.type
                                                                                                                                                                              Definition

                                                                                                                                                                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                                                                                                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                                                                                                              ShortType the reference refers to (e.g. "Patient")
                                                                                                                                                                              Comments

                                                                                                                                                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                                                                                                                                                              Control0..1
                                                                                                                                                                              BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                                                                                                                                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

                                                                                                                                                                              Aa resource (or, for logical models, the URI of the logical model).

                                                                                                                                                                              Typeuri
                                                                                                                                                                              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()))
                                                                                                                                                                              496. Patient.identifier:pid.assigner.identifier
                                                                                                                                                                              Definition

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

                                                                                                                                                                              ShortLogical reference, when literal reference is not known
                                                                                                                                                                              Comments

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

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

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

                                                                                                                                                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                                                                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                                                                                                              Control0..1
                                                                                                                                                                              TypeIdentifier
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                              Summarytrue
                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                              498. Patient.identifier:pid.assigner.identifier.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
                                                                                                                                                                              Typestring
                                                                                                                                                                              Is Modifierfalse
                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                              Summaryfalse
                                                                                                                                                                              500. Patient.identifier:pid.assigner.identifier.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 manageable, 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.identifier.assigner.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                              • value @ url
                                                                                                                                                                              • 502. Patient.identifier:pid.assigner.identifier.use
                                                                                                                                                                                Definition

                                                                                                                                                                                The purpose of this identifier.

                                                                                                                                                                                Shortusual | official | temp | secondary | old (If known)
                                                                                                                                                                                Comments

                                                                                                                                                                                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                                                                                                                                                Control0..1
                                                                                                                                                                                BindingThe codes SHALL be taken from IdentifierUse
                                                                                                                                                                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                                                                                                                                                                Identifies the purpose for this identifier, if known .

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

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

                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                504. Patient.identifier:pid.assigner.identifier.type
                                                                                                                                                                                Definition

                                                                                                                                                                                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                                ShortDescription of identifier
                                                                                                                                                                                Comments

                                                                                                                                                                                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                                                                                                                                                Control0..1
                                                                                                                                                                                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                                                                                                                                                                (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

                                                                                                                                                                                A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                                                                                                                                                                TypeCodeableConcept
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                Summarytrue
                                                                                                                                                                                Requirements

                                                                                                                                                                                Allows users to make use of identifiers when the identifier system is not known.

                                                                                                                                                                                Pattern Value{
                                                                                                                                                                                  "coding" : [{
                                                                                                                                                                                    "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                                                                                                                                                                                    "code" : "XX"
                                                                                                                                                                                  }]
                                                                                                                                                                                }
                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                506. Patient.identifier:pid.assigner.identifier.type.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
                                                                                                                                                                                Typestring
                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                Summaryfalse
                                                                                                                                                                                508. Patient.identifier:pid.assigner.identifier.type.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 manageable, 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.identifier.assigner.identifier.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                • value @ url
                                                                                                                                                                                • 510. Patient.identifier:pid.assigner.identifier.type.coding
                                                                                                                                                                                  Definition

                                                                                                                                                                                  A reference to a code defined by a terminology system.

                                                                                                                                                                                  ShortCode defined by a terminology system
                                                                                                                                                                                  Comments

                                                                                                                                                                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                                                                                                                                                                  Control0..*
                                                                                                                                                                                  TypeCoding
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                  Summarytrue
                                                                                                                                                                                  Requirements

                                                                                                                                                                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                  512. Patient.identifier:pid.assigner.identifier.type.coding.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
                                                                                                                                                                                  Typestring
                                                                                                                                                                                  Is Modifierfalse
                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                  Summaryfalse
                                                                                                                                                                                  514. Patient.identifier:pid.assigner.identifier.type.coding.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 manageable, 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.identifier.assigner.identifier.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                  • value @ url
                                                                                                                                                                                  • 516. Patient.identifier:pid.assigner.identifier.type.coding.system
                                                                                                                                                                                    Definition

                                                                                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                    ShortIdentity of the terminology system
                                                                                                                                                                                    Comments

                                                                                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    Typeuri
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Requirements

                                                                                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    518. Patient.identifier:pid.assigner.identifier.type.coding.version
                                                                                                                                                                                    Definition

                                                                                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                                                                                    Comments

                                                                                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    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()))
                                                                                                                                                                                    520. Patient.identifier:pid.assigner.identifier.type.coding.code
                                                                                                                                                                                    Definition

                                                                                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    Typecode
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Requirements

                                                                                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    522. Patient.identifier:pid.assigner.identifier.type.coding.display
                                                                                                                                                                                    Definition

                                                                                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                    ShortRepresentation defined by the system
                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    Typestring
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Requirements

                                                                                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    524. Patient.identifier:pid.assigner.identifier.type.coding.userSelected
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                                                                                    Comments

                                                                                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    526. Patient.identifier:pid.assigner.identifier.type.text
                                                                                                                                                                                    Definition

                                                                                                                                                                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                                                                                                                                                                    ShortPlain text representation of the concept
                                                                                                                                                                                    Comments

                                                                                                                                                                                    Very often the text is the same as a displayName of one of the codings.

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

                                                                                                                                                                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    528. Patient.identifier:pid.assigner.identifier.system
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                                                                                                                                                                    ShortThe namespace for the identifier value
                                                                                                                                                                                    Comments

                                                                                                                                                                                    Identifier.system is always case sensitive.

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

                                                                                                                                                                                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                                                                                                                                                                    ExampleGeneral: http://www.acme.com/identifiers/patient
                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    mii-pat-2: Entweder IKNR oder MII Core Location Identifier muss verwendet werden ($this = 'http://fhir.de/sid/arge-ik/iknr' or $this = 'https://www.medizininformatik-initiative.de/fhir/core/CodeSystem/core-location-identifier')
                                                                                                                                                                                    530. Patient.identifier:pid.assigner.identifier.value
                                                                                                                                                                                    Definition

                                                                                                                                                                                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                                                                                                                                                                    ShortThe value that is unique
                                                                                                                                                                                    Comments

                                                                                                                                                                                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    Typestring
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    ExampleGeneral: 123456
                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    532. Patient.identifier:pid.assigner.identifier.period
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Time period during which identifier is/was valid for use.

                                                                                                                                                                                    ShortTime period when id is/was valid for use
                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    TypePeriod
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    534. Patient.identifier:pid.assigner.identifier.assigner
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Organization that issued/manages the identifier.

                                                                                                                                                                                    ShortOrganization that issued id (may be just text)
                                                                                                                                                                                    Comments

                                                                                                                                                                                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    TypeReference(Organization)
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                    536. Patient.identifier:pid.assigner.display
                                                                                                                                                                                    Definition

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

                                                                                                                                                                                    ShortText alternative for the resource
                                                                                                                                                                                    Comments

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

                                                                                                                                                                                    Control0..1
                                                                                                                                                                                    Typestring
                                                                                                                                                                                    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()))
                                                                                                                                                                                    538. 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..1
                                                                                                                                                                                    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
                                                                                                                                                                                    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()))
                                                                                                                                                                                    540. Patient.name
                                                                                                                                                                                    Definition

                                                                                                                                                                                    Name der Patientin oder des Patienten

                                                                                                                                                                                    ShortName
                                                                                                                                                                                    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.

                                                                                                                                                                                    Control0..*
                                                                                                                                                                                    TypeHumanName
                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                    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()))
                                                                                                                                                                                    SlicingThis element introduces a set of slices on Patient.name. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                    • pattern @ $this
                                                                                                                                                                                    • 542. Patient.name:name
                                                                                                                                                                                      Slice Namename
                                                                                                                                                                                      Definition

                                                                                                                                                                                      Personenname mit in Deutschland üblichen Namensbestandteilen

                                                                                                                                                                                      ShortPersonenname
                                                                                                                                                                                      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.

                                                                                                                                                                                      Control0..1
                                                                                                                                                                                      TypeHumanName(HumanName, deutsches Basisprofil)
                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                      Requirements

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

                                                                                                                                                                                      Pattern Value{
                                                                                                                                                                                        "use" : "official"
                                                                                                                                                                                      }
                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                      544. Patient.name: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
                                                                                                                                                                                      Typestring
                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                      546. Patient.name:name.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 manageable, 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..*
                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                      TypeExtension
                                                                                                                                                                                      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
                                                                                                                                                                                      • 548. Patient.name: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.

                                                                                                                                                                                        Control1..1
                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                        BindingThe codes SHALL be taken from NameUse
                                                                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                                                                                                                                                        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
                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                        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()))
                                                                                                                                                                                        550. Patient.name: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..1
                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                        Typestring
                                                                                                                                                                                        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()))
                                                                                                                                                                                        552. Patient.name:name.family
                                                                                                                                                                                        Definition

                                                                                                                                                                                        Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.

                                                                                                                                                                                        ShortFamilienname
                                                                                                                                                                                        Comments

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

                                                                                                                                                                                        Control1..1
                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                        Typestring
                                                                                                                                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                        Alternate Namessurname
                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                        554. Patient.name:name.family.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
                                                                                                                                                                                        Typestring
                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                        556. Patient.name:name.family.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 manageable, 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..*
                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                        TypeExtension
                                                                                                                                                                                        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.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                        • value @ url
                                                                                                                                                                                        • 558. Patient.name:name.family.extension:namenszusatz
                                                                                                                                                                                          Slice Namenamenszusatz
                                                                                                                                                                                          Definition

                                                                                                                                                                                          Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

                                                                                                                                                                                          ShortNamenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
                                                                                                                                                                                          Comments

                                                                                                                                                                                          Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.

                                                                                                                                                                                          Control0..1
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          TypeExtension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string)
                                                                                                                                                                                          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())
                                                                                                                                                                                          560. Patient.name:name.family.extension:nachname
                                                                                                                                                                                          Slice Namenachname
                                                                                                                                                                                          Definition

                                                                                                                                                                                          The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                                                                                                                                                                          ShortPortion derived from person's own surname
                                                                                                                                                                                          Comments

                                                                                                                                                                                          If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

                                                                                                                                                                                          Control0..1
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          TypeExtension(Own Name) (Extension Type: string)
                                                                                                                                                                                          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())
                                                                                                                                                                                          562. Patient.name:name.family.extension:vorsatzwort
                                                                                                                                                                                          Slice Namevorsatzwort
                                                                                                                                                                                          Definition

                                                                                                                                                                                          The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                                                                                                                                                                          ShortVoorvoegsel derived from person's own surname
                                                                                                                                                                                          Comments

                                                                                                                                                                                          An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.

                                                                                                                                                                                          Control0..1
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          TypeExtension(Own Prefix) (Extension Type: string)
                                                                                                                                                                                          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())
                                                                                                                                                                                          564. Patient.name:name.family.value
                                                                                                                                                                                          Definition

                                                                                                                                                                                          Primitive value for string

                                                                                                                                                                                          ShortPrimitive value for string
                                                                                                                                                                                          Control0..1
                                                                                                                                                                                          Typestring
                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                          Max Length:1048576
                                                                                                                                                                                          566. Patient.name:name.given
                                                                                                                                                                                          Definition

                                                                                                                                                                                          Vorname der Person

                                                                                                                                                                                          ShortVorname
                                                                                                                                                                                          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.

                                                                                                                                                                                          Control1..*
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          Typestring
                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                          Alternate Namesfirst name, middle name
                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                          568. Patient.name:name.prefix
                                                                                                                                                                                          Definition

                                                                                                                                                                                          Namensteile vor dem Vornamen, z.B. akademischer Titel.

                                                                                                                                                                                          ShortNamensteile vor dem Vornamen
                                                                                                                                                                                          Comments

                                                                                                                                                                                          Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                          Control0..*
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          Typestring
                                                                                                                                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                          Must Supporttrue
                                                                                                                                                                                          Summarytrue
                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                          570. Patient.name:name.prefix.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
                                                                                                                                                                                          Typestring
                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                          572. Patient.name:name.prefix.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 manageable, 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..*
                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                          TypeExtension
                                                                                                                                                                                          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.prefix.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                          • value @ url
                                                                                                                                                                                          • 574. Patient.name:name.prefix.extension:prefix-qualifier
                                                                                                                                                                                            Slice Nameprefix-qualifier
                                                                                                                                                                                            Definition

                                                                                                                                                                                            A set of codes each of which specifies a certain subcategory of the name part in addition to the main name part type.

                                                                                                                                                                                            ShortLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | VV
                                                                                                                                                                                            Comments

                                                                                                                                                                                            Used to indicate additional information about the name part and how it should be used.

                                                                                                                                                                                            Control0..1
                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                            TypeExtension(EN Qualifier) (Extension Type: code)
                                                                                                                                                                                            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())
                                                                                                                                                                                            576. Patient.name:name.prefix.value
                                                                                                                                                                                            Definition

                                                                                                                                                                                            Primitive value for string

                                                                                                                                                                                            ShortPrimitive value for string
                                                                                                                                                                                            Control0..1
                                                                                                                                                                                            Typestring
                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                            Max Length:1048576
                                                                                                                                                                                            578. Patient.name:name.suffix
                                                                                                                                                                                            Definition

                                                                                                                                                                                            Namensteile nach dem Nachnamen

                                                                                                                                                                                            ShortNamensteile nach dem Nachnamen
                                                                                                                                                                                            Comments

                                                                                                                                                                                            Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                            Control0..*
                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                            Typestring
                                                                                                                                                                                            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()))
                                                                                                                                                                                            580. Patient.name: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
                                                                                                                                                                                            Comments

                                                                                                                                                                                            A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                                                            Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                                                            Control0..1
                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                            TypePeriod
                                                                                                                                                                                            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()))
                                                                                                                                                                                            per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                                                            582. Patient.name:geburtsname
                                                                                                                                                                                            Slice Namegeburtsname
                                                                                                                                                                                            Definition

                                                                                                                                                                                            Name, der vor einer Namensänderung aufgrund von Heirat verwendet wurde

                                                                                                                                                                                            ShortGeburtsname
                                                                                                                                                                                            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.

                                                                                                                                                                                            Control0..1
                                                                                                                                                                                            TypeHumanName(HumanName, deutsches Basisprofil)
                                                                                                                                                                                            Is Modifierfalse
                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                            Requirements

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

                                                                                                                                                                                            Pattern Value{
                                                                                                                                                                                              "use" : "maiden"
                                                                                                                                                                                            }
                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                            584. Patient.name:geburtsname.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
                                                                                                                                                                                            Typestring
                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                            586. Patient.name:geburtsname.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 manageable, 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..*
                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                            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
                                                                                                                                                                                            • 588. Patient.name:geburtsname.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.

                                                                                                                                                                                              Control1..1
                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                              BindingThe codes SHALL be taken from NameUse
                                                                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1)

                                                                                                                                                                                              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
                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                              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()))
                                                                                                                                                                                              590. Patient.name:geburtsname.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..1
                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                              Typestring
                                                                                                                                                                                              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()))
                                                                                                                                                                                              592. Patient.name:geburtsname.family
                                                                                                                                                                                              Definition

                                                                                                                                                                                              Der vollständige Familienname, einschließlich aller Vorsatz- und Zusatzwörter, mit Leerzeichen getrennt.

                                                                                                                                                                                              ShortFamilienname
                                                                                                                                                                                              Comments

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

                                                                                                                                                                                              Control1..1
                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                              Typestring
                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                              Alternate Namessurname
                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                              594. Patient.name:geburtsname.family.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
                                                                                                                                                                                              Typestring
                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                              596. Patient.name:geburtsname.family.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 manageable, 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..*
                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                              TypeExtension
                                                                                                                                                                                              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.family.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                              • value @ url
                                                                                                                                                                                              • 598. Patient.name:geburtsname.family.extension:namenszusatz
                                                                                                                                                                                                Slice Namenamenszusatz
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Namenszusatz als Bestandteil das Nachnamens, wie in VSDM (Versichertenstammdatenmanagement, "eGK") definiert. Beispiele: Gräfin, Prinz oder Fürst

                                                                                                                                                                                                ShortNamenszusatz gemäß VSDM (Versichertenstammdatenmanagement, "eGK")
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Die Extension wurde erstellt aufgrund der Anforderung, die auf der eGK vorhandenen Patientenstammdaten in FHIR abbilden zu können. Auf der eGK werden die Namensbestandteile "Namenszusatz" und "Vorsatzwort" getrennt vom Nachnamen gespeichert. Anhand der Liste der zulässigen Namenszusätze ist deutlich erkennbar, dass es sich hierbei sinngemäß um Adelstitel handelt. Das Vorsatzwort kann durch die Core-Extension own-prefix (Canonical: http://hl7.org/fhir/StructureDefinition/humanname-own-prefix) abgebildet werden, für den Namenszusatz ergibt sich jedoch die Notwendikeit einer nationalen Extension, da in andern Ländern Adelstitel entweder gar nicht oder als reguläres Namenspräfix erfasst werden.

                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                TypeExtension(Extension zur Erfassung der VSDM Namensbestandteile) (Extension Type: string)
                                                                                                                                                                                                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())
                                                                                                                                                                                                600. Patient.name:geburtsname.family.extension:nachname
                                                                                                                                                                                                Slice Namenachname
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The portion of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                                                                                                                                                                                ShortPortion derived from person's own surname
                                                                                                                                                                                                Comments

                                                                                                                                                                                                If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                TypeExtension(Own Name) (Extension Type: string)
                                                                                                                                                                                                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())
                                                                                                                                                                                                602. Patient.name:geburtsname.family.extension:vorsatzwort
                                                                                                                                                                                                Slice Namevorsatzwort
                                                                                                                                                                                                Definition

                                                                                                                                                                                                The prefix portion (e.g. voorvoegsel) of the family name that is derived from the person's own surname, as distinguished from any portion that is derived from the surname of the person's partner or spouse.

                                                                                                                                                                                                ShortVoorvoegsel derived from person's own surname
                                                                                                                                                                                                Comments

                                                                                                                                                                                                An example of a voorvoegsel is the "van" in "Ludwig van Beethoven". Since the voorvoegsel doesn't sort completely alphabetically, it is reasonable to specify it as a separate sub-component.

                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                TypeExtension(Own Prefix) (Extension Type: string)
                                                                                                                                                                                                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())
                                                                                                                                                                                                604. Patient.name:geburtsname.family.value
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Primitive value for string

                                                                                                                                                                                                ShortPrimitive value for string
                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                Max Length:1048576
                                                                                                                                                                                                606. Patient.name:geburtsname.given
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Vorname der Person

                                                                                                                                                                                                ShortVorname
                                                                                                                                                                                                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
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                Alternate Namesfirst name, middle name
                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                608. Patient.name:geburtsname.prefix
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Namensteile vor dem Vornamen, z.B. akademischer Titel.

                                                                                                                                                                                                ShortNamensteile vor dem Vornamen
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                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()))
                                                                                                                                                                                                614. Patient.name:geburtsname.suffix
                                                                                                                                                                                                Definition

                                                                                                                                                                                                Namensteile nach dem Nachnamen

                                                                                                                                                                                                ShortNamensteile nach dem Nachnamen
                                                                                                                                                                                                Comments

                                                                                                                                                                                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                Control0..*
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                Typestring
                                                                                                                                                                                                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()))
                                                                                                                                                                                                616. Patient.name:geburtsname.period
                                                                                                                                                                                                Definition

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

                                                                                                                                                                                                ShortTime period when name was/is in use
                                                                                                                                                                                                Comments

                                                                                                                                                                                                A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                                                                Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                TypePeriod
                                                                                                                                                                                                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()))
                                                                                                                                                                                                per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                                                                618. 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..*
                                                                                                                                                                                                TypeContactPoint
                                                                                                                                                                                                Is Modifierfalse
                                                                                                                                                                                                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()))
                                                                                                                                                                                                620. Patient.gender
                                                                                                                                                                                                Definition

                                                                                                                                                                                                männlich | weiblich | andere | unbekannt | unbestimmt | divers

                                                                                                                                                                                                ShortAdministratives Geschlecht
                                                                                                                                                                                                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.

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

                                                                                                                                                                                                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
                                                                                                                                                                                                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()))
                                                                                                                                                                                                622. 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
                                                                                                                                                                                                624. 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
                                                                                                                                                                                                • 626. Patient.gender.extension:other-amtlich
                                                                                                                                                                                                  Slice Nameother-amtlich
                                                                                                                                                                                                  Definition

                                                                                                                                                                                                  Extension zur genaueren Differenzierung des administrativen Geschlechts

                                                                                                                                                                                                  ShortExtension Administratives Geschlecht
                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                                                  TypeExtension(Differenzierung des administrativen Geschlechts 'other') (Extension Type: Coding)
                                                                                                                                                                                                  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())
                                                                                                                                                                                                  628. Patient.gender.extension:other-amtlich.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
                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                  630. Patient.gender.extension:other-amtlich.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 manageable, 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..0
                                                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                                                  TypeExtension
                                                                                                                                                                                                  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.gender.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                  • value @ url
                                                                                                                                                                                                  • 632. Patient.gender.extension:other-amtlich.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
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                    Fixed Valuehttp://fhir.de/StructureDefinition/gender-amtlich-de
                                                                                                                                                                                                    634. Patient.gender.extension:other-amtlich.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: ele-1
                                                                                                                                                                                                    BindingThe codes SHALL be taken from GenderOtherDE ValueSet
                                                                                                                                                                                                    (required to http://fhir.de/ValueSet/gender-other-de)
                                                                                                                                                                                                    TypeCoding
                                                                                                                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                    gender-amtlich-1: Die amtliche Differenzierung der Geschlechtsangabe 'other' darf nur gefüllt sein, wenn das Geschlecht 'other' angegeben ist (%resource.where(gender='other').exists())
                                                                                                                                                                                                    636. Patient.gender.extension:other-amtlich.value[x].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
                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                    Is Modifierfalse
                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                    Summaryfalse
                                                                                                                                                                                                    638. Patient.gender.extension:other-amtlich.value[x].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 manageable, 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.gender.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                    • 640. Patient.gender.extension:other-amtlich.value[x].system
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                                                                                      Comments

                                                                                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                      642. Patient.gender.extension:other-amtlich.value[x].version
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                                                                                      Comments

                                                                                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      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()))
                                                                                                                                                                                                      644. Patient.gender.extension:other-amtlich.value[x].code
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      Typecode
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                      646. Patient.gender.extension:other-amtlich.value[x].display
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                      648. Patient.gender.extension:other-amtlich.value[x].userSelected
                                                                                                                                                                                                      Definition

                                                                                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                      Comments

                                                                                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                                                                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

                                                                                                                                                                                                      Primitive value for code

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

                                                                                                                                                                                                      Das Geburtsdatum der Patientin oder des Patienten

                                                                                                                                                                                                      ShortGeburtsdatum
                                                                                                                                                                                                      Comments

                                                                                                                                                                                                      At least an estimated year should be provided as a guess if the real DOB 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..1
                                                                                                                                                                                                      Typedate
                                                                                                                                                                                                      Is Modifierfalse
                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                      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()))
                                                                                                                                                                                                      LOINC Code21112-8
                                                                                                                                                                                                      654. Patient.birthDate.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
                                                                                                                                                                                                      656. Patient.birthDate.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.birthDate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                      • value @ url
                                                                                                                                                                                                      • 658. Patient.birthDate.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
                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                                        TypeExtension(Data Absent Reason) (Extension Type: code)
                                                                                                                                                                                                        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())
                                                                                                                                                                                                        660. Patient.birthDate.value
                                                                                                                                                                                                        Definition

                                                                                                                                                                                                        The actual value

                                                                                                                                                                                                        ShortPrimitive value for date
                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                        Typedate
                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                        662. Patient.deceased[x]
                                                                                                                                                                                                        Definition

                                                                                                                                                                                                        Gibt an, ob die Person verstorben ist oder nicht

                                                                                                                                                                                                        ShortVerstorben
                                                                                                                                                                                                        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..1
                                                                                                                                                                                                        TypeChoice of: boolean, dateTime
                                                                                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                        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 Supporttrue
                                                                                                                                                                                                        Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                                                                                        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
                                                                                                                                                                                                        • 664. 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..1
                                                                                                                                                                                                          Typeboolean
                                                                                                                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                          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 Supporttrue
                                                                                                                                                                                                          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()))
                                                                                                                                                                                                          666. 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..1
                                                                                                                                                                                                          TypedateTime
                                                                                                                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                          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 Supporttrue
                                                                                                                                                                                                          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()))
                                                                                                                                                                                                          668. Patient.address
                                                                                                                                                                                                          Definition

                                                                                                                                                                                                          Eine Adresse der Patientin oder des Patienten

                                                                                                                                                                                                          ShortAdresse
                                                                                                                                                                                                          Comments

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

                                                                                                                                                                                                          Control0..*
                                                                                                                                                                                                          TypeAddress
                                                                                                                                                                                                          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()))
                                                                                                                                                                                                          SlicingThis element introduces a set of slices on Patient.address. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                          • pattern @ $this
                                                                                                                                                                                                          • 670. Patient.address:Strassenanschrift
                                                                                                                                                                                                            Slice NameStrassenanschrift
                                                                                                                                                                                                            Definition

                                                                                                                                                                                                            Eine Straßenanschrift der Patientin oder des Patienten

                                                                                                                                                                                                            ShortStraßenanschrift
                                                                                                                                                                                                            Comments

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

                                                                                                                                                                                                            Control0..*
                                                                                                                                                                                                            TypeAddress(Adresse, deutsches Basisprofil)
                                                                                                                                                                                                            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.

                                                                                                                                                                                                            Pattern Value{
                                                                                                                                                                                                              "type" : "both"
                                                                                                                                                                                                            }
                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                            pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                                                                                                                                                                            672. Patient.address:Strassenanschrift.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
                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                            674. Patient.address:Strassenanschrift.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 manageable, 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..*
                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                                            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
                                                                                                                                                                                                            • 676. Patient.address:Strassenanschrift.extension:Stadtteil
                                                                                                                                                                                                              Slice NameStadtteil
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              A subsection of a municipality.

                                                                                                                                                                                                              Shortprecinct
                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                              TypeExtension(ADXP Precinct) (Extension Type: string)
                                                                                                                                                                                                              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())
                                                                                                                                                                                                              678. Patient.address:Strassenanschrift.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..1
                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                              BindingThe codes SHALL be taken from AddressUse
                                                                                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                                                                                                                                                                              The use of an address.

                                                                                                                                                                                                              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()))
                                                                                                                                                                                                              680. Patient.address:Strassenanschrift.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).

                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                              BindingThe codes SHALL be taken from AddressType
                                                                                                                                                                                                              (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                                                                                                                                                                              The type of an address (physical / postal).

                                                                                                                                                                                                              Typecode
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              ExampleGeneral: both
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              682. Patient.address:Strassenanschrift.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..1
                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              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()))
                                                                                                                                                                                                              684. Patient.address:Strassenanschrift.line
                                                                                                                                                                                                              Definition

                                                                                                                                                                                                              Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postfach strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.

                                                                                                                                                                                                              ShortStraßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
                                                                                                                                                                                                              Comments

                                                                                                                                                                                                              Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                              Control1..3
                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                              ExampleGeneral: 137 Nowhere Street
                                                                                                                                                                                                              Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                              686. Patient.address:Strassenanschrift.line.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
                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                              688. Patient.address:Strassenanschrift.line.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 manageable, 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..*
                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                              TypeExtension
                                                                                                                                                                                                              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.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                              • value @ url
                                                                                                                                                                                                              • 690. Patient.address:Strassenanschrift.line.extension:Strasse
                                                                                                                                                                                                                Slice NameStrasse
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                streetName.

                                                                                                                                                                                                                ShortstreetName
                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                                                                                                                                                                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())
                                                                                                                                                                                                                692. Patient.address:Strassenanschrift.line.extension:Hausnummer
                                                                                                                                                                                                                Slice NameHausnummer
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                                                                                                                                                                                                                ShorthouseNumber
                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                TypeExtension(ADXP House Number) (Extension Type: string)
                                                                                                                                                                                                                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())
                                                                                                                                                                                                                694. Patient.address:Strassenanschrift.line.extension:Adresszusatz
                                                                                                                                                                                                                Slice NameAdresszusatz
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

                                                                                                                                                                                                                ShortadditionalLocator
                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                                                                                                                                                                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())
                                                                                                                                                                                                                696. Patient.address:Strassenanschrift.line.extension:Postfach
                                                                                                                                                                                                                Slice NamePostfach
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                A numbered box located in a post station.

                                                                                                                                                                                                                ShortpostBox
                                                                                                                                                                                                                Control0..0
                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                TypeExtension(ADXP Post Box) (Extension Type: string)
                                                                                                                                                                                                                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())
                                                                                                                                                                                                                698. Patient.address:Strassenanschrift.line.value
                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                Primitive value for string

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

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

                                                                                                                                                                                                                ShortName of city, town etc.
                                                                                                                                                                                                                Comments

                                                                                                                                                                                                                Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                Control1..1
                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                Must Supporttrue
                                                                                                                                                                                                                Summarytrue
                                                                                                                                                                                                                Alternate NamesMunicpality
                                                                                                                                                                                                                ExampleGeneral: Erewhon
                                                                                                                                                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                702. Patient.address:Strassenanschrift.city.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
                                                                                                                                                                                                                704. Patient.address:Strassenanschrift.city.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.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                • value @ url
                                                                                                                                                                                                                • 706. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel
                                                                                                                                                                                                                  Slice Namegemeindeschluessel
                                                                                                                                                                                                                  Definition

                                                                                                                                                                                                                  Optional Extension Element - found in all resources.

                                                                                                                                                                                                                  ShortOptional Extensions Element
                                                                                                                                                                                                                  Control0..1
                                                                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                  TypeExtension(ExtensionDestatisAgs) (Extension Type: Coding)
                                                                                                                                                                                                                  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())
                                                                                                                                                                                                                  708. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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
                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                  710. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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 manageable, 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..0
                                                                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                  TypeExtension
                                                                                                                                                                                                                  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.city.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                  • value @ url
                                                                                                                                                                                                                  • 712. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                    Fixed Valuehttp://fhir.de/StructureDefinition/destatis/ags
                                                                                                                                                                                                                    714. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.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: ele-1
                                                                                                                                                                                                                    TypeCoding
                                                                                                                                                                                                                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                    ExampleAGS Hildesheim: { "system" : "http://fhir.de/sid/destatis/ags", "code" : "03254021" }
                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                    716. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].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
                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                    718. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].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 manageable, 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..*
                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                                                    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.city.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                                    • 720. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].system
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                                      ShortIdentity of the terminology system
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typeuri
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                      Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                                      Fixed Valuehttp://fhir.de/sid/destatis/ags
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      722. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].version
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                                      ShortVersion of the system - if relevant
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      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()))
                                                                                                                                                                                                                      724. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].code
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                                      ShortSymbol in syntax defined by the system
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typecode
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                      Need to refer to a particular code in the system.

                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      ags-extension-1: Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen ($this.matches('^[0-9]{8}$'))
                                                                                                                                                                                                                      726. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].display
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                                      ShortRepresentation defined by the system
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      728. Patient.address:Strassenanschrift.city.extension:gemeindeschluessel.value[x].userSelected
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                                      ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typeboolean
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Requirements

                                                                                                                                                                                                                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      730. Patient.address:Strassenanschrift.city.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
                                                                                                                                                                                                                      732. Patient.address:Strassenanschrift.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
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      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()))
                                                                                                                                                                                                                      734. Patient.address:Strassenanschrift.state
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      Name (oder Kürzel) des Bundeslandes.

                                                                                                                                                                                                                      ShortBundesland
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      BindingThe codes SHOULD be taken from ISO-3166-2:de-Laendercodes
                                                                                                                                                                                                                      (preferred to http://fhir.de/ValueSet/iso/bundeslaender)
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      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()))
                                                                                                                                                                                                                      736. Patient.address:Strassenanschrift.postalCode
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen

                                                                                                                                                                                                                      ShortPostleitzahl
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      Alternate NamesZip
                                                                                                                                                                                                                      ExampleGeneral: 9132
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      738. Patient.address:Strassenanschrift.country
                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                      Staatsangabe (ohne festgeschriebenen Wertevorrat)

                                                                                                                                                                                                                      ShortStaat
                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                      ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                                                                                                                                                                      Control1..1
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                      Must Supporttrue
                                                                                                                                                                                                                      Summarytrue
                                                                                                                                                                                                                      ExampleBeispiel für textuelle Landesangabe: Deutschland
                                                                                                                                                                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                      740. Patient.address:Strassenanschrift.country.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
                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                      742. Patient.address:Strassenanschrift.country.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 manageable, 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..*
                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                      TypeExtension
                                                                                                                                                                                                                      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.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                      • value @ url
                                                                                                                                                                                                                      • value @ value.ofType(Coding).system
                                                                                                                                                                                                                      • 744. Patient.address:Strassenanschrift.country.extension:countryCode
                                                                                                                                                                                                                        Slice NamecountryCode
                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                        Kodierte Angabe des Länderkennzeichens nach ISO 3166-1.

                                                                                                                                                                                                                        ShortLänderkennzeichen nach ISO 3166-1
                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                        Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert.

                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                        TypeExtension(Coded string) (Extension Type: Coding)
                                                                                                                                                                                                                        Alternate Namesextensions, user content
                                                                                                                                                                                                                        ExampleBeispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" }
                                                                                                                                                                                                                        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())
                                                                                                                                                                                                                        746. Patient.address:Strassenanschrift.country.extension:countryCode.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
                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                        748. Patient.address:Strassenanschrift.country.extension:countryCode.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 manageable, 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..0
                                                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                        TypeExtension
                                                                                                                                                                                                                        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.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                        • value @ url
                                                                                                                                                                                                                        • 750. Patient.address:Strassenanschrift.country.extension:countryCode.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
                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                          Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-codedString
                                                                                                                                                                                                                          752. Patient.address:Strassenanschrift.country.extension:countryCode.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: ele-1
                                                                                                                                                                                                                          BindingThe codes SHALL be taken from Iso3166-1-2
                                                                                                                                                                                                                          (required to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

                                                                                                                                                                                                                          A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.

                                                                                                                                                                                                                          TypeCoding
                                                                                                                                                                                                                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                          754. Patient.address:Strassenanschrift.country.value
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Primitive value for string

                                                                                                                                                                                                                          ShortPrimitive value for string
                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                          Max Length:1048576
                                                                                                                                                                                                                          756. Patient.address:Strassenanschrift.period
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Time period when address was/is in use.

                                                                                                                                                                                                                          ShortTime period when address was/is in use
                                                                                                                                                                                                                          Comments

                                                                                                                                                                                                                          A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                                                                                          Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                                                                                          Control0..1
                                                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                          TypePeriod
                                                                                                                                                                                                                          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()))
                                                                                                                                                                                                                          per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                                                                                          758. Patient.address:Postfach
                                                                                                                                                                                                                          Slice NamePostfach
                                                                                                                                                                                                                          Definition

                                                                                                                                                                                                                          Eine Postfachanschrift der Patientin oder des Patienten

                                                                                                                                                                                                                          ShortPostfach
                                                                                                                                                                                                                          Comments

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

                                                                                                                                                                                                                          Control0..*
                                                                                                                                                                                                                          TypeAddress(Adresse, deutsches Basisprofil)
                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                          Pattern Value{
                                                                                                                                                                                                                            "type" : "postal"
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                          pat-cnt-2or3-char: The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. (country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3')))
                                                                                                                                                                                                                          760. Patient.address:Postfach.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
                                                                                                                                                                                                                          Typestring
                                                                                                                                                                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                          762. Patient.address:Postfach.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 manageable, 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..*
                                                                                                                                                                                                                          This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                          TypeExtension
                                                                                                                                                                                                                          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
                                                                                                                                                                                                                          • 764. Patient.address:Postfach.extension:Stadtteil
                                                                                                                                                                                                                            Slice NameStadtteil
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            A subsection of a municipality.

                                                                                                                                                                                                                            Shortprecinct
                                                                                                                                                                                                                            Control0..1
                                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                            TypeExtension(ADXP Precinct) (Extension Type: string)
                                                                                                                                                                                                                            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())
                                                                                                                                                                                                                            766. Patient.address:Postfach.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..1
                                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                            BindingThe codes SHALL be taken from AddressUse
                                                                                                                                                                                                                            (required to http://hl7.org/fhir/ValueSet/address-use|4.0.1)

                                                                                                                                                                                                                            The use of an address.

                                                                                                                                                                                                                            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()))
                                                                                                                                                                                                                            768. Patient.address:Postfach.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).

                                                                                                                                                                                                                            Control1..1
                                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                            BindingThe codes SHALL be taken from AddressType
                                                                                                                                                                                                                            (required to http://hl7.org/fhir/ValueSet/address-type|4.0.1)

                                                                                                                                                                                                                            The type of an address (physical / postal).

                                                                                                                                                                                                                            Typecode
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            ExampleGeneral: both
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            770. Patient.address:Postfach.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..1
                                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            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()))
                                                                                                                                                                                                                            772. Patient.address:Postfach.line
                                                                                                                                                                                                                            Definition

                                                                                                                                                                                                                            Diese Komponente kann Straßennamen, Hausnummer, Appartmentnummer, Postfach, c/o sowie weitere Zustellungshinweise enthalten. Die Informationen können in mehrere line-Komponenten aufgeteilt werden. Bei Verwendung der Extensions, um Straße, Hausnnummer und Postfach strukturiert zu übermitteln, müssen diese Informationen stets vollständig auch in der line-Komponente, die sie erweitern, enthalten sein, um es Systemen, die diese Extensions nicht verwenden zu ermöglichen, auf diese Informationen zugreifen zu können.

                                                                                                                                                                                                                            ShortStraßenname mit Hausnummer oder Postfach sowie weitere Angaben zur Zustellung
                                                                                                                                                                                                                            Comments

                                                                                                                                                                                                                            Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                            Control1..3
                                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                            Must Supporttrue
                                                                                                                                                                                                                            Summarytrue
                                                                                                                                                                                                                            ExampleGeneral: 137 Nowhere Street
                                                                                                                                                                                                                            Beispiel für Adresszeile mit Extensions für Straße und Hausnummer: Musterweg 42
                                                                                                                                                                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                            774. Patient.address:Postfach.line.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
                                                                                                                                                                                                                            Typestring
                                                                                                                                                                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                            776. Patient.address:Postfach.line.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 manageable, 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..*
                                                                                                                                                                                                                            This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                            TypeExtension
                                                                                                                                                                                                                            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.line.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                            • value @ url
                                                                                                                                                                                                                            • 778. Patient.address:Postfach.line.extension:Strasse
                                                                                                                                                                                                                              Slice NameStrasse
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              streetName.

                                                                                                                                                                                                                              ShortstreetName
                                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                              TypeExtension(ADXP Street Name) (Extension Type: string)
                                                                                                                                                                                                                              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())
                                                                                                                                                                                                                              780. Patient.address:Postfach.line.extension:Hausnummer
                                                                                                                                                                                                                              Slice NameHausnummer
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building.

                                                                                                                                                                                                                              ShorthouseNumber
                                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                              TypeExtension(ADXP House Number) (Extension Type: string)
                                                                                                                                                                                                                              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())
                                                                                                                                                                                                                              782. Patient.address:Postfach.line.extension:Adresszusatz
                                                                                                                                                                                                                              Slice NameAdresszusatz
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses).

                                                                                                                                                                                                                              ShortadditionalLocator
                                                                                                                                                                                                                              Control0..0
                                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                              TypeExtension(ADXP Additional Locator) (Extension Type: string)
                                                                                                                                                                                                                              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())
                                                                                                                                                                                                                              784. Patient.address:Postfach.line.extension:Postfach
                                                                                                                                                                                                                              Slice NamePostfach
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              A numbered box located in a post station.

                                                                                                                                                                                                                              ShortpostBox
                                                                                                                                                                                                                              Control0..1
                                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                              TypeExtension(ADXP Post Box) (Extension Type: string)
                                                                                                                                                                                                                              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())
                                                                                                                                                                                                                              786. Patient.address:Postfach.line.value
                                                                                                                                                                                                                              Definition

                                                                                                                                                                                                                              Primitive value for string

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

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

                                                                                                                                                                                                                              ShortName of city, town etc.
                                                                                                                                                                                                                              Comments

                                                                                                                                                                                                                              Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                              Control1..1
                                                                                                                                                                                                                              This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                              Typestring
                                                                                                                                                                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                              Must Supporttrue
                                                                                                                                                                                                                              Summarytrue
                                                                                                                                                                                                                              Alternate NamesMunicpality
                                                                                                                                                                                                                              ExampleGeneral: Erewhon
                                                                                                                                                                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                              790. Patient.address:Postfach.city.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
                                                                                                                                                                                                                              792. Patient.address:Postfach.city.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.city.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                              • value @ url
                                                                                                                                                                                                                              • 794. Patient.address:Postfach.city.extension:gemeindeschluessel
                                                                                                                                                                                                                                Slice Namegemeindeschluessel
                                                                                                                                                                                                                                Definition

                                                                                                                                                                                                                                Optional Extension Element - found in all resources.

                                                                                                                                                                                                                                ShortOptional Extensions Element
                                                                                                                                                                                                                                Control0..1
                                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                TypeExtension(ExtensionDestatisAgs) (Extension Type: Coding)
                                                                                                                                                                                                                                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())
                                                                                                                                                                                                                                796. Patient.address:Postfach.city.extension:gemeindeschluessel.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
                                                                                                                                                                                                                                Typestring
                                                                                                                                                                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                798. Patient.address:Postfach.city.extension:gemeindeschluessel.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 manageable, 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..0
                                                                                                                                                                                                                                This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                TypeExtension
                                                                                                                                                                                                                                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.city.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                                • value @ url
                                                                                                                                                                                                                                • 800. Patient.address:Postfach.city.extension:gemeindeschluessel.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
                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                  Fixed Valuehttp://fhir.de/StructureDefinition/destatis/ags
                                                                                                                                                                                                                                  802. Patient.address:Postfach.city.extension:gemeindeschluessel.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: ele-1
                                                                                                                                                                                                                                  TypeCoding
                                                                                                                                                                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                                                  Must Supporttrue
                                                                                                                                                                                                                                  ExampleAGS Hildesheim: { "system" : "http://fhir.de/sid/destatis/ags", "code" : "03254021" }
                                                                                                                                                                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                  804. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].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
                                                                                                                                                                                                                                  Typestring
                                                                                                                                                                                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                  806. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].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 manageable, 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..*
                                                                                                                                                                                                                                  This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                  TypeExtension
                                                                                                                                                                                                                                  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.city.extension.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                                  • value @ url
                                                                                                                                                                                                                                  • 808. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].system
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    The identification of the code system that defines the meaning of the symbol in the code.

                                                                                                                                                                                                                                    ShortIdentity of the terminology system
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typeuri
                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                    Need to be unambiguous about the source of the definition of the symbol.

                                                                                                                                                                                                                                    Fixed Valuehttp://fhir.de/sid/destatis/ags
                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                    810. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].version
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                                                                                                                                                                                                                    ShortVersion of the system - if relevant
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                                                                                                                                                                                                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    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()))
                                                                                                                                                                                                                                    812. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].code
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                                                                                                                                                                                                                    ShortSymbol in syntax defined by the system
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typecode
                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                    Need to refer to a particular code in the system.

                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                    ags-extension-1: Der Amtliche Gemeindeschlüssel ist nummerisch und begrenzt auf acht Stellen ($this.matches('^[0-9]{8}$'))
                                                                                                                                                                                                                                    814. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].display
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    A representation of the meaning of the code in the system, following the rules of the system.

                                                                                                                                                                                                                                    ShortRepresentation defined by the system
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                    816. Patient.address:Postfach.city.extension:gemeindeschluessel.value[x].userSelected
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                                                                                                                                                                                                                    ShortIf this coding was chosen directly by the user
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typeboolean
                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                    Requirements

                                                                                                                                                                                                                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                    818. Patient.address:Postfach.city.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
                                                                                                                                                                                                                                    820. Patient.address:Postfach.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
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    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()))
                                                                                                                                                                                                                                    822. Patient.address:Postfach.state
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    Name (oder Kürzel) des Bundeslandes.

                                                                                                                                                                                                                                    ShortBundesland
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                                    Control0..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    BindingThe codes SHOULD be taken from ISO-3166-2:de-Laendercodes
                                                                                                                                                                                                                                    (preferred to http://fhir.de/ValueSet/iso/bundeslaender)
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    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()))
                                                                                                                                                                                                                                    824. Patient.address:Postfach.postalCode
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    Postleitzahl gemäß der im jeweiligen Land gültigen Konventionen

                                                                                                                                                                                                                                    ShortPostleitzahl
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    Note that FHIR strings SHALL NOT exceed 1MB in size

                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                    Alternate NamesZip
                                                                                                                                                                                                                                    ExampleGeneral: 9132
                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                    826. Patient.address:Postfach.country
                                                                                                                                                                                                                                    Definition

                                                                                                                                                                                                                                    Staatsangabe (ohne festgeschriebenen Wertevorrat)

                                                                                                                                                                                                                                    ShortStaat
                                                                                                                                                                                                                                    Comments

                                                                                                                                                                                                                                    ISO 3166 3 letter codes can be used in place of a human readable country name.

                                                                                                                                                                                                                                    Control1..1
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                                                                                                                                                                    Must Supporttrue
                                                                                                                                                                                                                                    Summarytrue
                                                                                                                                                                                                                                    ExampleBeispiel für textuelle Landesangabe: Deutschland
                                                                                                                                                                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                    828. Patient.address:Postfach.country.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
                                                                                                                                                                                                                                    Typestring
                                                                                                                                                                                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                    830. Patient.address:Postfach.country.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 manageable, 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..*
                                                                                                                                                                                                                                    This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                    TypeExtension
                                                                                                                                                                                                                                    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.country.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                                    • value @ url
                                                                                                                                                                                                                                    • value @ value.ofType(Coding).system
                                                                                                                                                                                                                                    • 832. Patient.address:Postfach.country.extension:countryCode
                                                                                                                                                                                                                                      Slice NamecountryCode
                                                                                                                                                                                                                                      Definition

                                                                                                                                                                                                                                      Kodierte Angabe des Länderkennzeichens nach ISO 3166-1.

                                                                                                                                                                                                                                      ShortLänderkennzeichen nach ISO 3166-1
                                                                                                                                                                                                                                      Comments

                                                                                                                                                                                                                                      Diese Abbildung entspricht der auf EU-Ebene in Abstimmung befindlichen Profilierung zur Kodierung der Landesangabe. Durch die Verwendung der internationalen Kodierung wird die interoperable Verwendung der Adressangabe erleichtert.

                                                                                                                                                                                                                                      Control0..1
                                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                      TypeExtension(Coded string) (Extension Type: Coding)
                                                                                                                                                                                                                                      Alternate Namesextensions, user content
                                                                                                                                                                                                                                      ExampleBeispiel für kodierte Landesangabe: { "system" : "urn:iso:std:iso:3166", "code" : "DE", "display" : "Deutschland" }
                                                                                                                                                                                                                                      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())
                                                                                                                                                                                                                                      834. Patient.address:Postfach.country.extension:countryCode.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
                                                                                                                                                                                                                                      Typestring
                                                                                                                                                                                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                      836. Patient.address:Postfach.country.extension:countryCode.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 manageable, 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..0
                                                                                                                                                                                                                                      This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                      TypeExtension
                                                                                                                                                                                                                                      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.country.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                                                                                                                                                                      • value @ url
                                                                                                                                                                                                                                      • 838. Patient.address:Postfach.country.extension:countryCode.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
                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                        Fixed Valuehttp://hl7.org/fhir/StructureDefinition/iso21090-codedString
                                                                                                                                                                                                                                        840. Patient.address:Postfach.country.extension:countryCode.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: ele-1
                                                                                                                                                                                                                                        BindingThe codes SHALL be taken from Iso3166-1-2
                                                                                                                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/iso3166-1-2|4.0.1)

                                                                                                                                                                                                                                        A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.

                                                                                                                                                                                                                                        TypeCoding
                                                                                                                                                                                                                                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                        842. Patient.address:Postfach.country.value
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        Primitive value for string

                                                                                                                                                                                                                                        ShortPrimitive value for string
                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                        Max Length:1048576
                                                                                                                                                                                                                                        844. Patient.address:Postfach.period
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        Time period when address was/is in use.

                                                                                                                                                                                                                                        ShortTime period when address was/is in use
                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                        A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                                                                                                                                                                                                                                        Period is not used for a duration (a measure of elapsed time). See Duration.

                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                        This element is affected by the following invariants: ele-1
                                                                                                                                                                                                                                        TypePeriod
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                                                                                                                                                                                                                                        846. Patient.maritalStatus
                                                                                                                                                                                                                                        Definition

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

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

                                                                                                                                                                                                                                        The domestic partnership status of a person.

                                                                                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        848. 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..1
                                                                                                                                                                                                                                        TypeChoice of: boolean, integer
                                                                                                                                                                                                                                        [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
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        850. 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..*
                                                                                                                                                                                                                                        TypeAttachment
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        852. 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..*
                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        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())
                                                                                                                                                                                                                                        854. Patient.contact.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
                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        856. Patient.contact.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 manageable, 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())
                                                                                                                                                                                                                                        858. Patient.contact.modifierExtension
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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 even if unrecognized
                                                                                                                                                                                                                                        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 element that contains them
                                                                                                                                                                                                                                        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, modifiers
                                                                                                                                                                                                                                        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())
                                                                                                                                                                                                                                        860. Patient.contact.relationship
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        The nature of the relationship between the patient and the contact person.

                                                                                                                                                                                                                                        ShortThe kind of relationship
                                                                                                                                                                                                                                        Control0..*
                                                                                                                                                                                                                                        BindingUnless not suitable, these codes SHALL be taken from PatientContactRelationship
                                                                                                                                                                                                                                        (extensible to http://hl7.org/fhir/ValueSet/patient-contactrelationship|4.0.1)

                                                                                                                                                                                                                                        The nature of the relationship between a patient and a contact person for that patient.

                                                                                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                        Used to determine which contact person is the most relevant to approach, depending on circumstances.

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

                                                                                                                                                                                                                                        A name associated with the contact person.

                                                                                                                                                                                                                                        ShortA name associated with the contact person
                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                        TypeHumanName
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                        Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.

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

                                                                                                                                                                                                                                        A contact detail for the person, e.g. a telephone number or an email address.

                                                                                                                                                                                                                                        ShortA contact detail for the person
                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                        Contact 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.

                                                                                                                                                                                                                                        Control0..*
                                                                                                                                                                                                                                        TypeContactPoint
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        866. Patient.contact.address
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        Address for the contact person.

                                                                                                                                                                                                                                        ShortAddress for the contact person
                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                        TypeAddress
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                        Need to keep track where the contact person can be contacted per postal mail or visited.

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

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

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

                                                                                                                                                                                                                                        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
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                        Needed to address the person correctly.

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

                                                                                                                                                                                                                                        Organization on behalf of which the contact is acting or for which the contact is working.

                                                                                                                                                                                                                                        ShortOrganization that is associated with the contact
                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                        This element is affected by the following invariants: pat-1
                                                                                                                                                                                                                                        TypeReference(Organization)
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                        For guardians or business related contacts, the organization is relevant.

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

                                                                                                                                                                                                                                        The period during which this contact person or organization is valid to be contacted relating to this patient.

                                                                                                                                                                                                                                        ShortThe period during which this contact person or organization is valid to be contacted relating to this patient
                                                                                                                                                                                                                                        Control0..1
                                                                                                                                                                                                                                        TypePeriod
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                        874. 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..*
                                                                                                                                                                                                                                        TypeBackboneElement
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        876. Patient.communication.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
                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        878. Patient.communication.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 manageable, 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())
                                                                                                                                                                                                                                        880. Patient.communication.modifierExtension
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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 even if unrecognized
                                                                                                                                                                                                                                        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 element that contains them
                                                                                                                                                                                                                                        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, modifiers
                                                                                                                                                                                                                                        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())
                                                                                                                                                                                                                                        882. Patient.communication.language
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

                                                                                                                                                                                                                                        ShortThe language which can be used to communicate with the patient about his or her health
                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                        The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                        BindingThe codes SHOULD be taken from CommonLanguages
                                                                                                                                                                                                                                        (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

                                                                                                                                                                                                                                        A human language.

                                                                                                                                                                                                                                        Additional BindingsPurpose
                                                                                                                                                                                                                                        AllLanguagesMax Binding
                                                                                                                                                                                                                                        TypeCodeableConcept
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Requirements

                                                                                                                                                                                                                                        Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

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

                                                                                                                                                                                                                                        Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

                                                                                                                                                                                                                                        ShortLanguage preference indicator
                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                        This language is specifically identified for communicating healthcare information.

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

                                                                                                                                                                                                                                        People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                        886. 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..*
                                                                                                                                                                                                                                        TypeReference(Organization, Practitioner, PractitionerRole)
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        Alternate NamescareProvider
                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                        888. 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..1
                                                                                                                                                                                                                                        TypeReference(Organization)
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        890. Patient.link
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        Verweis auf eine andere Patientenressource, die die gleiche tatsächliche Person betrifft

                                                                                                                                                                                                                                        ShortVerweis
                                                                                                                                                                                                                                        Comments

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

                                                                                                                                                                                                                                        Control0..*
                                                                                                                                                                                                                                        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 Supporttrue
                                                                                                                                                                                                                                        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()))
                                                                                                                                                                                                                                        892. Patient.link.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
                                                                                                                                                                                                                                        Typestring
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                                                                                                                                                                                        Summaryfalse
                                                                                                                                                                                                                                        894. Patient.link.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 manageable, 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())
                                                                                                                                                                                                                                        896. Patient.link.modifierExtension
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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 even if unrecognized
                                                                                                                                                                                                                                        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 element that contains them
                                                                                                                                                                                                                                        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, modifiers
                                                                                                                                                                                                                                        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())
                                                                                                                                                                                                                                        898. Patient.link.other
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        The other patient resource that the link refers to.

                                                                                                                                                                                                                                        ShortThe other patient or related person resource that the link refers to
                                                                                                                                                                                                                                        Comments

                                                                                                                                                                                                                                        Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                        TypeReference(Patient, RelatedPerson)
                                                                                                                                                                                                                                        Is Modifierfalse
                                                                                                                                                                                                                                        Must Supporttrue
                                                                                                                                                                                                                                        Must Support TypesNo must-support rules about the choice of types/profiles
                                                                                                                                                                                                                                        Summarytrue
                                                                                                                                                                                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                                                                                                                                                                        900. Patient.link.type
                                                                                                                                                                                                                                        Definition

                                                                                                                                                                                                                                        The type of link between this patient resource and another patient resource.

                                                                                                                                                                                                                                        Shortreplaced-by | replaces | refer | seealso
                                                                                                                                                                                                                                        Control1..1
                                                                                                                                                                                                                                        BindingThe codes SHALL be taken from LinkType
                                                                                                                                                                                                                                        (required to http://hl7.org/fhir/ValueSet/link-type|4.0.1)

                                                                                                                                                                                                                                        The type of link between this patient resource and another patient resource.

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