Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Overview

Organization is used for a collections of people that have come together to achieve an objective. It may be used in a shared registry of contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations.

This profile is used to define the content that will be returned by the API Server in response to requests to access Organization 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: DiagnosticReport, DocumentReference, Goal, Group, Location, Procedure, Provenance.

List of profiles we support:

Definition

The official URL for this profile is:

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

The base definition for this profile is:

Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrganizationI0..*OrganizationA grouping of people or organizations with a common purpose
... idΣ0..1stringLogical id of this artifact
... metaΣ0..1MetaMetadata about the resource
... 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
... ahChartSharingGroup0..1Reference(Organization)athenahealth Chart Sharing Group
URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
... ahPractice0..1Reference(Organization)athenahealth Practice
URL: https://fhir.athena.io/StructureDefinition/ah-practice
... ahProviderGroup0..1Reference(Organization)athenahealth Provider Group
URL: https://fhir.athena.io/StructureDefinition/ah-provider-group
... modifierExtension?!0..*ExtensionExtensions that cannot be ignored
... identifierΣI0..*IdentifierIdentifies this organization across multiple systems
... active?!Σ0..1booleanWhether the organization's record is still in active use
... nameΣI0..1stringName used for the organization
... telecomI0..*ContactPointA contact detail for the organization
... addressI0..*AddressAn address for the organization
... partOfΣ0..1Reference(Organization)The organization of which this organization forms a part
... contact0..*BackboneElementContact for the organization for a certain purpose
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... modifierExtension?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name0..1HumanNameA name associated with the contact
... endpoint0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Detailed Definitions


Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Cardinality 0..*
Type Root

Organization.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 string
Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Organization.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

Organization.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.

Organization.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).

Organization.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.

Organization.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.

Organization.extension

An Extension

Cardinality 0..*
Type Extension

Organization.extension:ahChartSharingGroup

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

Cardinality 0..1
Type Extension(AthenaChartSharingGroup)

Organization.extension:ahPractice

An Extension used to reference a specific athenahealth practice Organization.

Cardinality 0..1
Type Extension(AthenaPractice)

Organization.extension:ahProviderGroup

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

Cardinality 0..1
Type Extension(AthenaProviderGroup)

Organization.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.

Organization.identifier

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Cardinality 0..*
Type Identifier
Requirements Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Organization.active

Whether the organization's record is still in active use.

Cardinality 0..1
Type boolean
Comments This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
Requirements Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

Organization.name

A name associated with the organization.

Cardinality 0..1
Type string
Comments If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Requirements Need to use the name as the label of the organization.

Organization.telecom

A contact detail for the organization.

Cardinality 0..*
Type ContactPoint
Comments The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
Requirements Human contact for the organization.

Organization.address

An address for the organization.

Cardinality 0..*
Type Address
Comments Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
Requirements May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

Organization.partOf

The organization of which this organization forms a part.

Cardinality 0..1
Type Reference(Organization)
Requirements Need to be able to track the hierarchy of organizations within an organization.

Organization.contact

Contact for the organization for a certain purpose.

Cardinality 0..*
Type BackboneElement
Comments Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
Requirements Need to keep track of assigned contact points within bigger organization.

Organization.contact.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

Organization.contact.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.

Organization.contact.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.

Organization.contact.purpose

Indicates a purpose for which the contact can be reached.

Cardinality 0..1
Type CodeableConcept Binding: ContactEntityType (extensible)
Requirements Need to distinguish between multiple contact persons.

Organization.contact.name

A name associated with the contact.

Cardinality 0..1
Type HumanName
Requirements Need to be able to track the person by name.

Organization.endpoint

Technical endpoints providing access to services operated for the organization.

Cardinality 0..*
Type Reference(Endpoint)
Requirements Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.

Interactions

READ

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

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

GET
/fhir/r4/Organization/{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 Organization 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 Organization resources using the HTTP GET method, an application will perform the HTTP GET specifying the query parameters associated with the Organization in the URL.

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

GET
/fhir/r4/Organization
Try in Postman

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 (REQUIRED) Organization.id resource reference to FHIR Organization resource
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
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

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 Organization resources using the HTTP POST method, an application will perform the HTTP POST specifying the query parameters associated with the Organization in the request body.

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

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

Request Header

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

Request Body

param1=value1&param2=value2...

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 (REQUIRED) Organization.id resource reference to FHIR Organization resource
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
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

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