Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Example StructureDefinition/patient-animal (XML)

Patient Administration Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

animal

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="patient-animal"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/patient-animal"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.5.1343"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="animal"/> 
  <title value="animal"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2021-01-02T08:58:31+11:00"/> 
  <publisher value="HL7"/> 
  <description value="This patient is known to be an animal."/> 
  <fhirVersion value="5.0.0"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <mapping> 
    <identity value="v2"/> 
    <uri value="http://hl7.org/v2"/> 
    <name value="HL7 v2 Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <context> 
    <type value="element"/> 
    <expression value="Patient"/> 
  </context> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="This patient is known to be an animal (non-human)"/> 
      <definition value="This patient is known to be an animal."/> 
      <comment value="The absence of the animal extension 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)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="player[classCode=ANM]"/> 
      </mapping> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may
       be any string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Additional content defined by implementations"/> 
      <definition value="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."/> 
      <comment value="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."/> 
      <alias value="extensions"/> 
      <alias value="user content"/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:species">
      <path value="Extension.extension"/> 
      <sliceName value="species"/> 
      <short value="The animal species.  E.g. Dog, Cow."/> 
      <definition value="Identifies the high level taxonomic categorization of the kind of animal."/> 
      <comment value="If the patient is non-human, at least a species SHALL be specified. Species SHALL
       be a widely recognized taxonomic classification.  It might or might not be Linnaean
       taxonomy and might or might 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 &quot;Hereford&quot; does
       not allow inference of the species Bos taurus, because there is a Hereford pig
       breed, but the SNOMED CT code for &quot;Hereford Cattle Breed&quot; does.)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="PID-35"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="code"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:species.id">
      <path value="Extension.extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may
       be any string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:species.extension">
      <path value="Extension.extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.extension:species.url">
      <path value="Extension.extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="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."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="species"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:species.value[x]">
      <path value="Extension.extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](
      extensibility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AnimalSpecies"/> 
        </extension> 
        <strength value="example"/> 
        <description value="The species of an animal."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/animal-species"/> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:breed">
      <path value="Extension.extension"/> 
      <sliceName value="breed"/> 
      <short value="The animal breed.  E.g. Poodle, Angus."/> 
      <definition value="Identifies the detailed categorization of the kind of animal."/> 
      <comment value="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."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="PID-35 (where more detailed value is present)"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:breed.id">
      <path value="Extension.extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may
       be any string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:breed.extension">
      <path value="Extension.extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.extension:breed.url">
      <path value="Extension.extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="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."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="breed"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:breed.value[x]">
      <path value="Extension.extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](
      extensibility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AnimalBreed"/> 
        </extension> 
        <strength value="example"/> 
        <description value="The breed of an animal."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/animal-breeds"/> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:genderStatus">
      <path value="Extension.extension"/> 
      <sliceName value="genderStatus"/> 
      <short value="The status of the animal's reproductive parts.  E.g. Neutered, Intact."/> 
      <definition value="Indicates the current state of the animal's reproductive organs."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="v2"/> 
        <map value="N/A"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="genderStatusCode"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:genderStatus.id">
      <path value="Extension.extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may
       be any string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="id"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:genderStatus.extension">
      <path value="Extension.extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.extension:genderStatus.url">
      <path value="Extension.extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="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."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="genderStatus"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:genderStatus.value[x]">
      <path value="Extension.extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](
      extensibility.html) for a list)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AnimalGenderStatus"/> 
        </extension> 
        <strength value="example"/> 
        <description value="The state of the animal's reproductive organs."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/animal-genderstatus"/> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="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."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="uri"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/patient-animal"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](
      extensibility.html) for a list)."/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="base64Binary"/> 
      </type> 
      <type> 
        <code value="boolean"/> 
      </type> 
      <type> 
        <code value="canonical"/> 
      </type> 
      <type> 
        <code value="code"/> 
      </type> 
      <type> 
        <code value="date"/> 
      </type> 
      <type> 
        <code value="dateTime"/> 
      </type> 
      <type> 
        <code value="decimal"/> 
      </type> 
      <type> 
        <code value="id"/> 
      </type> 
      <type> 
        <code value="instant"/> 
      </type> 
      <type> 
        <code value="integer"/> 
      </type> 
      <type> 
        <code value="integer64"/> 
      </type> 
      <type> 
        <code value="markdown"/> 
      </type> 
      <type> 
        <code value="oid"/> 
      </type> 
      <type> 
        <code value="positiveInt"/> 
      </type> 
      <type> 
        <code value="string"/> 
      </type> 
      <type> 
        <code value="time"/> 
      </type> 
      <type> 
        <code value="unsignedInt"/> 
      </type> 
      <type> 
        <code value="uri"/> 
      </type> 
      <type> 
        <code value="url"/> 
      </type> 
      <type> 
        <code value="uuid"/> 
      </type> 
      <type> 
        <code value="Address"/> 
      </type> 
      <type> 
        <code value="Age"/> 
      </type> 
      <type> 
        <code value="Annotation"/> 
      </type> 
      <type> 
        <code value="Attachment"/> 
      </type> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <type> 
        <code value="CodeableReference"/> 
      </type> 
      <type> 
        <code value="Coding"/> 
      </type> 
      <type> 
        <code value="ContactPoint"/> 
      </type> 
      <type> 
        <code value="Count"/> 
      </type> 
      <type> 
        <code value="Distance"/> 
      </type> 
      <type> 
        <code value="Duration"/> 
      </type> 
      <type> 
        <code value="HumanName"/> 
      </type> 
      <type> 
        <code value="Identifier"/> 
      </type> 
      <type> 
        <code value="Money"/> 
      </type> 
      <type> 
        <code value="Period"/> 
      </type> 
      <type> 
        <code value="Quantity"/> 
      </type> 
      <type> 
        <code value="Range"/> 
      </type> 
      <type> 
        <code value="Ratio"/> 
      </type> 
      <type> 
        <code value="RatioRange"/> 
      </type> 
      <type> 
        <code value="Reference"/> 
      </type> 
      <type> 
        <code value="SampledData"/> 
      </type> 
      <type> 
        <code value="Signature"/> 
      </type> 
      <type> 
        <code value="Timing"/> 
      </type> 
      <type> 
        <code value="ContactDetail"/> 
      </type> 
      <type> 
        <code value="DataRequirement"/> 
      </type> 
      <type> 
        <code value="Expression"/> 
      </type> 
      <type> 
        <code value="ParameterDefinition"/> 
      </type> 
      <type> 
        <code value="RelatedArtifact"/> 
      </type> 
      <type> 
        <code value="TriggerDefinition"/> 
      </type> 
      <type> 
        <code value="UsageContext"/> 
      </type> 
      <type> 
        <code value="Availability"/> 
      </type> 
      <type> 
        <code value="ExtendedContactDetail"/> 
      </type> 
      <type> 
        <code value="Dosage"/> 
      </type> 
      <type> 
        <code value="Meta"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="This patient is known to be an animal (non-human)"/> 
      <definition value="This patient is known to be an animal."/> 
      <comment value="The absence of the animal extension 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)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="player[classCode=ANM]"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:species">
      <path value="Extension.extension"/> 
      <sliceName value="species"/> 
      <short value="The animal species.  E.g. Dog, Cow."/> 
      <definition value="Identifies the high level taxonomic categorization of the kind of animal."/> 
      <comment value="If the patient is non-human, at least a species SHALL be specified. Species SHALL
       be a widely recognized taxonomic classification.  It might or might not be Linnaean
       taxonomy and might or might 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 &quot;Hereford&quot; does
       not allow inference of the species Bos taurus, because there is a Hereford pig
       breed, but the SNOMED CT code for &quot;Hereford Cattle Breed&quot; does.)."/> 
      <min value="1"/> 
      <max value="1"/> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="PID-35"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="code"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:species.extension">
      <path value="Extension.extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.extension:species.url">
      <path value="Extension.extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="species"/> 
    </element> 
    <element id="Extension.extension:species.value[x]">
      <path value="Extension.extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AnimalSpecies"/> 
        </extension> 
        <strength value="example"/> 
        <description value="The species of an animal."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/animal-species"/> 
      </binding> 
    </element> 
    <element id="Extension.extension:breed">
      <path value="Extension.extension"/> 
      <sliceName value="breed"/> 
      <short value="The animal breed.  E.g. Poodle, Angus."/> 
      <definition value="Identifies the detailed categorization of the kind of animal."/> 
      <comment value="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."/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="PID-35 (where more detailed value is present)"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:breed.extension">
      <path value="Extension.extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.extension:breed.url">
      <path value="Extension.extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="breed"/> 
    </element> 
    <element id="Extension.extension:breed.value[x]">
      <path value="Extension.extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AnimalBreed"/> 
        </extension> 
        <strength value="example"/> 
        <description value="The breed of an animal."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/animal-breeds"/> 
      </binding> 
    </element> 
    <element id="Extension.extension:genderStatus">
      <path value="Extension.extension"/> 
      <sliceName value="genderStatus"/> 
      <short value="The status of the animal's reproductive parts.  E.g. Neutered, Intact."/> 
      <definition value="Indicates the current state of the animal's reproductive organs."/> 
      <min value="0"/> 
      <max value="1"/> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <mapping> 
        <identity value="v2"/> 
        <map value="N/A"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="genderStatusCode"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension:genderStatus.extension">
      <path value="Extension.extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.extension:genderStatus.url">
      <path value="Extension.extension.url"/> 
      <type> 
        <code value="uri"/> 
      </type> 
      <fixedUri value="genderStatus"/> 
    </element> 
    <element id="Extension.extension:genderStatus.value[x]">
      <path value="Extension.extension.value[x]"/> 
      <min value="1"/> 
      <type> 
        <code value="CodeableConcept"/> 
      </type> 
      <binding> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="AnimalGenderStatus"/> 
        </extension> 
        <strength value="example"/> 
        <description value="The state of the animal's reproductive organs."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/animal-genderstatus"/> 
      </binding> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/patient-animal"/> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <min value="0"/> 
      <max value="0"/> 
    </element> 
  </differential> 
</StructureDefinition> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.