Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | Version: 23.1.0 | |||
Active as of 2022-03-01 | Computable Name: AthenaPatient |
athena patient profile
This Patient profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search, create and update capabilities of these products.
This resource captures basic and administrative information for an individual receiving care or other health-related services.
This profile is used to define the content that will be returned by the API Server in response to requests to access Patient resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
The profile also defines the content that must be supplied to the API Server in response to requests to populate Patient resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.
The Patient resource derives from the PatientProfile table in athenaPractice, and the PERSON table in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
id | 0..1 | id | Logical id of this artifact | |
meta | 0..1 | Meta | Metadata about the resource | |
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | 1..1 | instant | When the resource version last changed | |
profile | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | |
profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | |
security | S | 0..1 | Coding | Security Labels applied to this resource |
Slices for extension | Content/Rules for all slices | |||
mothersMaidenName | S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |
value[x] | 1..1 | string | Value of extension | |
RESPPROVID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |
REFDOCID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |
preferredContact | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |
value[x] | 1..1 | string | Value of extension | |
extension:BIRTHTIME | S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |
value[x] | 1..1 | dateTime | Value of extension | |
patientAsGuarantor | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |
value[x] | 1..1 | boolean | Value of extension | |
genderIdentity | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
sexualOrientation | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
guarantorDetails | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |
value[x] | 1..1 | Reference(RelatedPerson) | Value of extension | |
USCORERACE | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
USCOREETHNICITY | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
USCOREBIRTHSEX | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth |
identifier | S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type |
identifier | S | 0..1 | Identifier | An identifier for this patient |
type | S | 1..1 | CodeableConcept | Description of identifier |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier | 0..1 | Identifier | An identifier for this patient | |
use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: secondary | |
type | S | 0..1 | CodeableConcept | Description of identifier |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn |
value | S | 1..1 | string | The value that is unique |
identifier | 0..1 | Identifier | An identifier for this patient | |
type | S | 0..1 | CodeableConcept | Description of identifier |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier | 0..* | Identifier | An identifier for this patient | |
active | S | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | S | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:Name | S | 1..1 | HumanName | A name associated with the patient |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
family | 0..1 | string | Family name (often called 'Surname') | |
Slices for given | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
given:First Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
given:Middle Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
prefix | 0..1 | string | Parts that come before the name | |
suffix | 0..1 | string | Parts that come after the name | |
name:PreviousName | S | 0..1 | HumanName | A name associated with the patient |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: old | |
family | 0..1 | string | Family name (often called 'Surname') | |
Slices for given | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
Slices for given | Content/Rules for all slices | |||
given:Previous First Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
Slices for given | Content/Rules for all slices | |||
given:Previous Middle Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
suffix | 0..1 | string | Parts that come after the name | |
period | 0..1 | Period | Time period when name was/is in use | |
name:Nickname | 0..1 | HumanName | A name associated with the patient | |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
given | 0..1 | string | Given names (not always 'first'). Includes middle names | |
Slices for telecom | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | |
telecom:Work | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
telecom:Home | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
telecom:Mobile | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
telecom:Fax | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: fax |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..0 | ||
telecom:Pager | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: pager |
value | S | 1..1 | string | The actual contact point details |
telecom:Email | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
value | S | 1..1 | string | The actual contact point details |
gender | S | 0..1 | code | male | female | other | unknown |
birthDate | S | 0..1 | date | The date of birth for the individual |
deceased[x] | S | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
Slices for address | S | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use |
address:Current Address | S | 0..1 | Address | An address for the individual |
use | 0..1 | code | home | work | temp | old | billing - purpose of this address Fixed Value: home | |
line | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line | |
line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
city | 0..1 | string | Name of city, town etc. | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
postalCode | 0..1 | string | Postal code for area | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
address:Previous Address | S | 0..* | Address | An address for the individual |
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient |
photo | 0..* | Attachment | Image of the patient | |
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Practitioner) | Patient's nominated primary care provider | |
managingOrganization | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
security | SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
Slices for extension | Content/Rules for all slices | |||||||
mothersMaidenName | S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | ||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
value[x] | 1..1 | string | Value of extension | |||||
RESPPROVID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
REFDOCID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
preferredContact | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
value[x] | 1..1 | string | Value of extension | |||||
extension:BIRTHTIME | S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
value[x] | 1..1 | dateTime | Value of extension | |||||
patientAsGuarantor | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
value[x] | 1..1 | boolean | Value of extension | |||||
genderIdentity | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
sexualOrientation | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
guarantorDetails | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
value[x] | 1..1 | Reference(RelatedPerson) | Value of extension | |||||
USCORERACE | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
USCOREETHNICITY | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
USCOREBIRTHSEX | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type | ||||
identifier | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier | Σ | 0..* | Identifier | An identifier for this patient | ||||
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
name:Name | SΣ | 1..1 | HumanName | A name associated with the patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
name:PreviousName | SΣ | 0..1 | HumanName | A name associated with the patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:Nickname | Σ | 0..1 | HumanName | A name associated with the patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for telecom | Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
telecom:Work | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
telecom:Home | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
telecom:Mobile | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
telecom:Fax | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
telecom:Pager | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
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): Use of contact point. | ||||
telecom:Email | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
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): Use of contact point. | ||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
Slices for address | SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
address:Current Address | SΣ | 0..1 | Address | An address for the individual | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home | ||||
line | Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
address:Previous Address | SΣ | 0..* | Address | An address for the individual | ||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
photo | 0..* | Attachment | Image of the patient | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Practitioner) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name:Name.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:PreviousName.use | required | Fixed Value: oldhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:Nickname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Fax.system | required | Fixed Value: faxhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.system | required | Fixed Value: pagerhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address:Current Address.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
security | SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
mothersMaidenName | S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
value[x] | 1..1 | string | Value of extension | |||||
RESPPROVID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
REFDOCID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
preferredContact | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
value[x] | 1..1 | string | Value of extension | |||||
extension:BIRTHTIME | S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
value[x] | 1..1 | dateTime | Value of extension | |||||
patientAsGuarantor | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
value[x] | 1..1 | boolean | Value of extension | |||||
genderIdentity | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
sexualOrientation | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
guarantorDetails | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
value[x] | 1..1 | Reference(RelatedPerson) | Value of extension | |||||
USCORERACE | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
USCOREETHNICITY | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
USCOREBIRTHSEX | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type | ||||
identifier | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier | Σ | 0..* | Identifier | An identifier for this patient | ||||
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
name:Name | SΣ | 1..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:PreviousName | SΣ | 0..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:Nickname | Σ | 0..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
Slices for telecom | Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
telecom:Work | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Home | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Mobile | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Fax | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Pager | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
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): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Email | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
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): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
Slices for address | SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
address:Current Address | SΣ | 0..1 | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
address:Previous Address | SΣ | 0..* | Address | An address for the individual | ||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(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 | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Practitioner) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Patient.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name:Name.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:PreviousName.use | required | Fixed Value: oldhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:Nickname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Fax.system | required | Fixed Value: faxhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.system | required | Fixed Value: pagerhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address:Current Address.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address:Current Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
This structure is derived from Patient
Summary
Mandatory: 4 elements(51 nested mandatory elements)
Must-Support: 50 elements
Fixed: 31 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
id | 0..1 | id | Logical id of this artifact | |
meta | 0..1 | Meta | Metadata about the resource | |
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | 1..1 | instant | When the resource version last changed | |
profile | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | |
profile | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | |
security | S | 0..1 | Coding | Security Labels applied to this resource |
Slices for extension | Content/Rules for all slices | |||
mothersMaidenName | S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |
value[x] | 1..1 | string | Value of extension | |
RESPPROVID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |
REFDOCID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |
preferredContact | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |
value[x] | 1..1 | string | Value of extension | |
extension:BIRTHTIME | S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |
value[x] | 1..1 | dateTime | Value of extension | |
patientAsGuarantor | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |
value[x] | 1..1 | boolean | Value of extension | |
genderIdentity | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
sexualOrientation | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |
value[x] | 1..1 | CodeableConcept | Value of extension | |
guarantorDetails | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails |
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |
value[x] | 1..1 | Reference(RelatedPerson) | Value of extension | |
USCORERACE | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
USCOREETHNICITY | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
USCOREBIRTHSEX | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth |
identifier | S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type |
identifier | S | 0..1 | Identifier | An identifier for this patient |
type | S | 1..1 | CodeableConcept | Description of identifier |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier | 0..1 | Identifier | An identifier for this patient | |
use | 1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: secondary | |
type | S | 0..1 | CodeableConcept | Description of identifier |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn |
value | S | 1..1 | string | The value that is unique |
identifier | 0..1 | Identifier | An identifier for this patient | |
type | S | 0..1 | CodeableConcept | Description of identifier |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier | 0..* | Identifier | An identifier for this patient | |
active | S | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | S | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
name:Name | S | 1..1 | HumanName | A name associated with the patient |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
family | 0..1 | string | Family name (often called 'Surname') | |
Slices for given | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
given:First Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
given:Middle Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
prefix | 0..1 | string | Parts that come before the name | |
suffix | 0..1 | string | Parts that come after the name | |
name:PreviousName | S | 0..1 | HumanName | A name associated with the patient |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: old | |
family | 0..1 | string | Family name (often called 'Surname') | |
Slices for given | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
Slices for given | Content/Rules for all slices | |||
given:Previous First Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
Slices for given | Content/Rules for all slices | |||
given:Previous Middle Name | 0..1 | string | Given names (not always 'first'). Includes middle names | |
suffix | 0..1 | string | Parts that come after the name | |
period | 0..1 | Period | Time period when name was/is in use | |
name:Nickname | 0..1 | HumanName | A name associated with the patient | |
use | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
given | 0..1 | string | Given names (not always 'first'). Includes middle names | |
Slices for telecom | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | |
telecom:Work | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
telecom:Home | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
telecom:Mobile | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
telecom:Fax | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: fax |
value | S | 1..1 | string | The actual contact point details |
use | S | 0..0 | ||
telecom:Pager | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: pager |
value | S | 1..1 | string | The actual contact point details |
telecom:Email | 0..1 | ContactPoint | A contact detail for the individual | |
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
value | S | 1..1 | string | The actual contact point details |
gender | S | 0..1 | code | male | female | other | unknown |
birthDate | S | 0..1 | date | The date of birth for the individual |
deceased[x] | S | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
Slices for address | S | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use |
address:Current Address | S | 0..1 | Address | An address for the individual |
use | 0..1 | code | home | work | temp | old | billing - purpose of this address Fixed Value: home | |
line | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line | |
line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
line | 0..1 | string | Street name, number, direction & P.O. Box etc. | |
city | 0..1 | string | Name of city, town etc. | |
state | 0..1 | string | Sub-unit of country (abbreviations ok) | |
postalCode | 0..1 | string | Postal code for area | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
address:Previous Address | S | 0..* | Address | An address for the individual |
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient |
photo | 0..* | Attachment | Image of the patient | |
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Practitioner) | Patient's nominated primary care provider | |
managingOrganization | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
security | SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
Slices for extension | Content/Rules for all slices | |||||||
mothersMaidenName | S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | ||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
value[x] | 1..1 | string | Value of extension | |||||
RESPPROVID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
REFDOCID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
preferredContact | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
value[x] | 1..1 | string | Value of extension | |||||
extension:BIRTHTIME | S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
value[x] | 1..1 | dateTime | Value of extension | |||||
patientAsGuarantor | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
value[x] | 1..1 | boolean | Value of extension | |||||
genderIdentity | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
sexualOrientation | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
guarantorDetails | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails | ||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
value[x] | 1..1 | Reference(RelatedPerson) | Value of extension | |||||
USCORERACE | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
USCOREETHNICITY | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
USCOREBIRTHSEX | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type | ||||
identifier | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier | Σ | 0..* | Identifier | An identifier for this patient | ||||
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
name:Name | SΣ | 1..1 | HumanName | A name associated with the patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
name:PreviousName | SΣ | 0..1 | HumanName | A name associated with the patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:Nickname | Σ | 0..1 | HumanName | A name associated with the patient | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for telecom | Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
telecom:Work | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
telecom:Home | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
telecom:Mobile | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
telecom:Fax | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
telecom:Pager | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
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): Use of contact point. | ||||
telecom:Email | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
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): Use of contact point. | ||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
Slices for address | SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
address:Current Address | SΣ | 0..1 | Address | An address for the individual | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home | ||||
line | Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
address:Previous Address | SΣ | 0..* | Address | An address for the individual | ||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
photo | 0..* | Attachment | Image of the patient | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Practitioner) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name:Name.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:PreviousName.use | required | Fixed Value: oldhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:Nickname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Fax.system | required | Fixed Value: faxhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.system | required | Fixed Value: pagerhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address:Current Address.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
profile | Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
profile | Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
security | SΣ | 0..1 | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
mothersMaidenName | S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
value[x] | 1..1 | string | Value of extension | |||||
RESPPROVID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
REFDOCID | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
value[x] | 1..1 | Reference(Practitioner) | Value of extension | |||||
preferredContact | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
value[x] | 1..1 | string | Value of extension | |||||
extension:BIRTHTIME | S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
value[x] | 1..1 | dateTime | Value of extension | |||||
patientAsGuarantor | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
value[x] | 1..1 | boolean | Value of extension | |||||
genderIdentity | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
sexualOrientation | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension | |||||
guarantorDetails | S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
url | 1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
value[x] | 1..1 | Reference(RelatedPerson) | Value of extension | |||||
USCORERACE | S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
USCOREETHNICITY | S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
USCOREBIRTHSEX | S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type | ||||
identifier | SΣ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier | Σ | 0..1 | Identifier | An identifier for this patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier | Σ | 0..* | Identifier | An identifier for this patient | ||||
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
name:Name | SΣ | 1..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
given:Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:PreviousName | SΣ | 0..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
Slices for given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous First Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
Slices for given | Content/Rules for all slices | |||||||
given:Previous Middle Name | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:Nickname | Σ | 0..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 0..1 | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
Slices for telecom | Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
telecom:Work | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Home | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Mobile | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Fax | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Pager | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
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): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
telecom:Email | Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
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): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
deceased[x] | ?!SΣ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
Slices for address | SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
address:Current Address | SΣ | 0..1 | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
line | Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
address:Previous Address | SΣ | 0..* | Address | An address for the individual | ||||
maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(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 | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(Practitioner) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Patient.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
Patient.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.name:Name.use | required | Fixed Value: officialhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:PreviousName.use | required | Fixed Value: oldhttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.name:Nickname.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Work.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Home.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Mobile.use | required | Fixed Value: mobilehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Fax.system | required | Fixed Value: faxhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.system | required | Fixed Value: pagerhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Pager.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom:Email.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address:Current Address.use | required | Fixed Value: homehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address:Current Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard | ||||
Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
This structure is derived from Patient
Summary
Mandatory: 4 elements(51 nested mandatory elements)
Must-Support: 50 elements
Fixed: 31 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
The Interactions supported by this resource are listed below.
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Patient resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
GET [base]/fhir/Patient?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}
Where:
Name | Description |
---|---|
[base] | Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer |
[_count] | Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Patient resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability. |
[_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
[_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
_id (token) | The ID of the resource |
_lastUpdated (date) | |
_lastUpdated-fromnow (quantity) | Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
_security (token) | |
active (token) | Whether the patient record is active |
address (string) | A server defined search that may match any of the string fields in current/previous Address, including line, city, district, state, country, postalCode, and/or text |
address-city (string) | A city specified in current/previous address |
address-country (string) | A country specified in current/previous address |
address-postalcode (string) | A postalCode specified in current/previous address |
address-state (string) | A state specified in current/previous address |
birthdate (date) | The patient's date of birth |
birthdate-fromnow (quantity) | Like birthdate except expressed as a positive or negative offset from the current time in units of time, e.g. birthdate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
general-practitioner (reference) | Patient's nominated general practitioner, not the organization that manages the record |
death-date (date) | The date of death has been provided and satisfies this search value |
deathdate-fromnow (quantity) | Like deathdate except expressed as a positive or negative offset from the current time in units of time, e.g. deathdate-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified. |
deceased (token) | This patient has been marked as deceased, or as a death date entered |
email (token) | A value in an email contact |
ethnicity (token) | |
family (string) | A portion of the family current/previous name of the patient |
gender (token) | Gender of the patient |
genderIdentity (token) | |
given (string) | A portion of the given current/previous name of the patient |
identifier (token) | A patient identifier |
language (token) | Language code (irrespective of use value) |
mothersMaidenName (string) | |
name (string) | A portion of either family or given current/previous name of the patient |
organization (reference) | The organization at which this person is a patient |
phone (token) | A value in a phone contact |
phonetic (string) | A portion of either family or given name using some kind of phonetic matching algorithm |
race (token) | |
sexualOrientation (token) | |
telecom (token) | The value in any kind of telecom details of the patient |
The following HTTP response codes are returned by this API call:
200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
The following additional operations are available.
Find the unique matching patient.
See $unique OperationDefinition for more detail.