Home
API reference
FHIR® API
FHIR® resources
Organization
read

Organization read

get/Organization/{id}
Page View

This resource defines a group of individuals or clinicians that form an organization of some kind. An organization record may consist of multiple organizations, like an umbrella healthcare organization with multiple physical locations.

You can review, retrieve, create, or update organization records.

read

Review a specific Organization resource with an organization record for a group of individuals or clinicians.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Organization/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

  • id
    required, string

    Organization identifier

Response fields and example

json
1
{}

    A grouping of people or organizations with a common purpose

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Organization
  • active
    required, boolean

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

  • name
    required, string

    A name associated with the organization.

  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • identifier
    Array of NPI or Other

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

    • system
      required, string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

      Value: http://hl7.org/fhir/sid/us-npi
    • extension
      Array of Boolean, String, CodeableConcept, Coding

      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.

      • url
        required, string

        Source of the definition for the extension code - a logical name or a URL.

      • valueBoolean
        boolean

        A single value for the extension.

    • use
      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • value
      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • type
    Array of object

    The kind(s) of organization that this is.

    • coding
      Array of object

      A reference to a code defined by a terminology system.

      • system
        string

        The identification of the code system that defines the meaning of the symbol in the code.

      • code
        string

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    • text
      string

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

  • telecom
    Array of object

    A contact detail for the organization.

    • system
      string

      Telecommunications form for contact point - what communications system is required to make use of the contact.

      Possible Values: phone, fax, email, pager, url, sms, other
    • value
      string

      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

    • use
      string

      Identifies the purpose for the contact point.

      Possible Values: home, work, temp, old, mobile
  • address
    Array of object

    An address for the organization.

    • line
      Array of string

      This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

    • city
      string

      The name of the city, town, suburb, village or other community or delivery center.

    • state
      string

      Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).

    • postalCode
      string

      A postal code designating a region defined by the postal service.

    • country
      string

      Country - a nation as commonly understood or generally accepted.

    • use
      string

      The purpose of this address.

      Possible Values: home, work, temp, old, billing
    • district
      string

      The name of the administrative area (county).

  • partOf
    object

    The organization of which this organization forms a part.

    Must be a resource of type Organization.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.