Patient Profile
This Patient profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read, search, create and update capabilities of these products.
Overview
This resource captures basic and administrative information for an individual receiving care or other health-related services.
Scope and Usage
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.
Source
The Patient resource derives from the PatientProfile table in athenaPractice, and the PERSON table in athenaFlow Specific detail can be found in the Mappings section below.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a Patient, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/Patient/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the Patient resource to retrieve |
| [_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 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 slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 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. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 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. |
Search Operation
Search operations 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]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/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-city (string ) | A city specified in an address |
| address-country (string ) | A country specified in an address |
| address-postalcode (string ) | A postalCode specified in an address |
| address-state (string ) | A state specified in an 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. |
| careprovider (reference ) | Patient's nominated care provider, could be a care manager, not the organization that manages the record |
| deathdate (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 name of the patient |
| gender (token ) | Gender of the patient |
| genderIdentity (token ) | |
| given (string ) | A portion of the given name of the patient |
| identifier (token ) | A patient identifier |
| language (token ) | Language code (irrespective of use value) |
| mothersMaidenName (string ) | |
| name (string ) | A portion of either family or given name of the patient |
| organization (reference ) | The organization at which this person is a patient |
| phone (token ) | A value in a phone contact |
| phonetic (string ) | A portion of either family or given name using some kind of phonetic matching algorithm |
| race (token ) | |
| sexualOrientation (token ) | |
| telecom (token ) | The value in any kind of telecom details of the patient |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 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. |
Create Operation
Create operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Patient resource, an application must perform an HTTP POST, specifying the content of the resource in the body of the request.
POST [base]/fhir/Patient?{_format=[json|xml]}
Create Operation Parameters
| Parameter | Description |
|---|---|
| [_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. |
Create Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 201 Created | The resource was created at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
Update Operation
Update operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Patient resource, an application must perform an HTTP PUT, specifying the content of the resource in the body of the request.
PUT [base]/fhir/Patient/[id]?{_format=[json|xml]}
Update Operation Parameters
| Parameter | Description |
|---|---|
| [_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. |
Update Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The resource was updated at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
Other Operations
This Implementation guide defines 2 operations:
| $ihe-pix | Mobile Patient Identifier Cross-reference Query [ITI-83] |
| $unique | Find Unique Patient |
For more information about operations, including how they are invoked, see Operations .
Mobile Patient Identifier Cross-reference Query [ITI-83]
Look up patient identifiers.
GET [base]/$ihe-pix?{operation-parameters}| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| sourceIdentifier | 1..1 | token | The source identifier for the patient [required]. | ||
| targetSystem | 0..1 | uri | The target identifier space [optional]. | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| targetIdentifier | 0..* | Identifier | The identifier found. | ||
| targetId | 0..* | Reference (Patient ) | The URL of the Patient Resource. | ||
This operation implements the [ITI-83] Mobile Patient Identifier Cross-reference Query transaction specified in the <a target="blank" href="http://www.ihe.net/uploadedFiles/Documents/ITI/IHEITISupplPIXm.pdf">IHE PIXm</a> profile. It is used by the Patient Identifier Cross-reference Consumer to solicit information about patients whose Patient Identifiers cross-match with Patient Identifiers provided in the query parameters of the request message. The request is received by the Patient Identifier Crossreference Manager. The Patient Identifier Cross-reference Manager processes the request and returns a response in the form of zero or more Patient Identifiers for the matching patient.
Find Unique Patient
Locates a unique patient by demographics or returns an error or none or more than one found.
GET [base]/$unique?{operation-parameters}| In Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| birthdate | 1..1 | date | The birthdate of this patient [required] | ||
| family | 1..1 | string | The last name of this patient [required] | ||
| gender | 1..1 | token | The gender of this patient [required] | ||
| given | 1..1 | string | The first or middle name for this patient [required] | ||
| address-postalcode | 0..1 | string | The zip code of the patient [optional] | ||
| 0..1 | token | The email address for this patient [optional] | |||
| identifier | 0..1 | token | Any other identifier known for this patient [optional] | ||
| phone | 0..1 | token | A phone number for this patient [optional] | ||
| telecom | 0..1 | token | A phone number or email address for this patient [optional] | ||
| Out Parameters: | |||||
| Name | Cardinality | Type | Binding | Profile | Documentation |
| return | 1..1 | Patient | The patient that was found. Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource | ||
This operation is used to identify a unique patient based on known patient demographics.
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/patient-profile
Information about an individual receiving health care services
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  Patient | 0..* | Patient | Information about an individual receiving health care services | ||
 meta | ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 us-core-race | S | 0..1 | CodeableConcept | Extension | |
| us-core-ethnicity | S | 0..1 | CodeableConcept | Extension | |
| patient-mothersMaidenName | S | 0..1 | string | Extension | |
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName" | ||
 valueString | 1..1 | string | Value of extension | ||
| patient-extension-RESPPROVID | 0..1 | Reference (Reference) | Extension | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-RESPPROVID" | ||
 valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| patient-extension-REFDOCID | 0..1 | Reference (Reference) | Extension | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-REFDOCID" | ||
| valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| patient-extension-preferredContact | S | 0..1 | string | Extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-preferredContact" | ||
| valueString | 1..1 | string | Value of extension | ||
| patient-birthTime | S | 0..1 | dateTime | Extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | ||
| valueDateTime | 1..1 | dateTime | Value of extension | ||
| patient-extension-patientAsGuarantor | S | 0..1 | boolean | Extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-patientAsGuarantor" | ||
| valueBoolean | 1..1 | boolean | Value of extension | ||
| patient-extension-genderIdentity | S | 0..1 | string | Extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-genderIdentity" | ||
| valueString | 1..1 | string | Value of extension | ||
| patient-extension-sexualOrientation | S | 0..1 | string | Extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-sexualOrientation" | ||
| valueString | 1..1 | string | Value of extension | ||
| patient-extension-guarantorDetails | S | 0..1 | Reference (Reference) | Extension | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-extension-guarantorDetails" | ||
| valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| extension | S | 0..1 | ?? [UriType[http://fhir.org/guides/argonaut/StructureDefinition/argo-race]] | Extensionhttp://fhir.org/guides/argonaut/StructureDefinition/argo-race | |
| extension | S | 0..1 | ?? [UriType[http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity]] | Extensionhttp://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity | |
| extension | S | 0..1 | ?? [UriType[http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex]] | Extensionhttp://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
 identifier | ∑ | Identifier | An identifier for this patient Slice: Unordered, Closed, by type | ||
 identifier | S ∑ | 1..* | Identifier | An identifier for this patient | |
| identifier | S ∑ | 0..1 | Identifier | An identifier for this patient | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| use | ?! ∑ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required ) | |
| type | S ∑ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible ) | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| coding | ∑ | 1..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PI | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | ∑ | 0..1 | string | Plain text representation of the concept | |
| system | S ∑ | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri | |
| value | S ∑ | 1..1 | string | The value that is unique Example: 123456 | |
| period | ∑ | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | ∑ | 0..1 | Reference (Organization ) | Organization that issued id (may be just text) | |
| identifier | ∑ | 0..1 | Identifier | An identifier for this patient | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| use | ?! ∑ | 1..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required ) Fixed Value: secondary | |
| type | S ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible ) | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| coding | ∑ | 1..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: SB | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | ∑ | 0..1 | string | Plain text representation of the concept | |
| system | S ∑ | 1..1 | uri | The namespace for the identifier Fixed Value: http://hl7.org/fhir/sid/us-ssn | |
| value | S ∑ | 1..1 | string | The value that is unique Example: 123456 | |
| period | ∑ | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | ∑ | 0..1 | Reference (Organization ) | Organization that issued id (may be just text) | |
| identifier | ∑ | 0..1 | Identifier | An identifier for this patient | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| use | ?! ∑ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required ) | |
| type | S ∑ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible ) | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| coding | ∑ | 1..1 | Coding | Code defined by a terminology system | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | ∑ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/v2/0203 | |
| version | ∑ | 0..1 | string | Version of the system - if relevant | |
| code | ∑ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |
| display | ∑ | 0..1 | string | Representation defined by the system | |
| userSelected | ∑ | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | ∑ | 0..1 | string | Plain text representation of the concept | |
| system | S ∑ | 1..1 | uri | The namespace for the identifier Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri | |
| value | S ∑ | 1..1 | string | The value that is unique Example: 123456 | |
| period | ∑ | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | ∑ | 0..1 | Reference (Organization ) | Organization that issued id (may be just text) | |
| identifier | ∑ | 0..* | Identifier | An identifier for this patient | |
| active | ?! S∑ | 0..1 | boolean | Whether this patient's record is in active use | |
| name | ∑ | HumanName | A name associated with the patient Slice: Unordered, Open, by USUALNAME | ||
| name | S ∑ | 1..2 | HumanName | A name associated with the patient | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| use | ?! ∑ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required ) Fixed Value: official | |
| text | ∑ | 0..1 | string | Text representation of the full name | |
| family | ∑ | 0..1 | string | Family name (often called 'Surname') | |
| given | ∑ | string | Given names (not always 'first'). Includes middle names Slice: Ordered, Closed, by given | ||
| given | ∑ | 0..2 | string | Given names (not always 'first'). Includes middle names | |
| given | ∑ | 0..1 | string | Given names (not always 'first'). Includes middle names | |
| given | ∑ | 0..1 | string | Given names (not always 'first'). Includes middle names | |
| prefix | ∑ | 0..1 | string | Parts that come before the name | |
| suffix | ∑ | 0..1 | string | Parts that come after the name | |
| period | ∑ | 0..1 | Period | Time period when name was/is in use | |
| name | S ∑ | 1..2 | HumanName | A name associated with the patient | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| use | ?! ∑ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required ) | |
| text | ∑ | 0..1 | string | Text representation of the full name | |
| family | ∑ | 0..* | string | Family name (often called 'Surname') | |
| given | ∑ | 0..1 | string | Given names (not always 'first'). Includes middle names | |
| prefix | ∑ | 0..* | string | Parts that come before the name | |
| suffix | ∑ | 0..* | string | Parts that come after the name | |
| period | ∑ | 0..1 | Period | Time period when name was/is in use | |
| telecom | ∑ | ContactPoint | A contact detail for the individual Slice: Unordered, Closed, by type use | ||
| telecom | S ∑ | 0..6 | ContactPoint | A contact detail for the individual | |
| telecom | ∑ | 0..1 | ContactPoint | A contact detail for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required ) Fixed Value: phone | |
| value | S ∑ | 1..1 | string | The actual contact point details | |
| use | ?! S∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required ) Fixed Value: work | |
| rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | ∑ | 0..1 | Period | Time period when the contact point was/is in use | |
| telecom | ∑ | 0..1 | ContactPoint | A contact detail for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required ) Fixed Value: phone | |
| value | S ∑ | 1..1 | string | The actual contact point details | |
| use | ?! S∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required ) Fixed Value: home | |
| rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | ∑ | 0..1 | Period | Time period when the contact point was/is in use | |
| telecom | ∑ | 0..1 | ContactPoint | A contact detail for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required ) Fixed Value: phone | |
| value | S ∑ | 1..1 | string | The actual contact point details | |
| use | ?! S∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required ) Fixed Value: mobile | |
| rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | ∑ | 0..1 | Period | Time period when the contact point was/is in use | |
| telecom | ∑ | 0..1 | ContactPoint | A contact detail for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required ) Fixed Value: fax | |
| value | S ∑ | 1..1 | string | The actual contact point details | |
| rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | ∑ | 0..1 | Period | Time period when the contact point was/is in use | |
| telecom | ∑ | 0..1 | ContactPoint | A contact detail for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required ) Fixed Value: pager | |
| value | S ∑ | 1..1 | string | The actual contact point details | |
| use | ?! ∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required ) | |
| rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | ∑ | 0..1 | Period | Time period when the contact point was/is in use | |
| telecom | ∑ | 0..1 | ContactPoint | A contact detail for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| system | S ∑I | 1..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required ) Fixed Value: email | |
| value | S ∑ | 1..1 | string | The actual contact point details | |
| use | ?! ∑ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required ) | |
| rank | ∑ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |
| period | ∑ | 0..1 | Period | Time period when the contact point was/is in use | |
| gender | S ∑ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required ) | |
| birthDate | S ∑ | 0..1 | date | The date of birth for the individual | |
 deceased[x] | ?! S∑ | 0..1 | boolean , dateTime | Indicates if the individual is deceased or not | |
| address | S ∑ | 0..1 | Address | Addresses for the individual | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| use | ?! ∑ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required ) Example: home | |
| type | ∑ | 0..1 | code | postal | physical | both Binding: AddressType (required ) Example: both | |
| text | ∑ | 0..1 | string | Text representation of the address Example: 137 Nowhere Street, Erewhon 9132 | |
| line | ∑ | string | Street name, number, direction & P.O. Box etc. Slice: Ordered, Closed, by line Example: 137 Nowhere Street | ||
| line | ∑ | 0..2 | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street | |
| line | ∑ | 0..1 | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street | |
| line | ∑ | 0..1 | string | Street name, number, direction & P.O. Box etc. Example: 137 Nowhere Street | |
| city | ∑ | 0..1 | string | Name of city, town etc. Example: Erewhon | |
| district | ∑ | 0..1 | string | District name (aka county) Example: Madison | |
| state | ∑ | 0..1 | string | Sub-unit of country (abbreviations ok) | |
| postalCode | ∑ | 0..1 | string | Postal code for area Example: 9132 | |
| country | ∑ | 0..1 | string | Country (can be ISO 3166 3 letter code) | |
| period | ∑ | 0..1 | Period | Time period when address was/is in use Example: {"start":"2010-03-23","end":"2010-07-01"} | |
| maritalStatus | S | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required ) | |
| multipleBirth[x] | 0..1 | boolean , integer | Whether patient is part of a multiple birth | ||
| photo | 0..* | Attachment | Image of the patient | ||
| contact | I | 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 | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible ) | ||
| name | 0..1 | HumanName | A name associated with the contact person | ||
| telecom | 0..* | ContactPoint | A contact detail for the person | ||
| address | 0..1 | Address | Address for the contact person | ||
| gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required ) | ||
| organization | I | 0..1 | Reference (Organization ) | Organization that is associated with the contact | |
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | ||
| animal | ?! ∑ | 0..1 | BackboneElement | This patient is known to be an animal (non-human) | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| species | ∑ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example ) | |
| breed | ∑ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example ) | |
| genderStatus | ∑ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example ) | |
| communication | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: IETF BCP-47 (required ) | ||
| preferred | 0..1 | boolean | Language preference indicator | ||
| careProvider | 0..* | Reference (Practitioner ) | Patient's nominated primary care provider | ||
| managingOrganization | ∑ | 0..1 | Reference (Organization ) | Organization that is the custodian of the patient record | |
| link | ?! | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| other | ?! | 1..1 | Reference (Patient ) | The other patient resource that the link refers to | |
| type | ?! | 1..1 | code | replace | refer | seealso - type of link Binding: LinkType (required ) | |
athenaPractice Mapping
The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs.
athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are
the same. Use of this information is subject to the API Server
Terms and Conditions .
| Patient Profile | ||
| Patient | Patient-Profile | FHIR_PATIENTVIEW |
| ├ id | PID | MakeId(%PID%) |
| ├ extension | PATIENTRACEMID | MakeExtensionList(%RACE%,"RACE","http://hl7.org/fhir/StructureDefinition/us-core-race") |
| ├ extension | ETHNICITYMID | MakeExtensionList(%ETHNICITY%,"ETHNICITY","http://hl7.org/fhir/StructureDefinition/us-core-ethnicity") |
| ├ extension | mothersMaidenName | |
| ├ extension | RESPPROVID | |
| ├ extension | REFDOCID | |
| ├ extension | preferredContact | |
| ├ extension | BIRTHTIME | |
| ├ extension | patientAsGuarantor | |
| ├ extension | genderIdentity | |
| ├ extension | sexualOrientation | |
| ├ extension | guarantorDetails | |
| ├ extension | ARGORACEMID | MakeCodingExtension(%RACE%,"RACE","http://fhir.org/guides/argonaut/StructureDefinition/argo-race") |
| ├ extension | ARGOETHNICITYMID | MakeCodingExtension(%ETHNICITY%,"ETHNICITY","http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity") |
| ├ extension | birthsex | MakeCodeExtension(%SEX%, "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex") |
| ├ identifier | Patient Identifiers | |
| ├ identifier | PATIENTID | |
| │ ├ system | getSiteIdSystem("PatientId") | |
| │ └ value | %PATIENTID% | |
| ├ identifier | SOCSECNO | |
| │ └ value | %SOCSECNO% | |
| ├ identifier | MEDRECNO | |
| │ ├ system | getSiteIdSystem("MRN") | |
| │ └ value | %MEDRECNO% | |
| ├ identifier | EXTID | |
| ├ active | PSTATUS | Equals("A",%PSTATUS%) |
| ├ name | USUALNAME | MakeSearchName(%TITLE%,%FIRSTNAME%,%MIDDLENAME%,%LASTNAME%,%ENTITLEMENTS%) |
| │ ├ family | LASTNAME | %LASTNAME% |
| │ ├ given | Given Names | |
| │ ├ given | FIRSTNAME | %FIRSTNAME% |
| │ ├ given | MIDDLENAME | %MIDDLENAME% |
| │ ├ prefix | TITLE | %TITLE% |
| │ └ suffix | ENTITLEMENTS | %ENTITLEMENTS% |
| ├ name | NICKNAME | |
| │ ├ use | "nickname" | |
| │ └ given | %NICKNAME% | |
| ├ telecom | Phone Numbers | |
| ├ telecom | WORKPHONE | |
| │ └ value | %WORKPHONE% | |
| ├ telecom | ALTPHONE | |
| │ └ value | %ALTPHONE% | |
| ├ telecom | CELLPHONE | |
| │ └ value | %CELLPHONE% | |
| ├ telecom | FAXPHONE | |
| │ └ value | %FAXPHONE% | |
| ├ telecom | PAGERPHONE | |
| │ └ value | %PAGERPHONE% | |
| ├ telecom | ||
| │ └ value | %EMAIL% | |
| ├ gender | SEX | MapCode(%SEX%,"GENDER") |
| ├ birthDate | DATEOFBIRTH | %DATEOFBIRTH% |
| ├ deceased[x] | DATEOFDEATH | IfNull(%DATEOFDEATH%).Then(Equals("X",%PSTATUS%)) | IfSet(%DATEOFDEATH%).Then(%DATEOFDEATH%) |
| ├ address | ADDRESS | MakeSearchAddress(%ADDRESS1%,%ADDRESS2%,%CITY%,%STATE%,%ZIP%,%COUNTRY%) |
| │ ├ line | Address Lines | |
| │ ├ line | ADDRESS1 | %ADDRESS1% |
| │ ├ line | ADDRESS2 | %ADDRESS2% |
| │ ├ city | CITY | %CITY% |
| │ ├ state | STATE | %STATE% |
| │ ├ postalCode | ZIP | %ZIP% |
| │ └ country | COUNTRY | %COUNTRY% |
| ├ maritalStatus | MARITALSTATUS | MapConcept(%MARITALSTATUS%,"MARITALSTATUS") |
| ├ photo | PHOTO_ID | MakeBinary("Photo",%PHOTO_ID%) |
| ├ communication | LANGCODE | |
| │ ├ language | MakeConcept(%LANGCODE%,"urn:ietf:bcp:47",%PREFLANG%) | |
| │ └ preferred | true | |
| ├ careProvider | PrimaryCareProvider | MakeReference("USR",%PRICAREID%,"Practitioner") |
| └ managingOrganization | HOMELOCATION | MakeReference("LOCREG",%HOMELOCATION%,"Organization") |
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs.
Use of this information is subject to the API Server
Terms and Conditions .
| Patient Profile | ||
| Patient | Patient-Profile | FHIR_PATIENTVIEW |
| ├ id | PID | MakeId(%PID%) |
| ├ extension | PATIENTRACEMID | MakeExtensionList(%RACE%,"RACE","http://hl7.org/fhir/StructureDefinition/us-core-race") |
| ├ extension | ETHNICITYMID | MakeExtensionList(%ETHNICITY%,"ETHNICITY","http://hl7.org/fhir/StructureDefinition/us-core-ethnicity") |
| ├ extension | mothersMaidenName | |
| ├ extension | RESPPROVID | |
| ├ extension | REFDOCID | |
| ├ extension | preferredContact | |
| ├ extension | BIRTHTIME | |
| ├ extension | patientAsGuarantor | |
| ├ extension | genderIdentity | |
| ├ extension | sexualOrientation | |
| ├ extension | guarantorDetails | |
| ├ extension | ARGORACEMID | MakeCodingExtension(%RACE%,"RACE","http://fhir.org/guides/argonaut/StructureDefinition/argo-race") |
| ├ extension | ARGOETHNICITYMID | MakeCodingExtension(%ETHNICITY%,"ETHNICITY","http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity") |
| ├ extension | birthsex | MakeCodeExtension(%SEX%, "http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex") |
| ├ identifier | Patient Identifiers | |
| ├ identifier | PATIENTID | |
| │ ├ system | getSiteIdSystem("PatientId") | |
| │ └ value | %PATIENTID% | |
| ├ identifier | SOCSECNO | |
| │ └ value | %SOCSECNO% | |
| ├ identifier | MEDRECNO | |
| │ ├ system | getSiteIdSystem("MRN") | |
| │ └ value | %MEDRECNO% | |
| ├ identifier | EXTID | |
| ├ active | PSTATUS | Equals("A",%PSTATUS%) |
| ├ name | USUALNAME | MakeSearchName(%TITLE%,%FIRSTNAME%,%MIDDLENAME%,%LASTNAME%,%ENTITLEMENTS%) |
| │ ├ family | LASTNAME | %LASTNAME% |
| │ ├ given | Given Names | |
| │ ├ given | FIRSTNAME | %FIRSTNAME% |
| │ ├ given | MIDDLENAME | %MIDDLENAME% |
| │ ├ prefix | TITLE | %TITLE% |
| │ └ suffix | ENTITLEMENTS | %ENTITLEMENTS% |
| ├ name | NICKNAME | |
| ├ telecom | Phone Numbers | |
| ├ telecom | WORKPHONE | |
| │ └ value | %WORKPHONE% | |
| ├ telecom | ALTPHONE | |
| │ └ value | %ALTPHONE% | |
| ├ telecom | CELLPHONE | |
| │ └ value | %CELLPHONE% | |
| ├ telecom | FAXPHONE | |
| │ └ value | %FAXPHONE% | |
| ├ telecom | PAGERPHONE | |
| │ └ value | %PAGERPHONE% | |
| ├ telecom | ||
| │ └ value | %EMAIL% | |
| ├ gender | SEX | MapCode(%SEX%,"GENDER") |
| ├ birthDate | DATEOFBIRTH | %DATEOFBIRTH% |
| ├ deceased[x] | DATEOFDEATH | IfNull(%DATEOFDEATH%).Then(Equals("X",%PSTATUS%)) | IfSet(%DATEOFDEATH%).Then(%DATEOFDEATH%) |
| ├ address | ADDRESS | MakeSearchAddress(%ADDRESS1%,%ADDRESS2%,%CITY%,%STATE%,%ZIP%,%COUNTRY%) |
| │ ├ line | Address Lines | |
| │ ├ line | ADDRESS1 | %ADDRESS1% |
| │ ├ line | ADDRESS2 | %ADDRESS2% |
| │ ├ city | CITY | %CITY% |
| │ ├ state | STATE | %STATE% |
| │ ├ postalCode | ZIP | %ZIP% |
| │ └ country | COUNTRY | %COUNTRY% |
| ├ maritalStatus | MARITALSTATUS | MapConcept(%MARITALSTATUS%,"MARITALSTATUS") |
| ├ photo | PHOTO_ID | MakeBinary("Photo",%PHOTO_ID%) |
| ├ communication | LANGCODE | |
| │ ├ language | MakeConcept(%LANGCODE%,"urn:ietf:bcp:47",%PREFLANG%) | |
| │ └ preferred | true | |
| ├ careProvider | PrimaryCareProvider | MakeReference("USR",%PRICAREID%,"Practitioner") |
| └ managingOrganization | HOMELOCATION | MakeReference("LOCREG",%HOMELOCATION%,"Organization") |