Athena Core Implementation Guide
4.2.0 - release
Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir.athena.io/StructureDefinition/ah-patient | Version: 4.2.0 | |||
Active as of 2025-04-17 | Computable Name: AthenahealthPatient | |||
Keywords: Wire Format |
Demographics and other administrative information about an individual receiving care or other health-related services.
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | The logical id for this patient resource, based off the patient's enterprise ID in athenaNet. | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |
![]() ![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this Patient (see Detailed Definitions) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Brand URL: https://fhir.athena.io/StructureDefinition/ah-brand | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex ![]() | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |
![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient. This is based off the patient's enterprise ID in athenaNet. | |
![]() ![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: athenahealth Contact Relationship (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Patient) | The other patient or related person resource that the link refers to | |
![]() |
Path | Conformance | ValueSet | URI |
Patient.contact.relationship | required | AthenahealthContactRelationshiphttps://fhir.athena.io/ValueSet/ah-contact-relationship from this IG |
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 | The logical id for this patient resource, based off the patient's enterprise ID in athenaNet. |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Brand URL: https://fhir.athena.io/StructureDefinition/ah-brand ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex ![]() ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | 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..* | 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 |
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient. This is based off the patient's enterprise ID in athenaNet. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not 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) | 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 | URI |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | The logical id for this patient resource, based off the patient's enterprise ID in athenaNet. | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this Patient (see Detailed Definitions) 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 | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Brand URL: https://fhir.athena.io/StructureDefinition/ah-brand | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex ![]() | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient. This is based off the patient's enterprise ID in athenaNet. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
![]() ![]() ![]() |
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() |
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: athenahealth Contact Relationship (required) | |||||
![]() ![]() ![]() ![]() |
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..* | 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) | 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 | 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.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|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 | required | AthenahealthContactRelationshiphttps://fhir.athena.io/ValueSet/ah-contact-relationship from this IG | ||||
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
Prohibited: 5 elements
Extensions
This structure refers to these extensions:
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 | The logical id for this patient resource, based off the patient's enterprise ID in athenaNet. | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |
![]() ![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this Patient (see Detailed Definitions) | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Brand URL: https://fhir.athena.io/StructureDefinition/ah-brand | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex ![]() | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |
![]() ![]() ![]() |
0..* | Identifier | An identifier for this patient. This is based off the patient's enterprise ID in athenaNet. | |
![]() ![]() ![]() |
0..1 | dateTime | Indicates if the individual is deceased or not | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: athenahealth Contact Relationship (required) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |
![]() ![]() ![]() ![]() |
1..1 | Reference(Patient) | The other patient or related person resource that the link refers to | |
![]() |
Path | Conformance | ValueSet | URI |
Patient.contact.relationship | required | AthenahealthContactRelationshiphttps://fhir.athena.io/ValueSet/ah-contact-relationship from this IG |
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 | The logical id for this patient resource, based off the patient's enterprise ID in athenaNet. |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Brand URL: https://fhir.athena.io/StructureDefinition/ah-brand ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex ![]() ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
0..* | (Complex) | 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..* | 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 |
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient. This is based off the patient's enterprise ID in athenaNet. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not 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) | 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 | URI |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | The logical id for this patient resource, based off the patient's enterprise ID in athenaNet. | ||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this Patient (see Detailed Definitions) 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 | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Brand URL: https://fhir.athena.io/StructureDefinition/ah-brand | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Organization) | athenahealth Provider Group URL: https://fhir.athena.io/StructureDefinition/ah-provider-group | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex ![]() | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity ![]() | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | Tribal Affiliation Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | An identifier for this patient. This is based off the patient's enterprise ID in athenaNet. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
![]() ![]() ![]() |
Σ | 0..* | HumanName | A name associated with the patient | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
![]() ![]() ![]() |
Σ | 0..1 | date | The date of birth for the individual | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | dateTime | Indicates if the individual is deceased or not | ||||
![]() ![]() ![]() |
Σ | 0..* | Address | An address for the individual | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() ![]() |
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: athenahealth Contact Relationship (required) | |||||
![]() ![]() ![]() ![]() |
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..* | 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) | 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 | 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.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|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 | required | AthenahealthContactRelationshiphttps://fhir.athena.io/ValueSet/ah-contact-relationship from this IG | ||||
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
Prohibited: 5 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron