{
"description": "An API for retrieving organisation data from the NHS Digital Organisation Data Service.",
"_filename": "ODSAPI-CapabilityStatement-1.json",
"package_name": "NHSD.Assets.STU3",
"format": [ "application/fhir+xml", "application/fhir+json" ],
"date": "2018-04-17",
"meta": {
"profile": [ "https://fhir.nhs.uk/STU3/StructureDefinition/NHSDigital-CapabilityStatement-1" ]
},
"publisher": "NHS Digital",
"fhirVersion": "3.0.1",
"name": "ODSAPI-CapabilityStatement-1",
"acceptUnknown": "no",
"copyright": "Copyright © 2017 NHS Digital",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "1.5.0",
"status": "active",
"id": "6ecfe2d0-8681-4aed-96f2-669470ebe30a",
"kind": "requirements",
"implementationGuide": [ "https://developer.nhs.uk/apis/ods/" ],
"url": "https://fhir.nhs.uk/STU3/CapabilityStatement/ODSAPI-CapabilityStatement-1",
"version": "1.0.0",
"contact": [ {
"name": "Interoperability Team",
"telecom": [ {
"use": "work",
"value": "interoperabilityteam@nhs.net",
"system": "email"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"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",
"type": "token",
"definition": "https://fhir.nhs.uk/STU3/SearchParameter/ODSAPI-OrganizationRole-Role-1"
}, {
"name": "ods-org-primaryRole",
"type": "token",
"definition": "https://fhir.nhs.uk/STU3/SearchParameter/ODSAPI-OrganizationRole-PrimaryRole-1"
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "Organization",
"interaction": [ {
"code": "read"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
"extension": [ {
"url": "required",
"valueString": "ods-org-primaryRole"
}, {
"url": "required",
"valueString": "ods-org-role"
} ]
} ],
"conditionalCreate": false,
"versioning": "no-version",
"profile": {
"reference": "https://fhir.nhs.uk/STU3/StructureDefinition/ODSAPI-Organization-1"
},
"conditionalDelete": "not-supported"
}, {
"searchParam": [ {
"name": "url",
"type": "string",
"documentation": "The logical URL for the CodeSystem"
} ],
"conditionalUpdate": false,
"conditionalRead": "not-supported",
"readHistory": false,
"type": "CodeSystem",
"interaction": [ {
"code": "read"
} ],
"updateCreate": false,
"conditionalCreate": false,
"versioning": "no-version",
"conditionalDelete": "not-supported"
} ],
"security": {
"cors": true
}
} ],
"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"
} ]
}