Organization - FHIR Resource (stu3)


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

Validate an Organization FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether the organization's record is still in active use
addresstrueAddress# C? An address for the organization
aliastruestring# A list of alternate names that the organization is known as, or was known as in the past
contacttrueData Type# Contact for the organization for a certain purpose
endpointtrueReference# Technical endpoints providing access to services operated for the organization
identifiertrueIdentifier# C? Identifies this organization across multiple systems
namefalsestring# C? Name used for the organization
partOffalseReference# The organization of which this organization forms a part
telecomtrueContactPoint# C? A contact detail for the organization
typetrueCodeableConcept# Kind of organization

Organization Example

{
  "endpoint": [
    {
      "reference": "Endpoint/example"
    }
  ],
  "name": "Health Level Seven International",
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/organization-alias",
      "valueString": "HL7 International"
    }
  ],
  "resourceType": "Organization",
  "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>"
  },
  "telecom": [
    {
      "system": "phone",
      "value": "(+1) 734-677-7777"
    },
    {
      "system": "fax",
      "value": "(+1) 734-677-6622"
    },
    {
      "system": "email",
      "value": "hq@HL7.org"
    }
  ],
  "address": [
    {
      "postalCode": "48104",
      "city": "Ann Arbor",
      "line": [
        "3300 Washtenaw Avenue, Suite 227"
      ],
      "state": "MI",
      "country": "USA"
    }
  ],
  "id": "hl7"
}

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 the like so:

https://api.1up.health/fhir/stu3/Organization?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive.line, active.city, active.state, active.country, active.postalCode, active.text
addresstextaddress
address-citytextaddress.city
address-countrytextaddress.country
address-postalcodetextaddress.postalCode
address-statetextaddress.state
address-usetextaddress.use
endpointreferenceendpoint
identifiertextidentifier
nametextname, alias
partofreferencepartOf
phonetictextname
typetexttype