This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.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/StructureDefinition/patient-uslab-uslabphpatient
Patient with expanded contact information
This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Patient.
unable to summarise extension (wrong count)
This structure is derived from Patient.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 1..1 | Patient | Patient with expanded contact information | |
identifier | S | 1..* | ||
use | S | 1..1 | ||
system | S | 1..1 | Organization or System URI | |
value | S | 1..1 | Patient Identifier String | |
name | S | 1..* | ||
use | S | 1..1 | code | Binding: USLabPHNameUse (required) |
family | S | 1..1 | ||
given | S | 0..2 | ||
prefix | S | 0..1 | ||
suffix | S | 0..1 | ||
telecom | Slice: Unordered, Open, by use | |||
telecom | S | 0..* | ||
system | S | 1..1 | ||
value | S | 1..1 | ||
use | S | 1..1 | code | Fixed Value: home |
telecom | S | 0..* | ||
system | S | 1..1 | ||
value | S | 1..1 | ||
use | S | 1..1 | code | Fixed Value: work |
gender | S | 1..1 | ||
birthDate | S | 0..1 | ||
deceased[x] | S | 0..1 | ||
address | S | 0..* | ||
use | S | 0..1 | ||
line | S | 0..2 | ||
city | S | 0..1 | ||
state | S | 0..1 | Binding: USPSState (required) | |
postalCode | S I | 0..1 | US Zip Codes inv-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. | |
country | S | 0..1 | ISO 3166 3 letter Country Code Binding: USCountry (extensible) | |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
contact | S | 0..* | ||
relationship | S | 0..1 | ||
coding | S | 1..1 | ||
code | S | 1..1 | ||
name | S | 0..* | ||
family | S | 1..1 | ||
given | S | 0..2 | ||
suffix | S | 0..1 | ||
telecom | S | 0..3 | ||
system | S | 1..1 | ||
value | S | 1..1 | ||
address | S | 0..* | ||
use | S | 1..1 | ||
line | S | 0..2 | ||
city | S | 0..1 | ||
state | S | 0..1 | Binding: USPSState (required) | |
postalCode | S I | 0..1 | US Zip Codes inv-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. | |
country | S | 0..1 | ISO 3166 3 letter Country Code Binding: USCountry (extensible) | |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
us-core-race | S | 0..* | CodeableConcept | A category of humans sharing history, origin or nationality Binding: DAFRace (required) |
coding | S | 1..1 | ||
system | S | 1..1 | ||
code | S | 1..1 | ||
us-core-ethnicity | S | 0..1 | CodeableConcept | A category of human sharing heritage Binding: DAFEthnicity (required) |
coding | S | 1..1 | ||
system | S | 1..1 | ||
code | S | 1..1 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 1..1 | Patient | Patient with expanded contact information | |
meta | 0..1 | Meta | Metadata about the resource | |
implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Language (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..* | CodeableConcept | Extension Binding: DAFRace (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | * | Value of extension | |
us-core-ethnicity | S | 0..1 | CodeableConcept | Extension Binding: DAFEthnicity (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | * | Value of extension | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
identifier | S Σ | 1..* | Identifier | An identifier for this patient |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
label | 0..1 | string | Description of identifier | |
system | S | 1..1 | uri | Organization or System URI Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri |
value | S | 1..1 | string | Patient Identifier String Example: 123456 |
period | 0..1 | Period | Time period when id is/was valid for use | |
assigner | 0..1 | Organization | Organization that issued id (may be just text) | |
name | S Σ | 1..* | HumanName | A name associated with the patient |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: USLabPHNameUse (required) |
text | 0..1 | string | Text representation of the full name | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 0..2 | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..1 | string | Parts that come before the name |
suffix | S | 0..1 | string | Parts that come after the name |
period | 0..1 | Period | Time period when name was/is in use | |
telecom | Σ | ContactPoint | A contact detail for the individual Slice: Unordered, Open, by use | |
telecom | S Σ | 0..* | ContactPoint | A contact detail for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S I | 1..1 | code | phone | fax | email | url Binding: ContactPointSystem (required) |
value | S | 1..1 | string | The actual contact point details |
use | ?! S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Fixed Value: home |
period | 0..1 | Period | Time period when the contact point was/is in use | |
telecom | S Σ | 0..* | ContactPoint | A contact detail for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S I | 1..1 | code | phone | fax | email | url Binding: ContactPointSystem (required) |
value | S | 1..1 | string | The actual contact point details |
use | ?! S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Fixed Value: work |
period | 0..1 | Period | Time period when the contact point was/is in use | |
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | S Σ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?! SΣ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | S Σ | 0..* | Address | Addresses for the individual |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
use | ?! S | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
text | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 | |
line | S | 0..2 | string | Street name, number, direction & P.O. Box etc Example: 137 Nowhere Street |
city | S | 0..1 | string | Name of city, town etc. Example: Erewhon |
state | S | 0..1 | string | Sub-unit of country (abreviations ok) Binding: USPSState (required) |
postalCode | S I | 0..1 | string | US Zip Codes inv-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 |
country | S | 0..1 | string | ISO 3166 3 letter Country Code Binding: USCountry (extensible) |
period | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatus (required) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | S I | 0..* | 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 | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
relationship | S | 0..1 | CodeableConcept | The kind of relationship Binding: ContactRelationship (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S | 1..1 | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | 0..1 | string | Representation defined by the system | |
primary | 0..1 | boolean | If this code was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
name | S | 0..* | HumanName | A name associated with the contact person |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | 0..1 | string | Text representation of the full name | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 0..2 | string | Given names (not always 'first'). Includes middle names |
prefix | 0..* | string | Parts that come before the name | |
suffix | S | 0..1 | string | Parts that come after the name |
period | 0..1 | Period | Time period when name was/is in use | |
telecom | S | 0..3 | ContactPoint | A contact detail for the person |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S I | 1..1 | code | phone | fax | email | url Binding: ContactPointSystem (required) |
value | S | 1..1 | string | The actual contact point details |
use | ?! | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
period | 0..1 | Period | Time period when the contact point was/is in use | |
address | S | 0..* | Address | Address for the contact person |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
use | ?! S | 1..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
text | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 | |
line | S | 0..2 | string | Street name, number, direction & P.O. Box etc Example: 137 Nowhere Street |
city | S | 0..1 | string | Name of city, town etc. Example: Erewhon |
state | S | 0..1 | string | Sub-unit of country (abreviations ok) Binding: USPSState (required) |
postalCode | S I | 0..1 | string | US Zip Codes inv-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 |
country | S | 0..1 | string | ISO 3166 3 letter Country Code Binding: USCountry (extensible) |
period | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Organization | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
animal | ?! Σ | 0..1 | If this patient is an animal (non-human) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreed (example) |
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: AnimalGenderStatus (example) |
communication | 0..* | A list of Languages which may be used to communicate with the patient about his or her health | ||
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language (required) | |
preferred | 0..1 | boolean | Language preference indicator | |
careProvider | 0..* | Organization, Practitioner | Patient's nominated care provider | |
managingOrganization | Σ | 0..1 | Organization | Organization that is the custodian of the patient record |
link | ?! | 0..* | Link to another patient resource that concerns the same actual person | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
other | ?! | 1..1 | Patient | The other patient resource that the link refers to |
type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
active | ?! Σ | 0..1 | boolean | Whether this patient's record is in active use |
todo
This structure is derived from Patient.
unable to summarise extension (wrong count)
Differential View
This structure is derived from Patient.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 1..1 | Patient | Patient with expanded contact information | |
identifier | S | 1..* | ||
use | S | 1..1 | ||
system | S | 1..1 | Organization or System URI | |
value | S | 1..1 | Patient Identifier String | |
name | S | 1..* | ||
use | S | 1..1 | code | Binding: USLabPHNameUse (required) |
family | S | 1..1 | ||
given | S | 0..2 | ||
prefix | S | 0..1 | ||
suffix | S | 0..1 | ||
telecom | Slice: Unordered, Open, by use | |||
telecom | S | 0..* | ||
system | S | 1..1 | ||
value | S | 1..1 | ||
use | S | 1..1 | code | Fixed Value: home |
telecom | S | 0..* | ||
system | S | 1..1 | ||
value | S | 1..1 | ||
use | S | 1..1 | code | Fixed Value: work |
gender | S | 1..1 | ||
birthDate | S | 0..1 | ||
deceased[x] | S | 0..1 | ||
address | S | 0..* | ||
use | S | 0..1 | ||
line | S | 0..2 | ||
city | S | 0..1 | ||
state | S | 0..1 | Binding: USPSState (required) | |
postalCode | S I | 0..1 | US Zip Codes inv-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. | |
country | S | 0..1 | ISO 3166 3 letter Country Code Binding: USCountry (extensible) | |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
contact | S | 0..* | ||
relationship | S | 0..1 | ||
coding | S | 1..1 | ||
code | S | 1..1 | ||
name | S | 0..* | ||
family | S | 1..1 | ||
given | S | 0..2 | ||
suffix | S | 0..1 | ||
telecom | S | 0..3 | ||
system | S | 1..1 | ||
value | S | 1..1 | ||
address | S | 0..* | ||
use | S | 1..1 | ||
line | S | 0..2 | ||
city | S | 0..1 | ||
state | S | 0..1 | Binding: USPSState (required) | |
postalCode | S I | 0..1 | US Zip Codes inv-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. | |
country | S | 0..1 | ISO 3166 3 letter Country Code Binding: USCountry (extensible) | |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
us-core-race | S | 0..* | CodeableConcept | A category of humans sharing history, origin or nationality Binding: DAFRace (required) |
coding | S | 1..1 | ||
system | S | 1..1 | ||
code | S | 1..1 | ||
us-core-ethnicity | S | 0..1 | CodeableConcept | A category of human sharing heritage Binding: DAFEthnicity (required) |
coding | S | 1..1 | ||
system | S | 1..1 | ||
code | S | 1..1 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 1..1 | Patient | Patient with expanded contact information | |
meta | 0..1 | Meta | Metadata about the resource | |
implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Language (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
us-core-race | S | 0..* | CodeableConcept | Extension Binding: DAFRace (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | * | Value of extension | |
us-core-ethnicity | S | 0..1 | CodeableConcept | Extension Binding: DAFEthnicity (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
url | 1..1 | uri | identifies the meaning of the extension | |
value[x] | 0..1 | * | Value of extension | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
identifier | S Σ | 1..* | Identifier | An identifier for this patient |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
label | 0..1 | string | Description of identifier | |
system | S | 1..1 | uri | Organization or System URI Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri |
value | S | 1..1 | string | Patient Identifier String Example: 123456 |
period | 0..1 | Period | Time period when id is/was valid for use | |
assigner | 0..1 | Organization | Organization that issued id (may be just text) | |
name | S Σ | 1..* | HumanName | A name associated with the patient |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! S | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: USLabPHNameUse (required) |
text | 0..1 | string | Text representation of the full name | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 0..2 | string | Given names (not always 'first'). Includes middle names |
prefix | S | 0..1 | string | Parts that come before the name |
suffix | S | 0..1 | string | Parts that come after the name |
period | 0..1 | Period | Time period when name was/is in use | |
telecom | Σ | ContactPoint | A contact detail for the individual Slice: Unordered, Open, by use | |
telecom | S Σ | 0..* | ContactPoint | A contact detail for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S I | 1..1 | code | phone | fax | email | url Binding: ContactPointSystem (required) |
value | S | 1..1 | string | The actual contact point details |
use | ?! S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Fixed Value: home |
period | 0..1 | Period | Time period when the contact point was/is in use | |
telecom | S Σ | 0..* | ContactPoint | A contact detail for the individual |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S I | 1..1 | code | phone | fax | email | url Binding: ContactPointSystem (required) |
value | S | 1..1 | string | The actual contact point details |
use | ?! S | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) Fixed Value: work |
period | 0..1 | Period | Time period when the contact point was/is in use | |
gender | S Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | S Σ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?! SΣ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | S Σ | 0..* | Address | Addresses for the individual |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
use | ?! S | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
text | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 | |
line | S | 0..2 | string | Street name, number, direction & P.O. Box etc Example: 137 Nowhere Street |
city | S | 0..1 | string | Name of city, town etc. Example: Erewhon |
state | S | 0..1 | string | Sub-unit of country (abreviations ok) Binding: USPSState (required) |
postalCode | S I | 0..1 | string | US Zip Codes inv-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 |
country | S | 0..1 | string | ISO 3166 3 letter Country Code Binding: USCountry (extensible) |
period | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: MaritalStatus (required) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | S I | 0..* | 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 | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
relationship | S | 0..1 | CodeableConcept | The kind of relationship Binding: ContactRelationship (required) |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | S | 1..1 | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | 0..1 | uri | Identity of the terminology system | |
version | 0..1 | string | Version of the system - if relevant | |
code | S | 1..1 | code | Symbol in syntax defined by the system |
display | 0..1 | string | Representation defined by the system | |
primary | 0..1 | boolean | If this code was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
name | S | 0..* | HumanName | A name associated with the contact person |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?! | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
text | 0..1 | string | Text representation of the full name | |
family | S | 1..1 | string | Family name (often called 'Surname') |
given | S | 0..2 | string | Given names (not always 'first'). Includes middle names |
prefix | 0..* | string | Parts that come before the name | |
suffix | S | 0..1 | string | Parts that come after the name |
period | 0..1 | Period | Time period when name was/is in use | |
telecom | S | 0..3 | ContactPoint | A contact detail for the person |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | S I | 1..1 | code | phone | fax | email | url Binding: ContactPointSystem (required) |
value | S | 1..1 | string | The actual contact point details |
use | ?! | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
period | 0..1 | Period | Time period when the contact point was/is in use | |
address | S | 0..* | Address | Address for the contact person |
us-core-county | S | 0..1 | string | County/Parish FIPS codes Binding: USFIPSCounty (required) |
use | ?! S | 1..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example: home |
text | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 | |
line | S | 0..2 | string | Street name, number, direction & P.O. Box etc Example: 137 Nowhere Street |
city | S | 0..1 | string | Name of city, town etc. Example: Erewhon |
state | S | 0..1 | string | Sub-unit of country (abreviations ok) Binding: USPSState (required) |
postalCode | S I | 0..1 | string | US Zip Codes inv-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 |
country | S | 0..1 | string | ISO 3166 3 letter Country Code Binding: USCountry (extensible) |
period | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
organization | I | 0..1 | Organization | Organization that is associated with the contact |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |
animal | ?! Σ | 0..1 | If this patient is an animal (non-human) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreed (example) |
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: AnimalGenderStatus (example) |
communication | 0..* | A list of Languages which may be used to communicate with the patient about his or her health | ||
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language (required) | |
preferred | 0..1 | boolean | Language preference indicator | |
careProvider | 0..* | Organization, Practitioner | Patient's nominated care provider | |
managingOrganization | Σ | 0..1 | Organization | Organization that is the custodian of the patient record |
link | ?! | 0..* | Link to another patient resource that concerns the same actual person | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | 0..* | Extension | Extensions that cannot be ignored | |
other | ?! | 1..1 | Patient | The other patient resource that the link refers to |
type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required) |
active | ?! Σ | 0..1 | boolean | Whether this patient's record is in active use |
XML Template
JSON Template
todo
Other representations of profile: (todo)
Path | Name | Conformance | ValueSet |
Patient.language | Language | required | http://tools.ietf.org/html/bcp47 |
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-race | DAFRace | required | MU Race Value Set |
Patient.extension http://hl7.org/fhir/StructureDefinition/us-core-ethnicity | DAFEthnicity | required | Ethnicity group |
Patient.identifier.use | IdentifierUse | required | IdentifierUse |
Patient.name.use | USLabPHNameUse | required | USLabPHNameUse |
Patient.telecom.system | ContactPointSystem | required | ContactPointSystem |
Patient.telecom.use | ContactPointUse | required | ContactPointUse |
Patient.telecom.system | ContactPointSystem | required | ContactPointSystem |
Patient.telecom.use | ContactPointUse | required | ContactPointUse |
Patient.gender | AdministrativeGender | required | AdministrativeGender |
Patient.address.extension http://hl7.org/fhir/StructureDefinition/us-core-county | USFIPSCounty | required | US counties and county equivalent entities codes |
Patient.address.use | AddressUse | required | AddressUse |
Patient.address.state | USPSState | required | USPS Two Letter Alphabetic Codes |
Patient.address.country | USCountry | extensible | http://www.iso.org/iso/country_codes.htm |
Patient.maritalStatus | MaritalStatus | required | Marital Status Codes |
Patient.contact.relationship | ContactRelationship | required | PatientContactRelationship |
Patient.contact.name.use | NameUse | required | NameUse |
Patient.contact.telecom.system | ContactPointSystem | required | ContactPointSystem |
Patient.contact.telecom.use | ContactPointUse | required | ContactPointUse |
Patient.contact.address.extension http://hl7.org/fhir/StructureDefinition/us-core-county | USFIPSCounty | required | US counties and county equivalent entities codes |
Patient.contact.address.use | AddressUse | required | AddressUse |
Patient.contact.address.state | USPSState | required | USPS Two Letter Alphabetic Codes |
Patient.contact.address.country | USCountry | extensible | http://www.iso.org/iso/country_codes.htm |
Patient.contact.gender | AdministrativeGender | required | AdministrativeGender |
Patient.animal.species | AnimalSpecies | example | AnimalSpecies |
Patient.animal.breed | AnimalBreed | example | AnimalBreeds |
Patient.animal.genderStatus | AnimalGenderStatus | example | GenderStatus |
Patient.communication.language | Language | required | http://tools.ietf.org/html/bcp47 |
Patient.link.type | LinkType | required | LinkType |
Id | Path | Name | Details |
inv-1 | Patient.address.postalCode | Regex for Zip | (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 | ContactNeedsDetails | SHALL at least contain a contact's details or a reference to an organization XPath: f:name or f:telecom or f:address or f:organization |
inv-2 | Patient.contact.address.postalCode | Regex for Zip | (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} ) |