FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/ODSAPI-CapabilityStatement-1

Packagenhsd.assets.stu3
Resource TypeCapabilityStatement
IdODSAPI-CapabilityStatement-1
FHIR VersionR3
Sourcehttps://simplifier.net/resolve?scope=nhsd.assets.stu3@1.7.0&canonical=https://fhir.nhs.uk/STU3/CapabilityStatement/ODSAPI-CapabilityStatement-1
URLhttps://fhir.nhs.uk/STU3/CapabilityStatement/ODSAPI-CapabilityStatement-1
Version1.0.0
Statusactive
Date2018-04-17
NameODSAPI-CapabilityStatement-1
Authorityhl7
DescriptionAn API for retrieving organisation data from the NHS Digital Organisation Data Service.
CopyrightCopyright © 2017 NHS Digital
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

SearchParameter
ODSAPI-OrganizationRole-PrimaryRole-1ODS API Organization Primary Role
ODSAPI-OrganizationRole-Role-1ODS API Organization Role
StructureDefinition
ODSAPI-Organization-1ODSAPI-Organization-1

Narrative

No narrative content found in resource


Source

{
  "resourceType": "CapabilityStatement",
  "meta": {
    "profile": [
      "https://fhir.nhs.uk/STU3/StructureDefinition/NHSDigital-CapabilityStatement-1"
    ]
  },
  "url": "https://fhir.nhs.uk/STU3/CapabilityStatement/ODSAPI-CapabilityStatement-1",
  "version": "1.0.0",
  "name": "ODSAPI-CapabilityStatement-1",
  "status": "active",
  "date": "2018-04-17",
  "publisher": "NHS Digital",
  "contact": [
    {
      "name": "Interoperability Team",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work"
        }
      ]
    }
  ],
  "description": "An API for retrieving organisation data from the NHS Digital Organisation Data Service.",
  "copyright": "Copyright © 2017 NHS Digital",
  "kind": "requirements",
  "fhirVersion": "3.0.1",
  "acceptUnknown": "no",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "implementationGuide": [
    "https://developer.nhs.uk/apis/ods/"
  ],
  "profile": [
    {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-Organization-1"
    },
    {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-ActivePeriod-1"
    },
    {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-ActivePeriod-1"
    },
    {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1"
    },
    {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-UPRN-1"
    },
    {
      "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-DateType-1"
    }
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "cors": true
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
              "extension": [
                {
                  "url": "required",
                  "valueString": "ods-org-primaryRole"
                },
                {
                  "url": "required",
                  "valueString": "ods-org-role"
                }
              ]
            }
          ],
          "type": "Organization",
          "profile": {
            "reference": "https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-Organization-1"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "no-version",
          "readHistory": false,
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalRead": "not-supported",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchParam": [
            {
              "name": "_id",
              "type": "token"
            },
            {
              "name": "_lastUpdated",
              "type": "date"
            },
            {
              "name": "_count",
              "type": "number"
            },
            {
              "name": "_summary",
              "type": "token"
            },
            {
              "name": "identifier",
              "type": "token"
            },
            {
              "name": "name",
              "type": "string"
            },
            {
              "name": "active",
              "type": "token"
            },
            {
              "name": "address-city",
              "type": "string"
            },
            {
              "name": "address-postalcode",
              "type": "string"
            },
            {
              "name": "ods-org-role",
              "definition": "https://fhir.nhs.uk/STU3/SearchParameter/ODSAPI-OrganizationRole-Role-1",
              "type": "token"
            },
            {
              "name": "ods-org-primaryRole",
              "definition": "https://fhir.nhs.uk/STU3/SearchParameter/ODSAPI-OrganizationRole-PrimaryRole-1",
              "type": "token"
            }
          ]
        },
        {
          "type": "CodeSystem",
          "interaction": [
            {
              "code": "read"
            }
          ],
          "versioning": "no-version",
          "readHistory": false,
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalRead": "not-supported",
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "searchParam": [
            {
              "name": "url",
              "type": "string",
              "documentation": "The logical URL for the CodeSystem"
            }
          ]
        }
      ]
    }
  ]
}