HiMS API Documentation

The Capability Statement describes the FHIR server’s functionality, including the resource types that the server supports. Resource type inclusion in this list does not guarantee that such a resource exists in the server, only that it could accept them.

Retrieve the CapabilityStatement via the following unauthenticated API:

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/metadata' \
--header 'Accept: application/fhir+json'
                      

Response schema

{
  "resourceType": "string",
  "id": "string",
  "url": "string",
  "version": "string",
  "name": "string",
  "status": "string",
  "experimental": false,
  "date": "string",
  "publisher": "string",
  "description": "string",
  "kind": "string",
  "instantiates": [
    "string"
  ],
  "software": {
    "name": "string",
    "version": "string",
    "releaseDate": "string"
  },
  "fhirVersion": "string",
  "format": [
    "string"
  ],
  "rest": [
    {
      "mode": "string",
      "security": {
        "extension": [
          {
            "extension": [
              {
                "url": "string",
                "valueUri": "string"
              }
            ],
            "url": "string"
          }
        ],
        "service": [
          {
            "coding": [
              {
                "system": "string",
                "code": "string"
              }
            ],
            "text": "string"
          }
        ]
      },
      "resource": [
        {
          "type": "string",
          "interaction": [
            {
              "code": "string"
            }
          ],
          "versioning": "string",
          "readHistory": false,
          "updateCreate": false,
          "searchParam": [
            {
              "name": "string",
              "type": "string"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "string"
        }
      ],
      "operation": [
        {
          "name": "string",
          "definition": "string"
        }
      ]
    }
  ]
}