The Organization resource implements the FHIR R4 Organization specification and US Core v3.1.1 Organization profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Identifies this organization across multiple systems (see Profiles for details)
active boolean 1..1 * Whether the organization’s record is still in active use
type CodeableConcept 0..*   Kind of organization
name string 1..1 * Name used for the organization
alias string 0..*   A list of alternate names that the organization is known as, or was known as in the past
telecom ContactPoint 0..*   A contact detail for the organization
address Address 0..*   An address for the organization
address.line string 0..*   Street name, number, direction & P.O. Box etc.
address.city string 0..1   Name of city, town etc.
address.state string 0..1   Sub-unit of country (abbreviations ok) - Binding
address.postalCode string 0..1 US Zip Codes  
address.country string 0..1   Country (e.g. can be ISO 3166 2 or 3 letter code)
partOf Reference 0..1   The organization of which this organization forms a part
contact BackboneElement 0..*   Contact for the organization for a certain purpose
endpoint Reference 0..*   Technical endpoints providing access to services operated for the organization

Interactions

Read

Get an Organization entry by id

GET /Organization/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Organization/6092e2a8-bf40-3b65-9d03-9eb8e7e651c1

Response

{
  "resourceType": "Organization",
  "identifier": [
    {
      "value": "6092e2a8-bf40-3b65-9d03-9eb8e7e651c1",
      "system": "https://github.com/synthetichealth/synthea"
    }
  ],
  "active": true,
  "name": "PCP5851",
  "telecom": [
    {
      "system": "phone",
      "value": "781-585-8199"
    }
  ],
  "address": [
    {
      "line": [
        "68 EVERGREEN ST"
      ],
      "city": "KINGSTON",
      "state": "MA",
      "country": "US",
      "postalCode": "02364-1471"
    }
  ],
  "id": "6092e2a8-bf40-3b65-9d03-9eb8e7e651c1"
}

Query Organization resources

GET /Organization?:query_parameters

Parameters

Name Type Description
identifier token Any identifier for the organization (not the accreditation issuer’s identifier)
partof reference An organization of which this organization forms a part
address string A (part of the) address of the organization
address-state string A state specified in an address
active token A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
type token A code for the type of organization
address-postalcode string A postal code specified in an address
name string A portion of the organization’s name or alias
address-city string A city specified in an address
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found

Profiles

Per the US Core profile an Organization NPI or a CLIA identifiers should be coded using the following system values:

  • NPI: http://hl7.org/fhir/sid/us-npi
  • CLIA: urn:oid:2.16.840.1.113883.4.7