This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/us/daf/StructureDefinition/daf-patient
This profile was published on Thu Aug 21 00:00:00 AEST 2014 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Profile daf-core-patient
Summary
Mandatory: 0 element (+7 nested mandatory elements)
Must-Support: 30 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Profile daf-core-patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
![]() ![]() ![]() | ∑ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | ∑ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-race Binding: v3 Code System Race (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/us-core-race" | |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Value of extension Binding: v3 Code System Race (required) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ∑ | Coding | Code defined by a terminology system Slice: Unordered, Open, by code|true|ordered | |
![]() ![]() ![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | Coding | Code defined by a terminology system Binding: OMB Race Categories (required) |
![]() ![]() ![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system Binding: v3 Code System Race (extensible) |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity Binding: v3 Code System Ethnicity (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-birthsex Binding: USRealm Birth Sex Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-religion Binding: v3 Code System ReligiousAffiliation (required) |
![]() ![]() ![]() | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
![]() ![]() ![]() | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | S | 1..* | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() | S | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
![]() ![]() ![]() ![]() | S | 1..1 | string | The value that is unique Example: 123456 |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!S | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | S | 1..* | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | S | 1..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() ![]() | ∑ | 0..* | string | Parts that come before the name |
![]() ![]() ![]() ![]() | ∑ | 0..* | string | Parts that come after the name |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | SI | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() | S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() | S | 0..* | Address | Addresses for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
![]() ![]() ![]() ![]() | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | S | 1..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
![]() ![]() ![]() ![]() | S | 1..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() ![]() | S | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
![]() ![]() ![]() ![]() | SI | 1..1 | string | Postal code for area 1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
![]() ![]() ![]() ![]() | S | 1..1 | string | Country (can be ISO 3166 3 letter code) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required) |
![]() ![]() ![]() | S | 0..1 | boolean, integer | Whether patient is part of a multiple birth |
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |
![]() ![]() ![]() | SI | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConcept | The kind of relationship Binding: patient-contact-relationship (required) |
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!S | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() ![]() | S | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
![]() ![]() ![]() ![]() ![]() | SI | 0..1 | string | Postal code for area 2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Country (can be ISO 3166 3 letter code) Binding: w.iso.org/iso/country_codes.htm (required) |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
![]() ![]() ![]() | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (required) |
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |
![]() ![]() ![]() | S | 0..* | Reference(Profile daf-organization | Profile daf-pract) | Patient's nominated primary care provider |
![]() ![]() ![]() | S | 0..1 | Reference(Profile daf-organization) | A grouping of people or organizations with a common purpose |
![]() ![]() ![]() | ?!∑ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ?!∑ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | ?!∑ | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
![]() |
yet to be done: Xml template
yet to be done: Json template
This structure is derived from Patient.
Summary
Mandatory: 0 element (+7 nested mandatory elements)
Must-Support: 30 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Patient.
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource | |
![]() ![]() ![]() | ∑ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() | ∑ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-race Binding: v3 Code System Race (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/us-core-race" | |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | Value of extension Binding: v3 Code System Race (required) |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ∑ | Coding | Code defined by a terminology system Slice: Unordered, Open, by code|true|ordered | |
![]() ![]() ![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() | S | 1..1 | Coding | Code defined by a terminology system Binding: OMB Race Categories (required) |
![]() ![]() ![]() ![]() ![]() | S | 0..* | Coding | Code defined by a terminology system Binding: v3 Code System Race (extensible) |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity Binding: v3 Code System Ethnicity (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-birthsex Binding: USRealm Birth Sex Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/us-core-religion Binding: v3 Code System ReligiousAffiliation (required) |
![]() ![]() ![]() | S | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
![]() ![]() ![]() | S | 0..1 | Address | Extension URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | S | 1..* | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() | S | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
![]() ![]() ![]() ![]() | S | 1..1 | string | The value that is unique Example: 123456 |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!S | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | S | 1..* | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the full name |
![]() ![]() ![]() ![]() | S | 1..* | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() | S | 1..* | string | Given names (not always 'first'). Includes middle names |
![]() ![]() ![]() ![]() | ∑ | 0..* | string | Parts that come before the name |
![]() ![]() ![]() ![]() | ∑ | 0..* | string | Parts that come after the name |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when name was/is in use |
![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | SI | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() | S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!S | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
![]() ![]() ![]() | S | 0..* | Address | Addresses for the individual |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
![]() ![]() ![]() ![]() | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() | S | 1..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
![]() ![]() ![]() ![]() | S | 1..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() ![]() | S | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
![]() ![]() ![]() ![]() | SI | 1..1 | string | Postal code for area 1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
![]() ![]() ![]() ![]() | S | 1..1 | string | Country (can be ISO 3166 3 letter code) |
![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required) |
![]() ![]() ![]() | S | 0..1 | boolean, integer | Whether patient is part of a multiple birth |
![]() ![]() ![]() | 0..* | Attachment | Image of the patient | |
![]() ![]() ![]() | SI | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | S | 0..* | CodeableConcept | The kind of relationship Binding: patient-contact-relationship (required) |
![]() ![]() ![]() ![]() | S | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | S | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | S | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | ?!S | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example: both |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 |
![]() ![]() ![]() ![]() ![]() | S | 0..* | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Name of city, town etc. Example: Erewhon |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | string | District name (aka county) Example: Madison |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (required) |
![]() ![]() ![]() ![]() ![]() | SI | 0..1 | string | Postal code for area 2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. Example: 9132 |
![]() ![]() ![]() ![]() ![]() | S | 0..1 | string | Country (can be ISO 3166 3 letter code) Binding: w.iso.org/iso/country_codes.htm (required) |
![]() ![]() ![]() ![]() ![]() | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} |
![]() ![]() ![]() ![]() | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
![]() ![]() ![]() | S | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (required) |
![]() ![]() ![]() ![]() | 0..1 | boolean | Language preference indicator | |
![]() ![]() ![]() | S | 0..* | Reference(Profile daf-organization | Profile daf-pract) | Patient's nominated primary care provider |
![]() ![]() ![]() | S | 0..1 | Reference(Profile daf-organization) | A grouping of people or organizations with a common purpose |
![]() ![]() ![]() | ?!∑ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional Content defined by implementations | |
![]() ![]() ![]() ![]() | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() ![]() | ?!∑ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() | ?!∑ | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
![]() |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
Path | Name | Conformance | ValueSet |
Patient.language | Common Languages | extensible | Common Languages |
Patient.extension.valueCodeableConcept | v3 Code System Race | required | v3 Code System Race |
Patient.extension.valueCodeableConcept.coding | v3 Code System Race | extensible | v3 Code System Race |
Patient.extension.valueCodeableConcept.coding | v3 Code System Race | extensible | v3 Code System Race |
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-ethnicity | Ethnicity group | required | Ethnicity group |
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-birthsex | USRealm Birth Sex Value Set | required | USRealm Birth Sex Value Set |
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-religion | v3 Code System ReligiousAffiliation | extensible | v3 Code System ReligiousAffiliation |
Patient.identifier.use | IdentifierUse | required | IdentifierUse |
Patient.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
Patient.name.use | NameUse | required | NameUse |
Patient.telecom.system | ContactPointSystem | required | ContactPointSystem |
Patient.telecom.use | ContactPointUse | required | ContactPointUse |
Patient.gender | AdministrativeGender | required | AdministrativeGender |
Patient.address.use | AddressUse | required | AddressUse |
Patient.address.type | AddressType | required | AddressType |
Patient.address.state | USPS Two Letter Alphabetic Codes | required | USPS Two Letter Alphabetic Codes |
Patient.maritalStatus | Marital Status Codes | required | Marital Status Codes |
Patient.contact.relationship | ?ext | required | http://hl7.org/fhir/ValueSet/patient-contact-relationship |
Patient.contact.address.use | AddressUse | required | AddressUse |
Patient.contact.address.type | AddressType | required | AddressType |
Patient.contact.address.state | USPS Two Letter Alphabetic Codes | required | USPS Two Letter Alphabetic Codes |
Patient.contact.address.country | ?ext | required | http://www.iso.org/iso/country_codes.htm |
Patient.contact.gender | AdministrativeGender | required | AdministrativeGender |
Patient.animal.species | AnimalSpecies | example | AnimalSpecies |
Patient.animal.breed | AnimalBreeds | example | AnimalBreeds |
Patient.animal.genderStatus | GenderStatus | example | GenderStatus |
Patient.communication.language | Common Languages | required | Common Languages |
Patient.link.type | LinkType | required | LinkType |
Id | Path | Details | Requirements |
dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
1 | Patient.address.postalCode | (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: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} ) | |
pat-1 | Patient.contact | SHALL at least contain a contact's details or a reference to an organization XPath: exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization) | |
2 | Patient.contact.address.postalCode | (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: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} ) |