Organization - FHIR Resource (r4)

This Organization Resource uses the FHIR API standard for access and structure.

Validate an Organization FHIR Resource (r4)

Validate this Organization

Resource Attributes

Attribute	Field is list	Type	Description
active	false	boolean	# Whether the organization's record is still in active use
address	true	Address	# C? An address for the organization
alias	true	string	# A list of alternate names that the organization is known as, or was known as in the past
contact	true	Data Type	# Contact for the organization for a certain purpose
endpoint	true	Reference	# Technical endpoints providing access to services operated for the organization
identifier	true	Identifier	# C? Identifies this organization across multiple systems
name	false	string	# C? Name used for the organization
partOf	false	Reference	# The organization of which this organization forms a part
telecom	true	ContactPoint	# C? A contact detail for the organization
type	true	CodeableConcept	# Kind of organization

Organization Example

{
  "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"
    }
  ]
}

Organization Structure

{
  "resourceType" : "Organization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // C? Identifies this organization  across multiple systems
  "active" : <boolean>, // Whether the organization's record is still in active use
  "type" : [{ CodeableConcept }], // Kind of organization
  "name" : "<string>", // C? Name used for the organization
  "alias" : ["<string>"], // A list of alternate names that the organization is known as, or was known as in the past
  "telecom" : [{ ContactPoint }], // C? A contact detail for the organization
  "address" : [{ Address }], // C? An address for the organization
  "partOf" : { Reference(Organization) }, // The organization of which this organization forms a part
  "contact" : [{ // Contact for the organization for a certain purpose
    "purpose" : { CodeableConcept }, // The type of contact
    "name" : { HumanName }, // A name associated with the contact
    "telecom" : [{ ContactPoint }], // Contact details (telephone, email, etc.)  for a contact
    "address" : { Address } // Visiting or postal addresses for the contact
  }],
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the organization
}

Organization Search Parameters

The following search parameters can be used to query Organization resources. Just submit them like so:

https://api.1up.health/fhir/r4/Organization?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
active	text	active
address	text	address
address-city	text	address.city
address-country	text	address.country
address-postalcode	text	address.postalCode
address-state	text	address.state
address-use	text	address.use
endpoint	reference	endpoint
identifier	text	identifier
name	text	name
partof	reference	partOf
phonetic	text	name
type	text	type