Jump to

• Request
• Response

Get an organization by ID

get

/Organization/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual organization by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Organization

Type: object

A formally or informally recognized grouping of people or organizations.

Show Source

• active(required): boolean
  Whether the organization record is active.
• address: array address
  The addresses for the organization.
• id(required): string
  The logical ID of the organization.
• identifier(required): array identifier
  The identifiers for the organization.
• name(required): string
  The human-readable organization name.
• resourceType(required): string
  Allowed Values: [ "Organization" ]
• telecom: array telecom
  The contact details for the organization.

{
    "type":"object",
    "description":"A formally or informally recognized grouping of people or organizations.",
    "required":[
        "resourceType",
        "id",
        "active",
        "name",
        "identifier"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Organization"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the organization."
        },
        "active":{
            "type":"boolean",
            "description":"Whether the organization record is active."
        },
        "name":{
            "type":"string",
            "description":"The human-readable organization name."
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierForOrganization"
            },
            "description":"The identifiers for the organization."
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPointForOrganization"
            },
            "description":"The contact details for the organization."
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            },
            "description":"The addresses for the organization."
        }
    }
}

Nested Schema : address

Type: array

The addresses for the organization.

Show Source

• Array of: object Address

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Address"
    },
    "description":"The addresses for the organization."
}

Nested Schema : identifier

Type: array

The identifiers for the organization.

Show Source

• Array of: object IdentifierForOrganization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IdentifierForOrganization"
    },
    "description":"The identifiers for the organization."
}

Nested Schema : telecom

Type: array

The contact details for the organization.

Show Source

• Array of: object ContactPointForOrganization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPointForOrganization"
    },
    "description":"The contact details for the organization."
}

Nested Schema : Address

Type: object

Show Source

• city: string
• country: string
• district: string
• line: array line
• period: object Period
• postalCode: string
• state: string
• text: string
• type: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "line":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : line

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierForOrganization

Type: object

Show Source

• extension: array extension
• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string
  The contact value.

{
    "type":"object",
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "value":{
            "type":"string",
            "description":"The contact value."
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : Extension

Type: object

Show Source

• url: string (uri)
• valueCode: string

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueCode":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : ContactPointForOrganization

Type: object

Show Source

• extension: array extension
• period: object Period
• rank: integer
• system: string
• use: string
• value: string

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "use":{
            "type":"string"
        },
        "rank":{
            "type":"integer"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Extension"
            }
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object Extension

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Extension"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top