HAhalaxy
CapabilityStatement

Get Capability Statement

Changed on

Retrieves a CapabilityStatement resource

get/main/metadata

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/metadata
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Response

CapabilityStatement resource

urlstring

Canonical identifier for this capability statement, represented as a URI (globally unique)

versionstring

Business version of the capability statement

namestring

Name for this capability statement (computer friendly)

titlestring

Name for this capability statement (human friendly)

status'draft' | 'active' | 'retired' | 'unknown'

Capability Statement Status: draft | active | retired | unknown

experimentalboolean

For testing purposes, not real usage

datestring date-time

Date last changed

publisherstring

Name of the publisher (organization or individual)

descriptionstring

Natural language description of the capability statement

purposestring

Why this capability statement is defined

copyrightstring

Use and/or publishing restrictions

kind'instance' | 'capability' | 'requirements'

instance | capability | requirements

instantiatesstring[]

Canonical URL of another capability statement this implements

fhirVersionstring

FHIR Version the system supports

formatstring[]

formats supported (xml | json | ttl | mime type)

patchFormatstring[]

Patch formats supported

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

{
  "rest": [
    {
      "security": {
        "cors": true
      },
      "resource": [
        {
          "referencePolicy": [
            {
              "name": "local",
              "value": "local"
            }
          ]
        }
      ]
    }
  ]
}

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the // response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the //// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the //// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the // response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the //// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the //// response property for the response status (media type: application/json)