xCaliber healthCare Data Mesh

Organization

Overview

The Organization API allows creating, retrieving and managing healthcare provider organization directories and profiles. Healthcare developers can use it to build provider search applications, manage organization data in health information exchanges, and integrate with electronic health record systems.

Use Cases

  • Provider Directory - Build an searchable directory of healthcare providers linked to organizations.
  • Referral Management - Create organization profiles for seamless e-referral integration and tracking.
  • Interoperability - Maintain and exchange updated organization data across health information exchanges.
  • Credentialing - Associate organizational affiliations, licenses, certifications to individual providers.
  • Financial Analytics - Link organization profiles with billing/claims data to analyze performance.
  • Relationship Mapping - Build hierarchical representations of healthcare systems and facilities.
  • Demographic Analysis - Collect and analyze data on organization locations, services, populations served.
  • Practice Management - Develop solutions to manage staff, resources, scheduling across organization sites.
  • Quality Measurement - Correlate organization data with clinical quality metrics for benchmarking, improvement.

EHR Data Model

EHRSupported?Mapped Source Object
AthenaDefault Lab, Default Pharmacy, Preferred Pharmacy, Preferred Imaging, Employer
ElationLab Vendor, Insurance Company
EpicN/A

Object Definition

{
  "resourceType": "Organization",
  "id": "hl7",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      Health Level Seven International\n      <br/>\n\t\t\t\t3300 Washtenaw Avenue, Suite 227\n      <br/>\n\t\t\t\tAnn Arbor, MI 48104\n      <br/>\n\t\t\t\tUSA\n      <br/>\n\t\t\t\t(+1) 734-677-7777 (phone)\n      <br/>\n\t\t\t\t(+1) 734-677-6622 (fax)\n      <br/>\n\t\t\t\tE-mail:  \n      <a href=\"mailto:hq@HL7.org\">hq@HL7.org</a>\n    \n    </div>"
  },
  "name": "Health Level Seven International",
  "alias": [
    "HL7 International"
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "(+1) 734-677-7777"
    },
    {
      "system": "fax",
      "value": "(+1) 734-677-6622"
    },
    {
      "system": "email",
      "value": "hq@HL7.org"
    }
  ],
  "address": [
    {
      "line": [
        "3300 Washtenaw Avenue, Suite 227"
      ],
      "city": "Ann Arbor",
      "state": "MI",
      "postalCode": "48104",
      "country": "USA"
    }
  ],
  "endpoint": [
    {
      "reference": "Endpoint/example"
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeOrganizationThis is a Organization resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedBackboneElementThese 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.
extensionExtensionMay be used to represent additional information that is not part of the basic definition of the resource. 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.
modifierExtensionExtensionMay 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).
identifierIdentifierIdentifier for the organization that is used to identify the organization across multiple disparate systems.
activebooleanWhether the organization's record is still in active use.
typeCodeableConceptThe kind(s) of organization that this is.
namestringA name associated with the organization.
aliasstringA list of alternate names that the organization is known as, or was known as in the past.
telecomContactPointA contact detail for the organization.
addressAddressAn address for the organization.
partOfReferenceThe organization of which this organization forms a part.
contactBackboneElementContact for the organization for a certain purpose.
contact.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
contact.extensionExtensionMay 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.
contact.modifierExtensionExtensionMay 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).
contact.purposeCodeableConceptIndicates a purpose for which the contact can be reached.
contact.nameHumanNameA name associated with the contact.
contact.telecomContactPointA contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
contact.addressAddressVisiting or postal addresses for the contact.
endpointReferenceTechnical endpoints providing access to services operated for the organization.

Extensions

NameURL

Operations & APIs

Organization-GET

Organization-POST

Organization ID-GET

Organization ID-PUT

Organization ID-DELETE