Patient

Demographics and other administrative information about an individual receiving care or other health-related services.

Overview

Data covers the 'who' information about the patient: its attributes are focused on the demographic information necessary to support the administrative, financial and logistic procedures. A Patient record is generally created and maintained by each organization providing care for a patient. A patient receiving care at multiple organizations may therefore have its information present in multiple Patient resources. athenahealth represents FHIR Patient resources based off the concept of a patient enterprise ID. Each physical patient within a practice at athena has a single enterpiseID which ties various patient records across different provider groups.

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 described in the Definition and Detailed Definitions below 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.

This resource is referenced by: AllergyIntolerance, CarePlan, CareTeam, Condition, Device, DiagnosticReport, DocumentReference, Encounter, Goal, Group, Immunization, MedicationRequest, Observation, Procedure, ServiceRequest.

List of profiles we support:

Definition

The official URL for this profile is:

https://fhir.athena.io/StructureDefinition/ah-patient

The base definition for this profile is:

Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient0..*PatientInformation about an individual or animal receiving health care services
... idΣ0..1idThe logical id for this patient resource, based off the patient's enterprise ID in athenaNet.
... metaΣ0..1MetaMetadata about the resource
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionIdΣ0..1idVersion specific identifier
.... lastUpdatedΣ0..1instant (YYYY-MM-DDThh:mm:ss.sss+zz:zz)When the resource version last changed
.... sourceΣ0..1uriIdentifies where the resource comes from
.... profileΣ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... securityΣ0..*CodingSecurity Labels applied to this Patient (see Detailed Definitions)
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tagΣ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules?!Σ0..1uriA set of rules under which this content was created
... text0..1NarrativeText summary of the resource, for human interpretation
... contained0..*ResourceContained, inline Resources
... Slices for extension0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ahBrand0..*Reference(Organization)athenahealth Brand
URL: https://fhir.athena.io/StructureDefinition/ah-brand
... ahChartSharingGroup0..*Reference(Organization)athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
... ahProviderGroup0..*Reference(Organization)athenahealth Provider Group
URL: https://fhir.athena.io/StructureDefinition/ah-provider-group
... us-core-race0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... us-core-ethnicity0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... us-core-birthsex0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... patient-genderIdentity0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
... modifierExtension?!0..*ExtensionExtensions that cannot be ignored
... identifierΣ0..*IdentifierAn identifier for this patient. This is based off the patient's enterprise ID in athenaNet.
... active?!Σ0..1booleanWhether this patient's record is in active use
... nameΣ0..*HumanNameA name associated with the patient
... telecomΣ0..*ContactPointA contact detail for the individual
... genderΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDateΣ0..1date (YYYY-MM-DD)The date of birth for the individual
... addressΣ0..*AddressAn address for the individual
... maritalStatus0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... communication0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... modifierExtension?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... link?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... modifierExtension?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... otherΣ1..1Reference(Patient)The other patient or related person resource that the link refers to
.... typeΣ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Patient.meta.securityextensibleAll Security Labels
Patient.meta.tagexampleCommonTags
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Detailed Definitions


Patient

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Cardinality 0..*
Type Root

Patient.id

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality 0..1
Type id
Comments athenahealth uses globally unique FHIR Patient logical ids based off the patient's enterprise ID in athenaNet.
Requirements FHIR Patient ids are in the format of 'a-{practiceid}.E-{enterpriseid}'.

Patient.meta

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality 0..1
Type Meta

Patient.meta.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1
Type string

Patient.meta.extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Patient.meta.versionId

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality 0..1
Type id
Comments The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Patient.meta.lastUpdated

When the resource last changed - e.g. when the version changed.

Cardinality 0..1
Type instant (YYYY-MM-DDThh:mm:ss.sss+zz:zz)
Comments This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Patient.meta.source

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Cardinality 0..1
Type uri
Comments In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Patient.meta.profile

A list of profiles (references to StructureDefinition.

Cardinality 0..*
Type canonical
Comments It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Patient.meta.security

Security labels applied to this Patient. These tags define handling caveats for this data and must be carried forward, as appropriate, with this Patient.

Cardinality 0..*
Type Coding Binding: All Security Labels (extensible)
Comments meta.security may contain the following security labels:
  • R (restricted): This patient is marked as 'record restriction' within athenaOne
  • PDS (patient default information sensitivity): This patient is marked as 'blocked patient' within athenaOne

Patient.meta.tag

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Cardinality 0..*
Type Coding Binding: CommonTags (example)
Comments The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Patient.implicitRules

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality 0..1
Type uri
Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Patient.language

The base language in which the resource is written.

Cardinality 0..1
Type code Binding: CommonLanguages (preferred)
Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Patient.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality 0..1
Type Narrative
Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Patient.contained

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality 0..*
Type Resource
Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Patient.extension

An Extension

Cardinality 0..*
Type Extension

Patient.extension:ahBrand

An Extension used to reference a specific athenahealth brand Organization.

Cardinality 0..*
Type Extension(AthenaBrand)

Patient.extension:ahChartSharingGroup

An Extension used to reference a specific athenahealth chart sharing group Organization.

Cardinality 0..*
Type Extension(AthenaChartSharingGroup)

Patient.extension:ahProviderGroup

An Extension used to reference a specific athenahealth provider group Organization.

Cardinality 0..*
Type Extension(AthenaProviderGroup)

Patient.extension:us-core-race

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: - American Indian or Alaska Native - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White.

Cardinality 0..1
Type Extension(USCoreRaceExtension)

Patient.extension:us-core-ethnicity

Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.

Cardinality 0..1
Type Extension(USCoreEthnicityExtension)

Patient.extension:us-core-birthsex

A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC).

Cardinality 0..1
Type Extension(USCoreBirthSexExtension)
Comments The codes required are intended to present birth sex (i.e., the sex recorded on the patient's birth certificate) and not gender identity or reassigned sex.

Patient.extension:patient-genderIdentity

The gender the patient identifies with. The Patient's gender identity is used as guidance (e.g. for staff) about how to interact with the patient.

Cardinality 0..1
Type Extension(genderIdentity)

Patient.modifierExtension

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Requirements Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Patient.identifier

An identifier for this patient. This is based off the patient's enterprise ID in athenaNet.

Cardinality 0..*
Type Identifier
Comments athenahealth uses globally unique Patient identifiers based off the patient's enterprise ID in athenaNet.
Requirements FHIR Patient identifiers are in the format of 'a-{practiceid}.E-{enterpriseid}'.

Patient.active

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

Cardinality 0..1
Type boolean
Comments If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.
Requirements Need to be able to mark a patient record as not to be used because it was created in error.

Patient.name

A name associated with the individual.

Cardinality 0..*
Type HumanName
Comments A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.
Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Patient.telecom

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.

Cardinality 0..*
Type ContactPoint
Comments A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
Requirements People have (primary) ways to contact them in some way such as phone, email.

Patient.gender

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

Cardinality 0..1
Type code Binding: AdministrativeGender (required)
Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.
Requirements Needed for identification of the individual, in combination with (at least) name and birth date.

Patient.birthDate

The date of birth for the individual.

Cardinality 0..1
Type date (YYYY-MM-DD)
Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems).
Requirements Age of the individual drives many clinical processes.

Patient.address

An address for the individual.

Cardinality 0..*
Type Address
Comments Patient may have multiple addresses with different uses or applicable periods.
Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Patient.maritalStatus

This field contains a patient's most recent marital (civil) status.

Cardinality 0..1
Type CodeableConcept Binding: Marital Status Codes (extensible)
Requirements Most, if not all systems capture it.

Patient.communication

A language which may be used to communicate with the patient about his or her health.

Cardinality 0..*
Type BackboneElement
Comments If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.

Patient.communication.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1
Type string

Patient.communication.extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Patient.communication.modifierExtension

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Requirements Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Patient.communication.language

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Cardinality 1..1
Type CodeableConcept Binding: CommonLanguages (preferred)
Comments The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.
Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Patient.link.id

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1
Type string

Patient.link.extension

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Patient.link.modifierExtension

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*
Type Extension
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Requirements Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Patient.link.other

The other patient resource that the link refers to.

Cardinality 1..1
Type Reference(Patient)
Comments Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

Patient.link.type

The type of link between this patient resource and another patient resource.

Cardinality 1..1
Type code Binding: LinkType (required)

Interactions

READ

Read interactions are executed as specified in the HL7 FHIR RESTful API read specification. To read Patient resources, an application will perform an HTTP GET specifying the logical ID of the Patient being retrieved.

The [patient|user|system]/Patient.read authorization scope is required.

GET
/fhir/r4/Patient/{logicalId}
Try in Postman

Parameters

required

conditional required

Name Type Description
logicalId string (REQUIRED) The logical ID of the resource (alias: Resource.id). It is specified in the URL path and not as a query parameter.

Response Codes

Response code Description
200 OK The requested Patient resource was found and is contained within the body of the HTTP response.
400 Bad Request The server could not understand the request due to invalid syntax. The body of the HTTP response will contain an OperationOutcome resource that indicates the invalid request could not be processed.
404 Not Found The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
410 Gone The requested resource has been permanently deleted from server with no forwarding address. The body of the HTTP response will contain an OperationOutcome resource that indicates the resource could not be found.
500 Internal Server Error The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx 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.

GET SEARCH

Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for Patient resources using the HTTP GET method, an application will perform the HTTP GET specifying the query parameters associated with the Patient in the URL.

The [patient|user|system]/Patient.read authorization scope is required.

The following additional authorization scopes might be required depending on _include and/or _revinclude search parameters used:

  • [patient|user|system]/Organization.read
  • [patient|user|system]/Provenance.read

GET
/fhir/r4/Patient
Try in Postman

Parameters

Patient search requests conditionally require one of the following search parameters or search parameter combinations in order to match and return a result set:

  • _id
  • identifier
  • name
  • family, birthdate
  • family, gender
  • family, given

NOTE: When a 'system' scope is used (i.e., 2-legged authentication) AND the '_id' search parameter is NOT selected, the 'ah-practice' search parameter must be included with any other search parameters.

required

conditional required

Name Type Description
ah-practice reference Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]')
_id token (CONDITIONAL REQUIRED) Patient.id resource reference to FHIR Patient resource
identifier token (CONDITIONAL REQUIRED) A patient identifier
name string (CONDITIONAL REQUIRED) A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, suffix, and/or text
birthdate date (CONDITIONAL REQUIRED) The patient's date of birth
gender token (CONDITIONAL REQUIRED) Gender of the patient
family string (CONDITIONAL REQUIRED) A portion of the family name of the patient
given string (CONDITIONAL REQUIRED) A portion of the given name of the patient
ah-brand reference Search by athenahealth Brand (e.g., 'ah-brand=Organization/a-[practiceId].Brand-[brandId]') for resources containing the 'Athena Brand' Extension
ah-chart-sharing-group reference Search by athenahealth Chart Sharing Group (e.g., 'ah-chart-sharing-group=Organization/a-[practiceId].CSG-[csgId]') for resources containing the 'Athena Chart Sharing Group' Extension
ah-department reference Search by athenahealth Department (e.g., 'ah-department=Organization/a-[practiceId].Department-[deptId]') for resources containing the 'Athena Department' Extension
ah-provider-group reference Search by athenahealth Provider Group (e.g., 'ah-provider-group=Organization/a-[practiceId].PG-[providerGroupId]') for resources containing the 'Athena Provider Group' Extension
_count number The number of Patient resources to return per page for paged search results.
cursor token Search by cursor token for first resource to return in a paged search result
_include string Requests the server to include the referenced resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _include parameter values are:
  • Patient:ah-chart-sharing-group - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
  • Patient:ah-brand - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
  • Patient:ah-provider-group - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
_revinclude string Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _revinclude parameter values are:
  • Provenance:target - Associated resource(s) Provenance and required scope(s) [patient|user|system]/Provenance.read

Response Codes

Response code Description
200 OK The search request succeeded. The body of the HTTP response will contain a Bundle resource containing the results of the search.
403 Forbidden The server refused to perform the search due to a missing required search parameter. The body of the HTTP response will contain an OperationOutcome resource that includes the required search parameters.
500 Internal Server Error The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx 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.

POST SEARCH

Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for Patient resources using the HTTP POST method, an application will perform the HTTP POST specifying the query parameters associated with the Patient in the request body.

The [patient|user|system]/Patient.read authorization scope is required.

The following additional authorization scopes might be required depending on _include and/or _revinclude search parameters used:

  • [patient|user|system]/Organization.read
  • [patient|user|system]/Provenance.read

POST
/fhir/r4/Patient/_search
Try in Postman

Request Header

Content-Type: application/x-www-form-urlencoded

Request Body

param1=value1&param2=value2...

Parameters

Patient search requests conditionally require one of the following search parameters or search parameter combinations in order to match and return a result set:

  • _id
  • identifier
  • name
  • family, birthdate
  • family, gender
  • family, given

NOTE: When a 'system' scope is used (i.e., 2-legged authentication) AND the '_id' search parameter is NOT selected, the 'ah-practice' search parameter must be included with any other search parameters.

required

conditional required

Name Type Description
ah-practice reference Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]')
_id token (CONDITIONAL REQUIRED) Patient.id resource reference to FHIR Patient resource
identifier token (CONDITIONAL REQUIRED) A patient identifier
name string (CONDITIONAL REQUIRED) A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, suffix, and/or text
birthdate date (CONDITIONAL REQUIRED) The patient's date of birth
gender token (CONDITIONAL REQUIRED) Gender of the patient
family string (CONDITIONAL REQUIRED) A portion of the family name of the patient
given string (CONDITIONAL REQUIRED) A portion of the given name of the patient
ah-brand reference Search by athenahealth Brand (e.g., 'ah-brand=Organization/a-[practiceId].Brand-[brandId]') for resources containing the 'Athena Brand' Extension
ah-chart-sharing-group reference Search by athenahealth Chart Sharing Group (e.g., 'ah-chart-sharing-group=Organization/a-[practiceId].CSG-[csgId]') for resources containing the 'Athena Chart Sharing Group' Extension
ah-department reference Search by athenahealth Department (e.g., 'ah-department=Organization/a-[practiceId].Department-[deptId]') for resources containing the 'Athena Department' Extension
ah-provider-group reference Search by athenahealth Provider Group (e.g., 'ah-provider-group=Organization/a-[practiceId].PG-[providerGroupId]') for resources containing the 'Athena Provider Group' Extension
_count number The number of Patient resources to return per page for paged search results.
cursor token Search by cursor token for first resource to return in a paged search result
_include string Requests the server to include the referenced resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _include parameter values are:
  • Patient:ah-chart-sharing-group - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
  • Patient:ah-brand - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
  • Patient:ah-provider-group - Included resource(s) Organization and required scope(s) [patient|user|system]/Organization.read
_revinclude string Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Additional authorization scope(s) will be required. The supported _revinclude parameter values are:
  • Provenance:target - Associated resource(s) Provenance and required scope(s) [patient|user|system]/Provenance.read

Response Codes

Response code Description
200 OK The search request succeeded. The body of the HTTP response will contain a Bundle resource containing the results of the search.
403 Forbidden The server refused to perform the search due to a missing required search parameter. The body of the HTTP response will contain an OperationOutcome resource that includes the required search parameters.
500 Internal Server Error The server has encountered a situation it doesn't know how to handle. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.
5xx 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.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page