Skip to main content
Read Organization
curl --request GET \
  --url https://{tenant_id}.api.nestmed.com/fhir/r4/Organization/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resourceType": "Organization",
  "id": "<string>",
  "meta": {
    "versionId": "<string>",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "profile": [
      "<string>"
    ],
    "security": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "tag": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ]
  },
  "text": {
    "status": "generated",
    "div": "<string>"
  },
  "extension": [
    {
      "url": "<string>",
      "valueBoolean": true,
      "valueInteger": 123,
      "valueDecimal": 123,
      "valueString": "<string>",
      "valueUri": "<string>",
      "valueDate": "2023-12-25",
      "valueDateTime": "2023-11-07T05:31:56Z",
      "valueCode": "<string>",
      "valueCoding": {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "valueQuantity": {
        "value": 123,
        "comparator": "<",
        "unit": "<string>",
        "system": "<string>",
        "code": "<string>"
      },
      "valuePeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "valueReference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "valueAttachment": {
        "contentType": "<string>",
        "language": "<string>",
        "data": "aSDinaTvuI8gbWludGxpZnk=",
        "url": "<string>",
        "size": 123,
        "hash": "<string>",
        "title": "<string>",
        "creation": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    }
  ],
  "active": true,
  "type": [
    {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    }
  ],
  "name": "<string>",
  "alias": [
    "<string>"
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "<string>",
      "use": "home",
      "rank": 123,
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "address": [
    {
      "use": "home",
      "type": "postal",
      "text": "<string>",
      "line": [
        "<string>"
      ],
      "city": "<string>",
      "district": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "partOf": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "contact": [
    {
      "purpose": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "name": {
        "use": "usual",
        "text": "<string>",
        "family": "<string>",
        "given": [
          "<string>"
        ],
        "prefix": [
          "<string>"
        ],
        "suffix": [
          "<string>"
        ],
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      },
      "telecom": [
        {
          "system": "phone",
          "value": "<string>",
          "use": "home",
          "rank": 123,
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "address": {
        "use": "home",
        "type": "postal",
        "text": "<string>",
        "line": [
          "<string>"
        ],
        "city": "<string>",
        "district": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      }
    }
  ],
  "endpoint": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Response

Organization resource

resourceType
enum<string>
required
Available options:
Organization
id
string
meta
object
text
object
extension
object[]
identifier
object[]
active
boolean
type
object[]
name
string
alias
string[]
telecom
object[]
address
object[]
partOf
object
contact
object[]
endpoint
object[]