Profile: cqf-patient

cqf-patient

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <id value="cqf-patient-cqf-patient"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/Profile/cqf-patient-cqf-patient"/>
  <name value="Clinical Quality Framework (CQF) Patient Profile"/>
  <publisher value="Health Level Seven, Inc. - CQI WG"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/special/committees/CQI"/>
    </telecom>
  </contact>
  <description value="Profile of patient for decision support/quality metrics.  Indicates which elements must
   be supported by CQF rules and measure engines. : Clinical Quality Framework (CQF) Patient
   Profile"/>
  <status value="draft"/>
  <date value="2014-10-28"/>
  <type value="Patient"/>
  <base value="http://hl7.org/fhir/Profile/Patient"/>
  <snapshot>
    <element>
      <path value="Patient"/>
      <name value="cqf-patient"/>
      <short value="Information about a person or animal receiving health care services"/>
      <definition value="Demographics and other administrative information about a person or animal receiving care
       or other health-related services."/>
      <requirements value="Tracking patient is the center of the healthcare process."/>
      <synonym value="SubjectOfCare Client Resident"/>
      <synonym value="SubjectOfCare"/>
      <min value="1"/>
      <max value="1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Patient[classCode=PAT]"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.id"/>
      <short value="Logical id of this artefact"/>
      <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this
       value never changes."/>
      <comments value="The only time that a resource does not have an id is when it is being submitted to the
       server using a create operation. Bundles always have an id, though it is usually a generated
       UUID."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element>
      <path value="Patient.meta"/>
      <short value="Metadata about the resource"/>
      <definition value="The metadata about the resource. This is content that is maintained by the infrastructure.
       Changes to the content may not always be associated with version changes to the resource."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Meta"/>
      </type>
    </element>
    <element>
      <path value="Patient.implicitRules"/>
      <short value="A set of rules under which this content was created"/>
      <definition value="A reference to a set of rules that were followed when the resource was constructed, and
       which must be understood when processing the content."/>
      <comments value="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 as much as possible."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="uri"/>
      </type>
      <isModifier value="true"/>
    </element>
    <element>
      <path value="Patient.language"/>
      <short value="Language of the resource content"/>
      <definition value="The base language in which the resource is written."/>
      <comments value="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)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="Language"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="A human language"/>
        <referenceUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
    </element>
    <element>
      <path value="Patient.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="A human-readable narrative that contains a summary of the resource, and may be used to
       represent the content of the resource to a human. The narrative need not encode all the
       structured data, but is required to contain sufficient detail to make it &quot;clinically
       safe&quot; for a human to just read the narrative. Resource definitions may define what
       content should be represented in the narrative to ensure clinical safety."/>
      <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <synonym value="narrative"/>
      <synonym value="html"/>
      <synonym value="xhtml"/>
      <synonym value="display"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Narrative"/>
      </type>
      <condition value="dom-1"/>
      <mapping>
        <identity value="rim"/>
        <map value="Act.text?"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="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."/>
      <comments value="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."/>
      <synonym value="inline resources"/>
      <synonym value="anonymous resources"/>
      <synonym value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Resource"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.extension"/>
      <slicing>
        <discriminator value="url"/>
        <ordered value="false"/>
        <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 resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.extension"/>
      <name value="race"/>
      <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 resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
        <profile value="http://hl7.org/fhir/ExtensionDefinition/us-core-race"/>
      </type>
      <mustSupport value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.extension"/>
      <name value="ethnicity"/>
      <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 resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://hl7.org/fhir/ExtensionDefinition/us-core-ethnicity"/>
      </type>
      <mustSupport value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.extension"/>
      <name value="religion"/>
      <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 resource. In order to make the use of extensions safe and manageable, there is
       a strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://hl7.org/fhir/ExtensionDefinition/us-core-religion"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the resource, and that modifies the understanding of the element that contains it.
       Usually modifier elements provide negation or qualification. In order to make the use
       of extensions safe and manageable, there is a strict set of governance applied to the
       definition and use of extensions. Though any implementer is allowed to define an extension,
       there is a set of requirements that SHALL be met as part of the definition of the extension.
       Applications processing a resource are required to check for modifier extensions."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.identifier"/>
      <short value="An identifier for the person as this patient"/>
      <definition value="An identifier that applies to this person as a patient."/>
      <requirements value="Patients are almost always assigned specific numerical identifiers."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Identifier"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-3"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="id"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.name"/>
      <short value="A name associated with the patient"/>
      <definition value="A name associated with the individual."/>
      <comments value="Person may have multiple names with different uses or applicable periods.For animals,
       the name is a &quot;HumanName&quot; in the sense that is assigned and used by humans and
       has the same patterns."/>
      <requirements value="Need to be able to track the person by multiple names. Examples are your official name
       and a partner name."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="HumanName"/>
      </type>
      <mustSupport value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-5, PID-9"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="name"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.telecom"/>
      <short value="A contact detail for the individual"/>
      <definition value="A contact detail (e.g. a telephone number or an email address) by which the individual
       may be contacted."/>
      <comments value="Person 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 may 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)."/>
      <requirements value="People have (primary) ways to contact them in some way such as phone, email."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
      <mustSupport value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-13, PID-14, PID-40"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="telecom"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.gender"/>
      <short value="male | female | other | unknown"/>
      <definition value="Administrative Gender - the gender that the patient is considered to have for administration
       and record keeping purposes."/>
      <comments value="The gender may 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 M and F, though the vast majority of systems and contexts
       only support M and F."/>
      <requirements value="Needed for identification of the individual, in combination with (at least) name and birth
       date. Gender of individual drives many clinical processes."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <mustSupport value="true"/>
      <isSummary value="true"/>
      <binding>
        <name value="AdministrativeGender"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="The gender of a person used for administrative purposes"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/administrative-gender"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="PID-8"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.birthDate"/>
      <short value="The date of birth for the individual"/>
      <definition value="The date of birth for the individual."/>
      <comments value="At least an estimated year should be provided as a guess if the real dob is unknown."/>
      <requirements value="Age of the individual drives many clinical processes."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="date"/>
      </type>
      <mustSupport value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="loinc"/>
        <map value="21112-8"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="PID-7"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.birthTime"/>
      <short value="The time of birth for the individual"/>
      <definition value="The  time of birth for the individual."/>
      <requirements value="In some cases birth time is important (e.g. multiple births). Hospitals will capture the
       time of birth in most cases."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="time"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="loinc"/>
        <map value="21112-8"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="PID-7"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.deceased[x]"/>
      <short value="Indicates if the individual is deceased or not"/>
      <definition value="Indicates if the individual is deceased or not."/>
      <comments value="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."/>
      <requirements value="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."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
      <type>
        <code value="dateTime"/>
      </type>
      <mustSupport value="true"/>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-30  (bool) and PID-29 (datetime)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM
         and determinerCode=INSTANCE]/deceasedTime"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.address"/>
      <short value="Addresses for the individual"/>
      <definition value="Addresses for the individual."/>
      <comments value="Person may have multiple addresses with different uses or applicable periods."/>
      <requirements value="May need to keep track of persons addresses for contacting, billing or reporting requirements
       and also to help with identification."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Address"/>
      </type>
      <mustSupport value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-11"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="addr"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.maritalStatus"/>
      <short value="Marital (civil) status of a person"/>
      <definition value="This field contains a patient's most recent marital (civil) status."/>
      <requirements value="Most, if not all systems capture it."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <mustSupport value="true"/>
      <isSummary value="true"/>
      <binding>
        <name value="MaritalStatus"/>
        <isExtensible value="true"/>
        <conformance value="preferred"/>
        <description value="The domestic partnership status of a person"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/marital-status"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="PID-16"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN]/maritalStatusCode"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.multipleBirth[x]"/>
      <short value="Whether patient is part of a multiple birth"/>
      <definition value="Indicates whether the patient is part of a multiple or indicates the actual birth order."/>
      <requirements value="For disambiguation of multiple-birth children, especially relevant where the care provider
       doesn't meet the patient, such as labs."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
      <type>
        <code value="integer"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-24 (bool), PID-25 (integer)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd,  player[classCode=PSN|ANM
         and determinerCode=INSTANCE]/multipleBirthOrderNumber"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.photo"/>
      <short value="Image of the person"/>
      <definition value="Image of the person."/>
      <requirements value="Many EHR systems have the capability to capture an image of the patient. Fits with newer
       social media usage too."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Attachment"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="OBX-5 - needs a profile"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact"/>
      <short value="A contact party (e.g. guardian, partner, friend) for the patient"/>
      <definition value="A contact party (e.g. guardian, partner, friend) for the patient."/>
      <comments value="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."/>
      <requirements value="Need to track people you can contact about the patient."/>
      <min value="0"/>
      <max value="*"/>
      <constraint>
        <key value="pat-1"/>
        <name value="ContactNeedsDetails"/>
        <severity value="error"/>
        <human value="SHALL at least contain a contact's details or a reference to an organization"/>
        <xpath value="f:name or f:telecom or f:address or f:organization"/>
      </constraint>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.extension"/>
      <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. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <synonym value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.relationship"/>
      <short value="The kind of relationship"/>
      <definition value="The nature of the relationship between the patient and the contact person."/>
      <requirements value="Used to determine which contact person is the most relevant to approach, depending on
       circumstances."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <name value="ContactRelationship"/>
        <isExtensible value="true"/>
        <conformance value="preferred"/>
        <description value="The nature of the relationship between a patient and a contact person for that patient"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/patient-contact-relationship"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="NK1-7, NK1-3"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="code"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.name"/>
      <short value="A name associated with the person"/>
      <definition value="A name associated with the person."/>
      <requirements value="Contact persons need to be identified by name, but it is uncommon to need details about
       multiple other names for that person."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="HumanName"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="NK1-2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="name"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.telecom"/>
      <short value="A contact detail for the person"/>
      <definition value="A contact detail for the person, e.g. a telephone number or an email address."/>
      <comments value="Person 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."/>
      <requirements value="People have (primary) ways to contact them in some way such as phone, email."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="NK1-5, NK1-6, NK1-40"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="telecom"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.address"/>
      <short value="Address for the contact person"/>
      <definition value="Address for the contact person."/>
      <requirements value="Need to keep track where the contact person can be contacted per postal mail or visited."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Address"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="NK1-4"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="addr"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.gender"/>
      <short value="male | female | other | unknown"/>
      <definition value="Administrative Gender - the gender that the person is considered to have for administration
       and record keeping purposes."/>
      <requirements value="Needed to address the person correctly."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <binding>
        <name value="AdministrativeGender"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="The gender of a person used for administrative purposes"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/administrative-gender"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="NK1-15"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.organization"/>
      <short value="Organization that is associated with the contact"/>
      <definition value="Organization on behalf of which the contact is acting or for which the contact is working."/>
      <requirements value="For guardians or business related contacts, the organization is relevant."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
      <condition value="pat-1"/>
      <mapping>
        <identity value="v2"/>
        <map value="NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="scoper"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.contact.period"/>
      <short value="The period during which this person or organization is valid to be contacted relating
       to this patient"/>
      <definition value="The period during which this person or organization is valid to be contacted relating
       to this patient."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Period"/>
      </type>
    </element>
    <element>
      <path value="Patient.animal"/>
      <short value="If this patient is an animal (non-human)"/>
      <definition value="This element has a value if the patient is an animal."/>
      <comments value="The animal element is labeled &quot;Is Modifier&quot; since patients may be non-human.
       Systems SHALL either handle patient details appropriately (e.g. inform users patient is
       not human) or reject non-human patient records."/>
      <requirements value="Many clinical systems are extended to care for animal patients as well as human."/>
      <min value="0"/>
      <max value="1"/>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=ANM]"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.animal.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.animal.extension"/>
      <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. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.animal.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <synonym value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.animal.species"/>
      <short value="E.g. Dog, Cow"/>
      <definition value="Identifies the high level categorization of the kind of animal."/>
      <comments value="If the patient is non-human, at least a species SHALL be specified."/>
      <requirements value="Need to know what kind of animal."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AnimalSpecies"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="The species of an animal"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/animal-species"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="PID-35"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="code"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.animal.breed"/>
      <short value="E.g. Poodle, Angus"/>
      <definition value="Identifies the detailed categorization of the kind of animal."/>
      <requirements value="May need to know the specific kind within the species."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AnimalBreed"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="The breed of an animal"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/animal-breeds"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="PID-37"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.animal.genderStatus"/>
      <short value="E.g. Neutered, Intact"/>
      <definition value="Indicates the current state of the animal's reproductive organs."/>
      <requirements value="Gender status can affect housing and animal behavior."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isSummary value="true"/>
      <binding>
        <name value="AnimalGenderStatus"/>
        <isExtensible value="true"/>
        <conformance value="example"/>
        <description value="The state of the animal's reproductive organs"/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/animal-genderstatus"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="genderStatusCode"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.communication"/>
      <short value="Languages which may be used to communicate with the patient about his or her health"/>
      <definition value="Languages which may be used to communicate with the patient about his or her health."/>
      <comments value="If no language is specified, this *implies* that the default local language is spoken.
       For animals, language is not a relevant field, and should be absent from the instance."/>
      <requirements value="If a patient does not speak the local language, interpreters may be required, so languages
       spoken is an important things to keep track of both for patient and other persons of interest."/>
      <synonym value="language"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <mustSupport value="true"/>
      <binding>
        <name value="Language"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="A human language"/>
        <referenceUri value="http://tools.ietf.org/html/bcp47"/>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="LAN-2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.careProvider"/>
      <short value="Patient's nominated care provider"/>
      <definition value="Patient's nominated care provider."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="subjectOf.CareEvent.performer.AssignedEntity"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.managingOrganization"/>
      <short value="Organization that is the custodian of the patient record"/>
      <definition value="Organization that is the custodian of the patient record."/>
      <requirements value="Need to know who recognizes this patient record, manages and updates it."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="scoper"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.link"/>
      <short value="Link to another patient resource that concerns the same actual person"/>
      <definition value="Link to another patient resource that concerns the same actual person."/>
      <comments value="There is no assumption that linked patient records have mutual links."/>
      <requirements value="There are multiple usecases: * Duplicate patient records due to the clerical errors associated
       with the difficulties of identifying humans consistently, and * Distribution of patient
       information across multiple servers."/>
      <min value="0"/>
      <max value="*"/>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="outboundLink"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.link.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.link.extension"/>
      <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. In order to make the use of extensions safe and manageable, there is a
       strict set of governance  applied to the definition and use of extensions. Though any
       implementer is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.link.modifierExtension"/>
      <short value="Extensions that cannot be ignored"/>
      <definition value="May be used to represent additional information that is not part of the basic definition
       of the element, and that modifies the understanding of the element that contains it. Usually
       modifier elements provide negation or qualification. In order to make the use of extensions
       safe and manageable, there is a strict set of governance applied to the definition and
       use of extensions. Though any implementer is allowed to define an extension, there is
       a set of requirements that SHALL be met as part of the definition of the extension. Applications
       processing a resource are required to check for modifier extensions."/>
      <comments 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."/>
      <synonym value="extensions"/>
      <synonym value="user content"/>
      <synonym value="modifiers"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.link.other"/>
      <short value="The other patient resource that the link refers to"/>
      <definition value="The other patient resource that the link refers to."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="PID-3, MRG-1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="id"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.link.type"/>
      <short value="replace | refer | seealso - type of link"/>
      <definition value="The type of link between this patient resource and another patient resource."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <binding>
        <name value="LinkType"/>
        <isExtensible value="false"/>
        <conformance value="required"/>
        <description value="The type of link between this patient resource and another patient resource."/>
        <referenceReference>
          <reference value="http://hl7.org/fhir/vs/link-type"/>
        </referenceReference>
      </binding>
      <mapping>
        <identity value="rim"/>
        <map value="typeCode"/>
      </mapping>
    </element>
    <element>
      <path value="Patient.active"/>
      <short value="Whether this patient's record is in active use"/>
      <definition value="Whether this patient record is in active use."/>
      <comments value="Default is true. If a record is inactive, and linked to an active record, then future
       patient/person/record updates should occur on the other patient."/>
      <requirements value="Need to be able to mark a patient record as not to be used because it was created in error."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
      <defaultValueBoolean value="true"/>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="rim"/>
        <map value="statusCode"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Patient"/>
      <name value="cqf-patient"/>
      <synonym value="SubjectOfCare"/>
      <min value="1"/>
      <max value="1"/>
    </element>
    <element>
      <path value="Patient.extension"/>
      <slicing>
        <discriminator value="url"/>
        <ordered value="false"/>
        <rules value="open"/>
      </slicing>
    </element>
    <element>
      <path value="Patient.extension"/>
      <name value="race"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Extension"/>
        <profile value="http://hl7.org/fhir/ExtensionDefinition/us-core-race"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.extension"/>
      <name value="ethnicity"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://hl7.org/fhir/ExtensionDefinition/us-core-ethnicity"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.extension"/>
      <name value="religion"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Extension"/>
        <profile value="http://hl7.org/fhir/ExtensionDefinition/us-core-religion"/>
      </type>
    </element>
    <element>
      <path value="Patient.name"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="HumanName"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.telecom"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="ContactPoint"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.gender"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.birthDate"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="date"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.deceased[x]"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
      <type>
        <code value="dateTime"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.address"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Address"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.maritalStatus"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.multipleBirth[x]"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
      <type>
        <code value="integer"/>
      </type>
    </element>
    <element>
      <path value="Patient.communication"/>
      <synonym value="language"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <mustSupport value="true"/>
    </element>
    <element>
      <path value="Patient.careProvider"/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Practitioner"/>
      </type>
    </element>
    <element>
      <path value="Patient.managingOrganization"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Organization"/>
      </type>
    </element>
    <element>
      <path value="Patient.link"/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="Patient.link.other"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/Profile/Patient"/>
      </type>
    </element>
    <element>
      <path value="Patient.link.type"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element>
      <path value="Patient.active"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="boolean"/>
      </type>
    </element>
  </differential>
</Profile>