Implementation Guide
25.0.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-patient-profile.html | Version: 25.0.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.
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(RelatedPerson) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://terminology.hl7.org/ValueSet/pronouns]] | Extension URL: http://terminology.hl7.org/ValueSet/pronouns ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://terminology.hl7.org/ValueSet/pronouns" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: PI | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: secondary | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: SB | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: MR | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: old | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: work | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: mobile | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: fax | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: pager | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: home | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Address | An address for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
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.
ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children | ||||
![]() |
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 | Fixed Value: homehttp://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.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguageshttp://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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
0..1 | id | Logical id of this artifact | |
![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |
![]() ![]() ![]() ![]() |
2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
![]() ![]() ![]() ![]() |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | |
![]() ![]() ![]() ![]() |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Security Labels applied to this resource |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(RelatedPerson) | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex |
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation |
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://terminology.hl7.org/ValueSet/pronouns]] | Extension URL: http://terminology.hl7.org/ValueSet/pronouns | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://terminology.hl7.org/ValueSet/pronouns" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type |
![]() ![]() ![]() |
S | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: secondary | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient | |
![]() ![]() ![]() |
S | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() |
S | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() |
S | 1..1 | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() |
0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Parts that come before the name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Parts that come after the name | |
![]() ![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: old | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Parts that come after the name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() |
0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: fax |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..0 | ||
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: pager |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() |
S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() |
S | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
S | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() |
S | 0..1 | Address | An address for the individual |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Fixed Value: home | |
![]() ![]() ![]() ![]() ![]() |
0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Postal code for area | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
![]() ![]() ![]() ![]() |
S | 0..* | Address | An address for the individual |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient |
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |
![]() ![]() ![]() |
0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship | |
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Patient's nominated primary care provider | |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(RelatedPerson) | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | ||||
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://terminology.hl7.org/ValueSet/pronouns]] | Extension URL: http://terminology.hl7.org/ValueSet/pronouns | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://terminology.hl7.org/ValueSet/pronouns" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
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 | CommonLanguageshttp://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 | Fixed Value: homehttp://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 | CommonLanguageshttp://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(57 nested mandatory elements)
Must-Support: 56 elements
Fixed: 35 elements
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(RelatedPerson) | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://terminology.hl7.org/ValueSet/pronouns]] | Extension URL: http://terminology.hl7.org/ValueSet/pronouns ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://terminology.hl7.org/ValueSet/pronouns" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: PI | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Fixed Value: secondary | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: SB | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Fixed Value: MR | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come before the name ele-1: All FHIR elements must have a @value or children This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: old | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | HumanName | A name associated with the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name | ||||
![]() ![]() ![]() |
Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: work | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: home | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: mobile | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: fax | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: pager | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: home | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Address | An address for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient ele-1: All FHIR elements must have a @value or children pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
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.
ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Patient's nominated primary care provider ele-1: All FHIR elements must have a @value or children | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children | ||||
![]() |
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 | Fixed Value: homehttp://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.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard | ||||
Patient.communication.language | preferred | CommonLanguageshttp://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 |
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |
![]() ![]() ![]() |
0..1 | id | Logical id of this artifact | |
![]() ![]() ![]() |
0..1 | Meta | Metadata about the resource | |
![]() ![]() ![]() ![]() |
S | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
1..1 | instant | When the resource version last changed | |
![]() ![]() ![]() ![]() |
2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | |
![]() ![]() ![]() ![]() |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | |
![]() ![]() ![]() ![]() |
1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Security Labels applied to this resource |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(RelatedPerson) | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex |
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation |
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://terminology.hl7.org/ValueSet/pronouns]] | Extension URL: http://terminology.hl7.org/ValueSet/pronouns | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://terminology.hl7.org/ValueSet/pronouns" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |
![]() ![]() ![]() |
S | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type |
![]() ![]() ![]() |
S | 0..1 | Identifier | An identifier for this patient |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: secondary | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
0..1 | Identifier | An identifier for this patient | |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique |
![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient | |
![]() ![]() ![]() |
S | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() |
S | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() |
S | 1..1 | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() |
0..2 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Parts that come before the name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Parts that come after the name | |
![]() ![]() ![]() ![]() |
S | 0..1 | HumanName | A name associated with the patient |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: old | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names Slice: Unordered, Open by value:given | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Parts that come after the name | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the patient | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Given names (not always 'first'). Includes middle names | |
![]() ![]() ![]() |
0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: work |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: mobile |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: fax |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..0 | ||
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: pager |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() |
0..1 | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Fixed Value: home |
![]() ![]() ![]() |
S | 0..1 | code | male | female | other | unknown |
![]() ![]() ![]() |
S | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() |
S | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
S | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use |
![]() ![]() ![]() ![]() |
S | 0..1 | Address | An address for the individual |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Fixed Value: home | |
![]() ![]() ![]() ![]() ![]() |
0..2 | string | Street name, number, direction & P.O. Box etc. Slice: Unordered, Open by value:line | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Street name, number, direction & P.O. Box etc. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Name of city, town etc. | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Postal code for area | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |
![]() ![]() ![]() ![]() |
S | 0..* | Address | An address for the individual |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient |
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |
![]() ![]() ![]() |
0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship | |
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health | |
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Patient's nominated primary care provider | |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 2..* | canonical() | Profiles this resource claims to conform to Slice: Unordered, Open by value:uri | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical() | Profiles this resource claims to conform to Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Mother's Maiden name URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-RESPPROVID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-REFDOCID" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner) | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-preferredContact" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patient-birthTime" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-patientAsGuarantor" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-genderIdentity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-sexualOrientation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-guarantorDetails" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(RelatedPerson) | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided]] | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-educationProvided | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupation" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | Extension URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-extension-occupationIndustry" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation]] | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | ||||
![]() ![]() ![]() ![]() |
0..1 | ?gen-e1? [CanonicalType[http://terminology.hl7.org/ValueSet/pronouns]] | Extension URL: http://terminology.hl7.org/ValueSet/pronouns | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://terminology.hl7.org/ValueSet/pronouns" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Value of extension | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:type | ||||
![]() ![]() ![]() |
SΣ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-ssn | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
SΣ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: old | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when name was/is in use | ||||
![]() ![]() ![]() |
Σ | 0..6 | ContactPoint | A contact detail for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: mobile | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: fax | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: pager | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() |
SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | Indicates if the individual is deceased or not | |||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
SΣ | 1..* | Address | An address for the individual Slice: Unordered, Open by value:use | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Address | An address for the individual | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Fixed Value: home | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | ||||
![]() ![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.
| |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() ![]() |
0..* | Reference(Practitioner) | Patient's nominated primary care provider | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||
![]() ![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
![]() |
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 | CommonLanguageshttp://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 | Fixed Value: homehttp://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 | CommonLanguageshttp://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(57 nested mandatory elements)
Must-Support: 56 elements
Fixed: 35 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 |
includePhoto (token) | Include copy of Binary resources referenced by photo element in the response Bundle when includePhoto is true. |
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 |
occupation (token) | Occupation code of the patient |
occupationIndustry (token) | Occupation industry code 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 |
tribalAffiliation (token) | Tribal affiliation code 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.