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

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

Extension: ExtensionPatient_Animal - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R3-Patient.animal extension.

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

0. Extension
Definition

STU3: Patient.animal (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortSTU3: This patient is known to be an animal (non-human) (new)Optional Extensions Element
Comments

Element Patient.animal has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

Control0..1*
This element is affected by the following invariants: ele-1
Is Modifiertruefalse because This extension is a modifier because the source element `Patient.animal` is flagged as a modifier element.
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())
ele-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())
2. Extension.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.

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())
ele-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 Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:species
    Slice Namespecies
    Definition

    STU3: Patient.animal.species (new:CodeableConcept)

    ShortSTU3: E.g. Dog, Cow (new)Additional content defined by implementations
    Comments

    Element Patient.animal.species is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.species has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.species has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Need to know what kind of animal. Element Patient.animal.species is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.species has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.species has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    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())
    ele-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())
    6. Extension.extension:species.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 Valuespecies
    8. Extension.extension:species.value[x]
    Definition

    Identifies the high level taxonomic categorization of the kind of animal.


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

    ShortE.g. Dog, CowValue of extension
    Comments

    If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

    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
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.extension:breed
    Slice Namebreed
    Definition

    STU3: Patient.animal.breed (new:CodeableConcept)

    ShortSTU3: E.g. Poodle, Angus (new)Additional content defined by implementations
    Comments

    Element Patient.animal.breed is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.breed has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.breed has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    May need to know the specific kind within the species. Element Patient.animal.breed is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.breed has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.breed has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    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())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Extension.extension:breed.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 Valuebreed
    14. Extension.extension:breed.value[x]
    Definition

    Identifies the detailed categorization of the kind of animal.


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

    ShortE.g. Poodle, AngusValue of extension
    Comments

    Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

    Control0..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
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Extension.extension:genderStatus
    Slice NamegenderStatus
    Definition

    STU3: Patient.animal.genderStatus (new:CodeableConcept)

    ShortSTU3: E.g. Neutered, Intact (new)Additional content defined by implementations
    Comments

    Element Patient.animal.genderStatus is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.genderStatus has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.genderStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Gender status can affect housing and animal behavior. Element Patient.animal.genderStatus is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.genderStatus has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.genderStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    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())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Extension.extension:genderStatus.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 ValuegenderStatus
    20. Extension.extension:genderStatus.value[x]
    Definition

    Indicates the current state of the animal's reproductive organs.


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

    ShortE.g. Neutered, IntactValue of extension
    Control0..1
    BindingFor example codes, see For codes, see GenderStatus
    (example to http://hl7.org/fhir/ValueSet/animal-genderstatus|4.0.1)

    The state of the animal's reproductive organs.

    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()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Extension.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/3.0/StructureDefinition/extension-Patient.animal
    24. Extension.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()))
    ele-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. Extension
    Definition

    STU3: Patient.animal (new:BackboneElement)

    ShortSTU3: This patient is known to be an animal (non-human) (new)
    Comments

    Element Patient.animal has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

    Control0..1
    Is Modifiertrue because This extension is a modifier because the source element `Patient.animal` is flagged as a modifier element.
    2. Extension.extension
    Control1..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:species
      Slice Namespecies
      Definition

      STU3: Patient.animal.species (new:CodeableConcept)

      ShortSTU3: E.g. Dog, Cow (new)
      Comments

      Element Patient.animal.species is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.species has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.species has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

      Control1..1
      Requirements

      Need to know what kind of animal. Element Patient.animal.species is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.species has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.species has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:species.url
      Control1..1
      Fixed Valuespecies
      8. Extension.extension:species.value[x]
      Definition

      Identifies the high level taxonomic categorization of the kind of animal.

      ShortE.g. Dog, Cow
      Comments

      If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

      Control1..1
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:breed
      Slice Namebreed
      Definition

      STU3: Patient.animal.breed (new:CodeableConcept)

      ShortSTU3: E.g. Poodle, Angus (new)
      Comments

      Element Patient.animal.breed is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.breed has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.breed has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

      Control0..1
      Requirements

      May need to know the specific kind within the species. Element Patient.animal.breed is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.breed has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.breed has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:breed.url
      Control1..1
      Fixed Valuebreed
      14. Extension.extension:breed.value[x]
      Definition

      Identifies the detailed categorization of the kind of animal.

      ShortE.g. Poodle, Angus
      Comments

      Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

      Control0..1
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      16. Extension.extension:genderStatus
      Slice NamegenderStatus
      Definition

      STU3: Patient.animal.genderStatus (new:CodeableConcept)

      ShortSTU3: E.g. Neutered, Intact (new)
      Comments

      Element Patient.animal.genderStatus is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.genderStatus has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.genderStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Gender status can affect housing and animal behavior. Element Patient.animal.genderStatus is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.genderStatus has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.genderStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      18. Extension.extension:genderStatus.url
      Control1..1
      Fixed ValuegenderStatus
      20. Extension.extension:genderStatus.value[x]
      Definition

      Indicates the current state of the animal's reproductive organs.

      ShortE.g. Neutered, Intact
      Control0..1
      BindingFor example codes, see GenderStatus
      (example to http://hl7.org/fhir/ValueSet/animal-genderstatus|4.0.1)

      The state of the animal's reproductive organs.

      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      22. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/3.0/StructureDefinition/extension-Patient.animal
      24. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      STU3: Patient.animal (new:BackboneElement)

      ShortSTU3: This patient is known to be an animal (non-human) (new)
      Comments

      Element Patient.animal has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

      Control0..1
      This element is affected by the following invariants: ele-1
      Is Modifiertrue because This extension is a modifier because the source element `Patient.animal` is flagged as a modifier element.
      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())
      2. Extension.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
      4. Extension.extension
      Definition

      An Extension

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

        STU3: Patient.animal.species (new:CodeableConcept)

        ShortSTU3: E.g. Dog, Cow (new)
        Comments

        Element Patient.animal.species is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.species has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.species has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

        Control1..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Need to know what kind of animal. Element Patient.animal.species is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.species has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.species has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        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())
        8. Extension.extension:species.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
        10. Extension.extension:species.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:species.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 Valuespecies
          14. Extension.extension:species.value[x]
          Definition

          Identifies the high level taxonomic categorization of the kind of animal.

          ShortE.g. Dog, Cow
          Comments

          If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).

          Control1..1
          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()))
          16. Extension.extension:breed
          Slice Namebreed
          Definition

          STU3: Patient.animal.breed (new:CodeableConcept)

          ShortSTU3: E.g. Poodle, Angus (new)
          Comments

          Element Patient.animal.breed is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.breed has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.breed has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          May need to know the specific kind within the species. Element Patient.animal.breed is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.breed has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.breed has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Extension.extension:breed.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
          20. Extension.extension:breed.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:breed.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 Valuebreed
            24. Extension.extension:breed.value[x]
            Definition

            Identifies the detailed categorization of the kind of animal.

            ShortE.g. Poodle, Angus
            Comments

            Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.

            Control0..1
            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()))
            26. Extension.extension:genderStatus
            Slice NamegenderStatus
            Definition

            STU3: Patient.animal.genderStatus (new:CodeableConcept)

            ShortSTU3: E.g. Neutered, Intact (new)
            Comments

            Element Patient.animal.genderStatus is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.genderStatus has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.genderStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Requirements

            Gender status can affect housing and animal behavior. Element Patient.animal.genderStatus is part of an existing definition because parent element Patient.animal requires a cross-version extension. Element Patient.animal.genderStatus has a context of Patient based on following the parent source element upwards and mapping to Patient. Element Patient.animal.genderStatus has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

            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())
            28. Extension.extension:genderStatus.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
            30. Extension.extension:genderStatus.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 Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. Extension.extension:genderStatus.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 ValuegenderStatus
              34. Extension.extension:genderStatus.value[x]
              Definition

              Indicates the current state of the animal's reproductive organs.

              ShortE.g. Neutered, Intact
              Control0..1
              BindingFor example codes, see GenderStatus
              (example to http://hl7.org/fhir/ValueSet/animal-genderstatus|4.0.1)

              The state of the animal's reproductive organs.

              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()))
              36. Extension.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/3.0/StructureDefinition/extension-Patient.animal
              38. Extension.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()))