Extensions
Overview
The following Extensions have been defined to support athenahealth requirements. The API Reference documentation for each supported FHIR resource documents any athenahealth-specific Extensions used by that resource.
athenahealth Brand
Overview
athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.
A provider group is an organizational entity representing a set of providers within a practice.
A brand is an organizational grouping of one or more provider groups used to define a consistent patient-facing brand experience for patients interacting with those provider groups. This includes Patient Portal look and feel, automated messaging preferences, etc.
Every brand is identified by a single numeric Brand ID and is associated to a specific practice in athenahealth. It is represented as a FHIR Organization having an Organization.id
defined by a-{PID}.Brand-{ID}
where {PID}
is the Practice ID and {ID}
is the Brand ID. This resource-level extension is used to specify the appropriate brand for appropriate athenahealth FHIR resources as a literal reference to a FHIR Organization.
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-brand
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Brand | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-brand" | |
![]() ![]() ![]() | 1..1 | Reference(Organization) | Reference to athenahealth Organization for 'brand' | |
![]() |
Detailed Definitions
Extension
An Extension used to reference a specific athenahealth brand Organization.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-brand' |
Extension.value[x]
Reference to athenahealth Organization for 'brand'
Cardinality | 1..1 |
Type | Reference(Organization) |
athenahealth Chart Sharing Group
Overview
athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.
A provider group is an organizational entity representing a set of providers within a practice.
A chart sharing group is an organizational entity used to share clinical charts across provider groups that have separate financial data. By default, a practice is configured with one chart sharing group for the entire practice, but additional chart sharing groups can be defined to separate clinical data within a practice as desired.
Every chart sharing group is identified by a single numeric Chart Sharing Group ID and is associated to a specific practice in athenahealth. It is represented as a FHIR Organization having an Organization.id
defined by a-{PID}.CSG-{ID}
where {PID}
is the Practice ID and {ID}
is the Chart Sharing Group ID. This resource-level extension is used to specify the appropriate chart sharing group for appropriate athenahealth FHIR resources as a literal reference to a FHIR Organization.
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Chart Sharing Group | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group" | |
![]() ![]() ![]() | 1..1 | Reference(Organization) | Reference to athenahealth Organization for 'chart sharing group' | |
![]() |
Detailed Definitions
Extension
An Extension used to reference a specific athenahealth chart sharing group Organization.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group' |
Extension.value[x]
Reference to athenahealth Organization for 'chart sharing group'
Cardinality | 1..1 |
Type | Reference(Organization) |
athenahealth Condition Problem Type Category
Overview
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-condition-problem-type-category
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Condition Problem Type Category | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-condition-problem-type-category" | |
![]() ![]() ![]() | 1..1 | code | Type category of an Athena problem. Acute or Chronic. Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() | 0..1 | code | Value of extension Binding: athenahealth Condition Problem Type Category Value Set (required) | |
![]() |
Detailed Definitions
Extension
An Extension to Condition for problems that contains the type of the problem.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-condition-problem-type-category' |
Extension.value[x]
Athenahealth Problems can have a type category. It can be acute, chronic or not selected.
Cardinality | 1..1 |
Type | code |
Extension.value[x]:valueCode
Value of extension - must be one of a constrained set of the data types (see Extensibility.
Cardinality | 0..1 |
Type | code Binding: AthenaConditionProblemTypeCategoryValueSet (required) |
athenahealth Department
Overview
athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.
A provider group is an organizational entity representing a set of providers within a practice.
A chart sharing group is an organizational entity used to share clinical charts across provider groups.
A department is a location or an organizational entity representing any place of service where a provider in a practice sees patients. A department can be a site of registration such as a medical office or a site where services are rendered such as the emergency room. A department can be used to associate provider groups and/or chart sharing groups in a practice to simplify its grouping of providers and their access to patient clinical data.
Every department is identified by a single numeric Department ID and is associated to a specific practice in athenahealth. It is represented as a FHIR Organization having an Organization.id
defined by a-{PID}.Department-{ID}
where {PID}
is the Practice ID and {ID}
is the Department ID. This resource-level extension is used to specify the appropriate department for appropriate athenahealth FHIR resources as a literal reference to a FHIR Organization.
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-department
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Department | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-department" | |
![]() ![]() ![]() | 1..1 | Reference(Organization | Location) | Reference to athenahealth Organization for 'department' | |
![]() |
Detailed Definitions
Extension
An Extension used to reference a specific athenahealth department Organization.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-department' |
Extension.value[x]
Reference to athenahealth Organization for 'department'
Cardinality | 1..1 |
Type | Reference(Organization | Location) |
athenahealth Device Implant Details
Overview
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-device-implant-details
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Device Implant Details | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..1 | Extension | The side of the patient's body where the device is implanted | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "side" | |
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | The side of the patient's body where the device is implanted | |
![]() ![]() ![]() | 0..1 | Extension | The site on the patient's body where the device is implanted | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "site" | |
![]() ![]() ![]() ![]() | 0..1 | string | The site on the patient's body where the device is implanted | |
![]() ![]() ![]() | 0..1 | Extension | The date that the device was implanted in the patient | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "implantDate" | |
![]() ![]() ![]() ![]() | 0..1 | dateTime (YYYY-MM-DDThh:mm:ss+zz:zz) | The date that the device was implanted in the patient | |
![]() ![]() ![]() | 0..1 | Extension | The date that the device was removed from the patient | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "removalDate" | |
![]() ![]() ![]() ![]() | 0..1 | dateTime (YYYY-MM-DDThh:mm:ss+zz:zz) | The date that the device was removed from the patient | |
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-device-implant-details" | |
![]() |
Detailed Definitions
Extension
An Extension containing details about a Device and the implant details for the referenced patient.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.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. |
Extension.extension:side
The side of the patient's body where the device is implanted
Cardinality | 0..1 |
Type | Extension |
Extension.extension:side.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 |
Extension.extension:side.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Extension.extension:side.value[x]
The side of the patient's body where the device is implanted
Cardinality | 0..1 |
Type | CodeableConcept |
Extension.extension:site
The site on the patient's body where the device is implanted
Cardinality | 0..1 |
Type | Extension |
Extension.extension:site.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 |
Extension.extension:site.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Extension.extension:site.value[x]
The site on the patient's body where the device is implanted
Cardinality | 0..1 |
Type | string |
Extension.extension:implantDate
The date that the device was implanted in the patient
Cardinality | 0..1 |
Type | Extension |
Extension.extension:implantDate.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 |
Extension.extension:implantDate.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Extension.extension:implantDate.value[x]
The date that the device was implanted in the patient
Cardinality | 0..1 |
Type | dateTime (YYYY-MM-DDThh:mm:ss+zz:zz) |
Extension.extension:removalDate
The date that the device was removed from the patient
Cardinality | 0..1 |
Type | Extension |
Extension.extension:removalDate.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 |
Extension.extension:removalDate.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Extension.extension:removalDate.value[x]
The date that the device was removed from the patient
Cardinality | 0..1 |
Type | dateTime (YYYY-MM-DDThh:mm:ss+zz:zz) |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-device-implant-details' |
athenahealth Document
Overview
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-document
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Document | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-document" | |
![]() ![]() ![]() | 1..1 | Reference(DocumentReference) | Reference to a specific athenahealth document | |
![]() |
Detailed Definitions
Extension
An Extension used to reference a specific athenahealth document.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-document' |
Extension.value[x]
Reference to a specific athenahealth document
Cardinality | 1..1 |
Type | Reference(DocumentReference) |
athenahealth Practice
Overview
athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.
Every practice is identified by a single numeric Practice ID within athenahealth. It is represented as a FHIR Organization having an Organization.id
defined by a-1.Practice-{PID}
where {PID}
is the Practice ID. This resource-level extension is used to specify the appropriate practice (tenant) for all athenahealth FHIR resources as a literal reference to a FHIR Organization.
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-practice
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Practice | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-practice" | |
![]() ![]() ![]() | 1..1 | Reference(Organization) | Reference to athenahealth Organization for 'practice' | |
![]() |
Detailed Definitions
Extension
An Extension used to reference a specific athenahealth practice Organization.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-practice' |
Extension.value[x]
Reference to athenahealth Organization for 'practice'
Cardinality | 1..1 |
Type | Reference(Organization) |
Comments | **NOTE:** 'practice' also known as 'context' |
athenahealth Provider Group
Overview
athenahealth provides a multi-tenant SaaS platform on which our customers provide healthcare services to their patients. Tenants are defined as practices within athenahealth. In general, a practice can be a hospital, medical center, clinic, or any other healthcare-related entity. Typically, a practice represents the business entity that provides healthcare services and can be in a single location or spread across multiple locations.
A provider group is an organizational entity representing a set of providers within a practice. It allows a practice to group sets of providers, often in the same specialty and/or location, who share all financial information. Within an athenaEnterprise organization, financial and appointment data as well as patient demographic information are segmented using provider groups.
Every provider group is identified by a single numeric Provider Group ID and is associated to a specific practice in athenahealth. It is represented as a FHIR Organization having an Organization.id
defined by a-{PID}.PG-{ID}
where {PID}
is the Practice ID and {ID}
is the Provider Group ID. This resource-level extension is used to specify the appropriate provider group for appropriate athenahealth FHIR resources as a literal reference to a FHIR Organization.
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-provider-group
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Provider Group | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-provider-group" | |
![]() ![]() ![]() | 1..1 | Reference(Organization) | Reference to athenahealth Organization for 'provider group' | |
![]() |
Detailed Definitions
Extension
An Extension used to reference a specific athenahealth provider group Organization.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-provider-group' |
Extension.value[x]
Reference to athenahealth Organization for 'provider group'
Cardinality | 1..1 |
Type | Reference(Organization) |
athenahealth Search Parameter Metadata
Overview
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Search Parameter Metadata | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | 0..* | Extension | Collection of 'always required' (REQUIRED) SearchParameters | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "requiredSearchParams" | |
![]() ![]() ![]() ![]() | 1..1 | string | SearchParameter.code value for an 'always required' (REQUIRED) SearchParameter | |
![]() ![]() ![]() | 0..* | Extension | Collection of 'required any' (CONDITIONAL REQUIRED) SearchParameters | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() ![]() | 1..1 | uri | "requiredAnySearchParams" | |
![]() ![]() ![]() ![]() | 1..1 | string | SearchParameter.code value for a 'required any' (CONDITIONAL REQUIRED) SearchParameter | |
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata" | |
![]() |
Detailed Definitions
Extension
This extension contains metadata regarding a resource's collection of supported search parameters.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.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. |
Extension.extension:requiredSearchParams
Collection of 'always required' (REQUIRED) SearchParameters
Cardinality | 0..* |
Type | Extension |
Extension.extension:requiredSearchParams.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 |
Extension.extension:requiredSearchParams.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Extension.extension:requiredSearchParams.value[x]
SearchParameter.code value for an 'always required' (REQUIRED) SearchParameter.
Cardinality | 1..1 |
Type | string |
Extension.extension:requiredAnySearchParams
Collection of 'required any' (CONDITIONAL REQUIRED) SearchParameters
Cardinality | 0..* |
Type | Extension |
Extension.extension:requiredAnySearchParams.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 |
Extension.extension:requiredAnySearchParams.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Extension.extension:requiredAnySearchParams.value[x]
SearchParameter.code value for a 'required any' (CONDITIONAL REQUIRED) SearchParameter.
Cardinality | 1..1 |
Type | string |
Comments | This can be a single SearchParameter.code value or a comma-delimited list of related SearchParameter.code values that represents a single search. |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-search-parameter-metadata' |
athenahealth Section Note
Overview
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-section-note
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Section Note | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-section-note" | |
![]() ![]() ![]() | 1..1 | string | Additional information about the Resource | |
![]() |
Detailed Definitions
Extension
An Extension containing a notes field that appears in athenahealth for a particular data section.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-section-note' |
Extension.value[x]
Additional information about the Resource, as documented by a user for the entire section of the chart data. This value may appear in all Resources that are populated from a given section of the chart.
Cardinality | 1..1 |
Type | string |
athenahealth Sortable Search Parameter
Overview
Definition
The official URL for this extension is:
https://fhir.athena.io/StructureDefinition/ah-sortable-search-parameter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Extension | athenahealth Sortable Search Parameter | |
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | uri | "https://fhir.athena.io/StructureDefinition/ah-sortable-search-parameter" | |
![]() ![]() ![]() | 1..1 | boolean | If true, the resource supports sorting on this SearchParameter | |
![]() |
Detailed Definitions
Extension
This extension is a boolean flag that indicates whether the CapabilityStatement.rest.resource.searchParam instance is sortable. Assume false when this extension is not provided.
Cardinality | 0..* |
Type | Root |
Extension.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 |
Extension.url
Source of the definition for the extension code - a logical name or a URL.
Cardinality | 1..1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Requirements | The fixed value for this attribute is 'https://fhir.athena.io/StructureDefinition/ah-sortable-search-parameter' |
Extension.value[x]
If true, the resource supports sorting on this SearchParameter
Cardinality | 1..1 |
Type | boolean |