Connectathon 11 Snapshot
This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
DAF-Patient
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="daf-patient"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <url value="http://hl7.org/fhir/StructureDefinition/daf-patient"/> <name value="U.S. Data Access Framework (DAF) Patient Profile"/> <display value="DAF-Patient"/> <status value="draft"/> <publisher value="Health Level Seven International (Infrastructure and Messaging - Data Access Framework)"/> <contact> <telecom> <system value="other"/> <value value="http://www.healthit.gov"/> </telecom> </contact> <date value="2014-08-21"/> <description value="Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information."/> <fhirVersion value="1.2.0"/> <kind value="resource"/> <constrainedType value="Patient"/> <abstract value="false"/> <base value="http://hl7.org/fhir/StructureDefinition/Patient"/> <snapshot> <element> <path value="Patient"/> <name value="DAF-Patient"/> <short value="Information about an individual or animal receiving health care services"/> <definition value="Demographics and other administrative information about an individual or animal receiving care or other health-related services."/> <alias value="SubjectOfCare Client Resident"/> <min value="0"/> <max value="*"/> <base> <path value="Patient"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Patient"/> </type> <mapping> <identity value="cda"/> <map value="ClinicalDocument.recordTarget.patientRole"/> </mapping> <mapping> <identity value="rim"/> <map value="Patient[classCode=PAT]"/> </mapping> <mapping> <identity value="w5"/> <map value="administrative.individual"/> </mapping> </element> <element> <path value="Patient.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. 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"/> <base> <path value="Patient.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </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"/> <base> <path value="Patient.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </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"/> <base> <path value="Patient.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary 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"/> <base> <path value="Patient.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri 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 "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="Patient.text"/> <min value="0"/> <max value="1"/> </base> <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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.contained"/> <min value="0"/> <max value="*"/> </base> <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="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Patient.extension"/> <name value="race"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="Patient.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/us-core-race"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="Race of the patient"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/daf-race"/> </valueSetReference> </binding> </element> <element> <path value="Patient.extension"/> <name value="ethnicity"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="Patient.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="Ethnicity of the patient"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/daf-ethnicity"/> </valueSetReference> </binding> </element> <element> <path value="Patient.extension"/> <name value="religion"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="Patient.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/us-core-religion"/> </type> <mustSupport value="true"/> <binding> <strength value="extensible"/> <description value="Religious affiliation of the patient."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-ReligiousAffiliation"/> </valueSetReference> </binding> </element> <element> <path value="Patient.extension"/> <name value="mothersMaidenName"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="Patient.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.extension"/> <name value="birthPlace"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="1"/> <base> <path value="Patient.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/birthPlace"/> </type> <mustSupport value="true"/> </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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Patient.identifier"/> <short value="An identifier for this patient"/> <definition value="An identifier for this patient."/> <requirements value="Patients are almost always assigned specific numerical identifiers."/> <min value="1"/> <max value="*"/> <base> <path value="Patient.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value=".id"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-3"/> </mapping> <mapping> <identity value="rim"/> <map value="id"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element> <path value="Patient.identifier.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"/> <base> <path value="Identifier.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.identifier.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Identifier.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.identifier.use"/> <short value="usual | official | temp | secondary (If known)"/> <definition value="The purpose of this identifier."/> <comments value="This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/> <requirements value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="Identifies the purpose for this identifier, if known ."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.code or implied by context"/> </mapping> </element> <element> <path value="Patient.identifier.type"/> <short value="Description of identifier"/> <definition value="Description of identifier."/> <comments value="This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type."/> <requirements value="Allows users to make use of identifiers when the identifier system is not known."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/identifier-type"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="CX.5"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.code or implied by context"/> </mapping> </element> <element> <path value="Patient.identifier.system"/> <short value="The namespace for the identifier"/> <definition value="Establishes the namespace in which set of possible id values is unique."/> <requirements value="There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers."/> <min value="1"/> <max value="1"/> <base> <path value="Identifier.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <exampleUri value="http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.4 / EI-2-4"/> </mapping> <mapping> <identity value="rim"/> <map value="II.root or Role.id.root"/> </mapping> <mapping> <identity value="servd"/> <map value="./IdentifierType"/> </mapping> </element> <element> <path value="Patient.identifier.value"/> <short value="The value that is unique within the system."/> <definition value="The value that is unique within the system."/> <comments value="If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986."/> <min value="1"/> <max value="1"/> <base> <path value="Identifier.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="123456"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.1 / EI.1"/> </mapping> <mapping> <identity value="rim"/> <map value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/> </mapping> <mapping> <identity value="servd"/> <map value="./Value"/> </mapping> </element> <element> <path value="Patient.identifier.period"/> <short value="Time period when id is/was valid for use"/> <definition value="Time period during which identifier is/was valid for use."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.7 + CX.8"/> </mapping> <mapping> <identity value="rim"/> <map value="Role.effectiveTime or implied by context"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> <element> <path value="Patient.identifier.assigner"/> <short value="Organization that issued id (may be just text)"/> <definition value="Organization that issued/manages the identifier."/> <comments value="The reference may be just a text description of the assigner."/> <min value="0"/> <max value="1"/> <base> <path value="Identifier.assigner"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="CX.4 / (CX.4,CX.9,CX.10)"/> </mapping> <mapping> <identity value="rim"/> <map value="II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"/> </mapping> <mapping> <identity value="servd"/> <map value="./IdentifierIssuingAuthority"/> </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/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"/> <base> <path value="Patient.active"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <defaultValueBoolean value="true"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <mapping> <identity value="rim"/> <map value="statusCode"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </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="A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns."/> <requirements value="Need to be able to track the patient by multiple names. Examples are your official name and a partner name."/> <min value="0"/> <max value="*"/> <base> <path value="Patient.name"/> <min value="0"/> <max value="*"/> </base> <type> <code value="HumanName"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value=".patient.name"/> </mapping> <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="A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address 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="*"/> <base> <path value="Patient.telecom"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value=".telecom"/> </mapping> <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.telecom.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"/> <base> <path value="ContactPoint.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.telecom.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="ContactPoint.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.telecom.system"/> <short value="phone | fax | email | pager | other"/> <definition value="Telecommunications form for contact point - what communications system is required to make use of the contact."/> <min value="1"/> <max value="1"/> <base> <path value="ContactPoint.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <condition value="cpt-2"/> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="Telecommunications form for contact point"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/contact-point-system"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XTN.3"/> </mapping> <mapping> <identity value="rim"/> <map value="./scheme"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPointType"/> </mapping> </element> <element> <path value="Patient.telecom.value"/> <short value="The actual contact point details"/> <definition value="The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address)."/> <comments value="Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value."/> <requirements value="Need to support legacy numbers that are not in a tightly controlled format."/> <min value="1"/> <max value="1"/> <base> <path value="ContactPoint.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XTN.1 (or XTN.12)"/> </mapping> <mapping> <identity value="rim"/> <map value="./url"/> </mapping> <mapping> <identity value="servd"/> <map value="./Value"/> </mapping> </element> <element> <path value="Patient.telecom.use"/> <short value="home | work | temp | old | mobile - purpose of this contact point"/> <definition value="Identifies the purpose for the contact point."/> <comments value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old."/> <requirements value="Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="Use of contact point"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/contact-point-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XTN.2 - but often indicated by field"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> <mapping> <identity value="servd"/> <map value="./ContactPointPurpose"/> </mapping> </element> <element> <path value="Patient.telecom.rank"/> <short value="Specify preferred order of use (1 = highest)"/> <definition value="Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values."/> <comments value="Note that rank does not necessarily follow the order in which the contacts are represented in the instance."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.rank"/> <min value="0"/> <max value="1"/> </base> <type> <code value="positiveInt"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="n/a"/> </mapping> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.telecom.period"/> <short value="Time period when the contact point was/is in use"/> <definition value="Time period when the contact point was/is in use."/> <min value="0"/> <max value="1"/> <base> <path value="ContactPoint.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="./useablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </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. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error."/> <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"/> <base> <path value="Patient.gender"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The gender of a person used for administrative purposes."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/administrative-gender"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value=".patient.administrativeGenderCode"/> </mapping> <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 There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems)."/> <requirements value="Age of the individual drives many clinical processes."/> <min value="0"/> <max value="1"/> <base> <path value="Patient.birthDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="loinc"/> <map value="21112-8"/> </mapping> <mapping> <identity value="cda"/> <map value=".patient.birthTime"/> </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"/> <base> <path value="Patient.deceased[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="dateTime"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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="Patient may have multiple addresses with different uses or applicable periods."/> <requirements value="May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification."/> <min value="0"/> <max value="*"/> <base> <path value="Patient.address"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Address"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value=".addr"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-11"/> </mapping> <mapping> <identity value="rim"/> <map value="addr"/> </mapping> </element> <element> <path value="Patient.address.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"/> <base> <path value="Address.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.address.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Address.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.address.use"/> <short value="home | work | temp | old - purpose of this address"/> <definition value="The purpose of this address."/> <comments value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old."/> <requirements value="Allows an appropriate address to be chosen from a list of many."/> <min value="0"/> <max value="1"/> <base> <path value="Address.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <exampleCode value="home"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The use of an address"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/address-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XAD.7"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> <mapping> <identity value="servd"/> <map value="./AddressPurpose"/> </mapping> </element> <element> <path value="Patient.address.type"/> <short value="postal | physical | both"/> <definition value="Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both."/> <min value="0"/> <max value="1"/> <base> <path value="Address.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <exampleCode value="both"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The type of an address (physical / postal)"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/address-type"/> </valueSetReference> </binding> <mapping> <identity value="vcard"/> <map value="address type parameter"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.18"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> </element> <element> <path value="Patient.address.text"/> <short value="Text representation of the address"/> <definition value="A full text representation of the address."/> <comments value="Can provide both a text representation and parts."/> <requirements value="A renderable, unencoded form."/> <min value="0"/> <max value="1"/> <base> <path value="Address.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="137 Nowhere Street, Erewhon 9132"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="address label parameter"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"/> </mapping> <mapping> <identity value="rim"/> <map value="./formatted"/> </mapping> </element> <element> <path value="Patient.address.line"/> <short value="Street name, number, direction & P.O. Box etc."/> <definition value="This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information."/> <requirements value="home | work | temp | old - purpose of this address."/> <min value="1"/> <max value="*"/> <base> <path value="Address.line"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <exampleString value="137 Nowhere Street"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="street"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = AL]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StreetAddress (newline delimitted)"/> </mapping> </element> <element> <path value="Patient.address.city"/> <short value="Name of city, town etc."/> <definition value="The name of the city, town, village or other community or delivery center."/> <alias value="Municpality"/> <min value="1"/> <max value="1"/> <base> <path value="Address.city"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="Erewhon"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="locality"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.3"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CTY]"/> </mapping> <mapping> <identity value="servd"/> <map value="./Jurisdiction"/> </mapping> </element> <element> <path value="Patient.address.district"/> <short value="District name (aka county)"/> <definition value="The name of the administrative area (county)."/> <comments value="District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead."/> <alias value="County"/> <min value="0"/> <max value="1"/> <base> <path value="Address.district"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="Madison"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.9"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CNT | CPA]"/> </mapping> </element> <element> <path value="Patient.address.state"/> <short value="Sub-unit of country (abbreviations ok)"/> <definition value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes)."/> <alias value="Province"/> <alias value="Territory"/> <min value="1"/> <max value="1"/> <base> <path value="Address.state"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="2 letter state list"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/usps-state"/> </valueSetReference> </binding> <mapping> <identity value="vcard"/> <map value="region"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.4"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = STA]"/> </mapping> <mapping> <identity value="servd"/> <map value="./Region"/> </mapping> </element> <element> <path value="Patient.address.postalCode"/> <short value="Postal code for area"/> <definition value="A postal code designating a region defined by the postal service."/> <alias value="Zip"/> <min value="1"/> <max value="1"/> <base> <path value="Address.postalCode"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="9132"/> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="matches("[0-9]{5}(-[0-9]{4}){0,1}")"/> </extension> <key value="inv-1"/> <severity value="error"/> <human value="(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes."/> <xpath value="f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"/> </constraint> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.5"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = ZIP]"/> </mapping> <mapping> <identity value="servd"/> <map value="./PostalIdentificationCode"/> </mapping> </element> <element> <path value="Patient.address.country"/> <short value="Country (can be ISO 3166 3 letter code)"/> <definition value="Country - a nation as commonly understood or generally accepted."/> <comments value="ISO 3166 3 letter codes can be used in place of a full country name."/> <min value="1"/> <max value="1"/> <base> <path value="Address.country"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="country"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.6"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CNT]"/> </mapping> <mapping> <identity value="servd"/> <map value="./Country"/> </mapping> </element> <element> <path value="Patient.address.period"/> <short value="Time period when address was/is in use"/> <definition value="Time period when address was/is in use."/> <requirements value="Allows addresses to be placed in historical context."/> <min value="0"/> <max value="1"/> <base> <path value="Address.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <examplePeriod> <start value="2010-03-23"/> <end value="2010-07-01"/> </examplePeriod> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.12 / XAD.13 + XAD.14"/> </mapping> <mapping> <identity value="rim"/> <map value="./usablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> <element> <path value="Patient.maritalStatus"/> <short value="Marital (civil) status of a patient"/> <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"/> <base> <path value="Patient.maritalStatus"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="The domestic partnership status of a person."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/marital-status"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value=".patient.maritalStatusCode"/> </mapping> <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"/> <base> <path value="Patient.multipleBirth[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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 patient"/> <definition value="Image of the patient."/> <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="*"/> <base> <path value="Patient.photo"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Attachment"/> </type> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="Contact"/> </extension> <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="*"/> <base> <path value="Patient.contact"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="name or telecom or address or organization"/> </extension> <key value="pat-1"/> <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> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.contact.id"/> <min value="0"/> <max value="1"/> </base> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.contact.extension"/> <min value="0"/> <max value="*"/> </base> <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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.contact.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <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="*"/> <base> <path value="Patient.contact.relationship"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="Type of relationship"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/patient-contact-relationship"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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 contact person"/> <definition value="A name associated with the contact person."/> <requirements value="Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person."/> <min value="0"/> <max value="1"/> <base> <path value="Patient.contact.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="HumanName"/> </type> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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="Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification."/> <requirements value="People have (primary) ways to contact them in some way such as phone, email."/> <min value="0"/> <max value="*"/> <base> <path value="Patient.contact.telecom"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.contact.address"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Address"/> </type> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="NK1-4"/> </mapping> <mapping> <identity value="rim"/> <map value="addr"/> </mapping> </element> <element> <path value="Patient.contact.address.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"/> <base> <path value="Address.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.contact.address.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Address.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.contact.address.use"/> <short value="home | work | temp | old - purpose of this address"/> <definition value="The purpose of this address."/> <comments value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old."/> <requirements value="Allows an appropriate address to be chosen from a list of many."/> <min value="0"/> <max value="1"/> <base> <path value="Address.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <exampleCode value="home"/> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The use of an address"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/address-use"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="XAD.7"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> <mapping> <identity value="servd"/> <map value="./AddressPurpose"/> </mapping> </element> <element> <path value="Patient.contact.address.type"/> <short value="postal | physical | both"/> <definition value="Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both."/> <min value="0"/> <max value="1"/> <base> <path value="Address.type"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <exampleCode value="both"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The type of an address (physical / postal)"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/address-type"/> </valueSetReference> </binding> <mapping> <identity value="vcard"/> <map value="address type parameter"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.18"/> </mapping> <mapping> <identity value="rim"/> <map value="unique(./use)"/> </mapping> </element> <element> <path value="Patient.contact.address.text"/> <short value="Text representation of the address"/> <definition value="A full text representation of the address."/> <comments value="Can provide both a text representation and parts."/> <requirements value="A renderable, unencoded form."/> <min value="0"/> <max value="1"/> <base> <path value="Address.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="137 Nowhere Street, Erewhon 9132"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="address label parameter"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"/> </mapping> <mapping> <identity value="rim"/> <map value="./formatted"/> </mapping> </element> <element> <path value="Patient.contact.address.line"/> <short value="Street name, number, direction & P.O. Box etc."/> <definition value="This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information."/> <requirements value="home | work | temp | old - purpose of this address."/> <min value="0"/> <max value="*"/> <base> <path value="Address.line"/> <min value="0"/> <max value="*"/> </base> <type> <code value="string"/> </type> <exampleString value="137 Nowhere Street"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="street"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = AL]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StreetAddress (newline delimitted)"/> </mapping> </element> <element> <path value="Patient.contact.address.city"/> <short value="Name of city, town etc."/> <definition value="The name of the city, town, village or other community or delivery center."/> <alias value="Municpality"/> <min value="0"/> <max value="1"/> <base> <path value="Address.city"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="Erewhon"/> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="locality"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.3"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CTY]"/> </mapping> <mapping> <identity value="servd"/> <map value="./Jurisdiction"/> </mapping> </element> <element> <path value="Patient.contact.address.district"/> <short value="District name (aka county)"/> <definition value="The name of the administrative area (county)."/> <comments value="District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead."/> <alias value="County"/> <min value="0"/> <max value="1"/> <base> <path value="Address.district"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="Madison"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.9"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CNT | CPA]"/> </mapping> </element> <element> <path value="Patient.contact.address.state"/> <short value="Sub-unit of country (abbreviations ok)"/> <definition value="Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes)."/> <alias value="Province"/> <alias value="Territory"/> <min value="0"/> <max value="1"/> <base> <path value="Address.state"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="2 letter state list"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/usps-state"/> </valueSetReference> </binding> <mapping> <identity value="vcard"/> <map value="region"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.4"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = STA]"/> </mapping> <mapping> <identity value="servd"/> <map value="./Region"/> </mapping> </element> <element> <path value="Patient.contact.address.postalCode"/> <short value="Postal code for area"/> <definition value="A postal code designating a region defined by the postal service."/> <alias value="Zip"/> <min value="0"/> <max value="1"/> <base> <path value="Address.postalCode"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <exampleString value="9132"/> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="matches("[0-9]{5}(-[0-9]{4}){0,1}")"/> </extension> <key value="inv-2"/> <severity value="error"/> <human value="(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes."/> <xpath value="f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"/> </constraint> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="vcard"/> <map value="code"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.5"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = ZIP]"/> </mapping> <mapping> <identity value="servd"/> <map value="./PostalIdentificationCode"/> </mapping> </element> <element> <path value="Patient.contact.address.country"/> <short value="ISO 3166 2 or 3 letter Country Code"/> <definition value="ISO 3166 2 or 3 letter Country Code."/> <comments value="ISO 3166 3 letter codes can be used in place of a full country name."/> <min value="0"/> <max value="1"/> <base> <path value="Address.country"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="ISO 2 letter country codes."/> <valueSetUri value="http://www.iso.org/iso/country_codes.htm"/> </binding> <mapping> <identity value="vcard"/> <map value="country"/> </mapping> <mapping> <identity value="v2"/> <map value="XAD.6"/> </mapping> <mapping> <identity value="rim"/> <map value="AD.part[parttype = CNT]"/> </mapping> <mapping> <identity value="servd"/> <map value="./Country"/> </mapping> </element> <element> <path value="Patient.contact.address.period"/> <short value="Time period when address was/is in use"/> <definition value="Time period when address was/is in use."/> <requirements value="Allows addresses to be placed in historical context."/> <min value="0"/> <max value="1"/> <base> <path value="Address.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <examplePeriod> <start value="2010-03-23"/> <end value="2010-07-01"/> </examplePeriod> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="XAD.12 / XAD.13 + XAD.14"/> </mapping> <mapping> <identity value="rim"/> <map value="./usablePeriod[type="IVL<TS>"]"/> </mapping> <mapping> <identity value="servd"/> <map value="./StartDate and ./EndDate"/> </mapping> </element> <element> <path value="Patient.contact.gender"/> <short value="male | female | other | unknown"/> <definition value="Administrative Gender - the gender that the contact 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"/> <base> <path value="Patient.contact.gender"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <description value="The gender of a person used for administrative purposes."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/administrative-gender"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.contact.organization"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <condition value="pat-1"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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 contact person or organization is valid to be contacted relating to this patient"/> <definition value="The period during which this contact person or organization is valid to be contacted relating to this patient."/> <min value="0"/> <max value="1"/> <base> <path value="Patient.contact.period"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Period"/> </type> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <mapping> <identity value="rim"/> <map value="effectiveTime"/> </mapping> </element> <element> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="Animal"/> </extension> <path value="Patient.animal"/> <short value="This patient is known to be an animal (non-human)"/> <definition value="This patient is known to be an animal."/> <comments value="The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal)."/> <requirements value="Many clinical systems are extended to care for animal patients as well as human."/> <min value="0"/> <max value="0"/> <base> <path value="Patient.animal"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.animal.id"/> <min value="0"/> <max value="1"/> </base> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.animal.extension"/> <min value="0"/> <max value="*"/> </base> <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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.animal.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <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 taxonomic categorization of the kind of animal."/> <comments value="If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.)."/> <requirements value="Need to know what kind of animal."/> <min value="1"/> <max value="1"/> <base> <path value="Patient.animal.species"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="example"/> <description value="The species of an animal."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/animal-species"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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."/> <comments 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."/> <requirements value="May need to know the specific kind within the species."/> <min value="0"/> <max value="1"/> <base> <path value="Patient.animal.breed"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="example"/> <description value="The breed of an animal."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/animal-breeds"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.animal.genderStatus"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="example"/> <description value="The state of the animal's reproductive organs."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/animal-genderstatus"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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="A list of 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. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required."/> <requirements value="If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest."/> <min value="0"/> <max value="*"/> <base> <path value="Patient.communication"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="patient.languageCommunication"/> </mapping> <mapping> <identity value="rim"/> <map value="LanguageCommunication"/> </mapping> </element> <element> <path value="Patient.communication.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"/> <base> <path value="Patient.communication.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.communication.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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.communication.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Patient.communication.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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.communication.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Patient.communication.language"/> <short value="The language which can be used to communicate with the patient about his or her health"/> <definition value="The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English."/> <comments value="The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type."/> <requirements value="Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect."/> <min value="1"/> <max value="1"/> <base> <path value="Patient.communication.language"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> <mapping> <identity value="cda"/> <map value=".languageCode"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-15, LAN-2"/> </mapping> <mapping> <identity value="rim"/> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"/> </mapping> </element> <element> <path value="Patient.communication.preferred"/> <short value="Language preference indicator"/> <definition value="Indicates whether or not the patient prefers this language (over other languages he masters up a certain level)."/> <comments value="This language is specifically identified for communicating healthcare information."/> <requirements value="People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method."/> <min value="0"/> <max value="1"/> <base> <path value="Patient.communication.preferred"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <mapping> <identity value="cda"/> <map value=".preferenceInd"/> </mapping> <mapping> <identity value="v2"/> <map value="PID-15"/> </mapping> <mapping> <identity value="rim"/> <map value="preferenceInd"/> </mapping> </element> <element> <path value="Patient.careProvider"/> <short value="Patient's nominated primary care provider"/> <definition value="Patient's nominated care provider."/> <comments value="This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. This is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources."/> <min value="0"/> <max value="*"/> <base> <path value="Patient.careProvider"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/daf-organization"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/daf-pract"/> </type> <mustSupport value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <mapping> <identity value="v2"/> <map value="PD1-4"/> </mapping> <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."/> <comments value="There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association)."/> <requirements value="Need to know who recognizes this patient record, manages and updates it."/> <min value="0"/> <max value="1"/> <base> <path value="Patient.managingOrganization"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/daf-organization"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="cda"/> <map value=".providerOrganization"/> </mapping> <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 patient."/> <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="*"/> <base> <path value="Patient.link"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <isModifier value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.link.id"/> <min value="0"/> <max value="1"/> </base> <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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.link.extension"/> <min value="0"/> <max value="*"/> </base> <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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="Patient.link.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <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"/> <base> <path value="Patient.link.other"/> <min value="1"/> <max value="1"/> </base> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <isModifier value="true"/> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <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"/> <base> <path value="Patient.link.type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <binding> <strength value="required"/> <description value="The type of link between this patient resource and another patient resource."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/link-type"/> </valueSetReference> </binding> <mapping> <identity value="cda"/> <map value="n/a"/> </mapping> <mapping> <identity value="rim"/> <map value="typeCode"/> </mapping> </element> </snapshot> <differential> <element> <path value="Patient"/> <name value="DAF-Patient"/> <min value="0"/> <max value="*"/> <type> <code value="Patient"/> </type> </element> <element> <path value="Patient.extension"/> <name value="race"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/us-core-race"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="Race of the patient"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/daf-race"/> </valueSetReference> </binding> </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/StructureDefinition/us-core-ethnicity"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="Ethnicity of the patient"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/daf-ethnicity"/> </valueSetReference> </binding> </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/StructureDefinition/us-core-religion"/> </type> <mustSupport value="true"/> <binding> <strength value="extensible"/> <description value="Religious affiliation of the patient."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/v3-ReligiousAffiliation"/> </valueSetReference> </binding> </element> <element> <path value="Patient.extension"/> <name value="mothersMaidenName"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.extension"/> <name value="birthPlace"/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> <profile value="http://hl7.org/fhir/StructureDefinition/birthPlace"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.identifier"/> <min value="1"/> <max value="*"/> <type> <code value="Identifier"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.identifier.type"/> <short value="Description of identifier"/> <definition value="Description of identifier."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.identifier.system"/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.identifier.value"/> <short value="The value that is unique within the system."/> <definition value="The value that is unique within the system."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.active"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> <mustSupport value="true"/> </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.telecom.system"/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.telecom.value"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.telecom.use"/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </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.address.line"/> <min value="1"/> <max value="*"/> <type> <code value="string"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.address.city"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.address.state"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="2 letter state list"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/usps-state"/> </valueSetReference> </binding> </element> <element> <path value="Patient.address.postalCode"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="inv-1"/> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="matches("[0-9]{5}(-[0-9]{4}){0,1}")"/> </extension> <key value="inv-1"/> <severity value="error"/> <human value="(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes."/> <xpath value="f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"/> </constraint> <mustSupport value="true"/> </element> <element> <path value="Patient.address.country"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </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> <mustSupport value="true"/> </element> <element> <path value="Patient.contact"/> <min value="0"/> <max value="*"/> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.relationship"/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="Type of relationship"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/patient-contact-relationship"/> </valueSetReference> </binding> </element> <element> <path value="Patient.contact.name"/> <min value="0"/> <max value="1"/> <type> <code value="HumanName"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.telecom"/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.address"/> <type> <code value="Address"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.address.use"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.address.line"/> <min value="0"/> <max value="*"/> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.address.city"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.address.state"/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="2 letter state list"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/usps-state"/> </valueSetReference> </binding> </element> <element> <path value="Patient.contact.address.postalCode"/> <min value="0"/> <max value="1"/> <condition value="inv-2"/> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="matches("[0-9]{5}(-[0-9]{4}){0,1}")"/> </extension> <key value="inv-2"/> <severity value="error"/> <human value="(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes."/> <xpath value="f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"/> </constraint> <mustSupport value="true"/> </element> <element> <path value="Patient.contact.address.country"/> <short value="ISO 3166 2 or 3 letter Country Code"/> <definition value="ISO 3166 2 or 3 letter Country Code."/> <min value="0"/> <max value="1"/> <mustSupport value="true"/> <binding> <strength value="required"/> <description value="ISO 2 letter country codes."/> <valueSetUri value="http://www.iso.org/iso/country_codes.htm"/> </binding> </element> <element> <path value="Patient.animal"/> <min value="0"/> <max value="0"/> </element> <element> <path value="Patient.communication"/> <min value="0"/> <max value="*"/> <mustSupport value="true"/> </element> <element> <path value="Patient.communication.language"/> <min value="1"/> <max value="1"/> <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/StructureDefinition/daf-organization"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/daf-pract"/> </type> <mustSupport value="true"/> </element> <element> <path value="Patient.managingOrganization"/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/daf-organization"/> </type> <mustSupport value="true"/> </element> </differential> </StructureDefinition>
© HL7.org 2011+. FHIR DSTU2 (v1.2.0-7447) generated on Fri, Dec 11, 2015 17:44+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change