The Opala Solution
The Opala Patient Access API Resources and Interactions

SMART App Launch Framework Authorization Flows Access Tokens Scopes Endpoints Working with the FHIR Server

CARIN for Blue Button® Da Vinci Payer Data Exchange (PDex) Mapping Adjudicated Claims and Encounter Information


© 2021-2023 Opala. All Rights Reserved.

Version 1.1.1.0


Contact Opala's
Documentation Team

Organization

The Organization resource is a recognized grouping (formal or informal) of people or organizations formed for the purpose of achieving some form of collective action. The resource includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, and more.

This resource can be used in a shared contact registry and other information for various organizations, or it can be used merely as a support for other resources that need to reference organizations. If you use this resource as a registry, it’s possible for multiple registries to exist, each dealing with different types or levels of organization.

The Organization resource is not the same as the Group resource. The Organization resource is used for collections of people who have come together to achieve an objective. The Group resource is used to identify a collection of people (or animals, devices, etc.) that are gathered for the purpose of analysis or acting upon, but are not expected to act themselves.

The Organization resource often exists as a hierarchy of other organization resources, using the part-of property to provide the association of the child to its parent organization. This organizational hierarchy helps communicate a conceptual structure, where the Location resource provides the physical representation of the hierarchy.

The Organization resource is referenced by these resources:

A-D D-M M-V
Account DocumentReference MedicinalProduct
Annotation Encounter MedicinalProductAuthorization
AuditEvent Endpoint MedicinalProductIngredient
Basic EnrollmentRequest MedicinalProductManufactured
BiologicallyDerivedProduct EnrollmentResponse MedicinalProductPackaged
CapabilityStatement EpisodeOfCare MessageHeader
CarePlan ExplanationOfBenefit MolecularSequence
CareTeam Flag Observation
CatalogEntry Goal Organization (itself)
ChargeItem Group OrganizationAffiliation
Claim HealthcareService Patient
ClaimResponse Identifier PaymentNotice
Communication ImagingStudy PaymentReconciliation
CommunicationRequest Immunization Person
Composition ImmunizationEvaluation Practitioner
Consent ImmunizationRecommendation PractitionerRole
Contract InsurancePlan Procedure
Coverage Invoice Provenance
CoverageEligibilityRequest Linkage QuestionnaireResponse
CoverageEligibilityResponse Location ResearchStudy
Device MeasureReport ServiceRequest
DeviceDefinition Media Signature
DeviceRequest Medication SupplyDelivery
DiagnosticReport MedicationDispense SupplyRequest
DocumentManifest MedicationKnowledge Task
MedicationRequest UsageContext
MedicationStatement VerificationResult

The Organization resource defines the following Slices :

CARIN for Blue Button®

The C4BB Organization structure is derived from USCoreOrganizationProfile (3.24.1)

Anticipated Queries

Use Postman to test Opala's Patient Access API by querying the API and returning the results. The Opala Collection is a group of API requests that are already saved in the Postman app and arranged in folders. You can access Opala's Patient Access Sandbox and, if you have the correct credentials, the production environment as well. For more information see Setting Up Postman in this documentation set.

The Organization resource encompasses companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc. In other words, any grouping of people or organizatons (whether formal or informal) created to achieve some kind of collective action.

Search for All Organizations

To retrieve all oranization reources:

[baseurl]/Organizaton

Search for an Organization by Name

To retrieve all organization resources:

[baseurl]/Organizaton?name=[name]

Search for an Organization by Postal Code

To retrieve all Organization resources:

[baseurl]/Organizaton?address-postalcode=[postalcode]

Note: When searching by Zip Code, Opala recommends you do not use the Zip+4 format. Adding the +4 notation narrows the search to such an extent that the information retieved could be unhelpful. For example, an organization that exists in the 98028 Zip Code but not in the 98028-9998 area, would not be found if the search was for 98028-9998.

Search for an Organization by ID

To retrieve an Organization resource by resource ID:

[baseurl]/Organization/[id]

For More Information

Top