{"id":23421315,"url":"https://github.com/nhsdigital/immunisation-history-api","last_synced_at":"2025-04-12T14:05:28.129Z","repository":{"id":36960423,"uuid":"348741321","full_name":"NHSDigital/immunisation-history-api","owner":"NHSDigital","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-17T22:48:28.000Z","size":1706,"stargazers_count":3,"open_issues_count":9,"forks_count":4,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-03-26T08:37:30.955Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NHSDigital.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-03-17T14:32:57.000Z","updated_at":"2023-11-10T19:59:29.000Z","dependencies_parsed_at":"2024-04-18T17:29:25.915Z","dependency_job_id":"cbdbf524-fde2-4b0d-b6a4-4f9f1e2eb119","html_url":"https://github.com/NHSDigital/immunisation-history-api","commit_stats":null,"previous_names":[],"tags_count":149,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fimmunisation-history-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fimmunisation-history-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fimmunisation-history-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NHSDigital%2Fimmunisation-history-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NHSDigital","download_url":"https://codeload.github.com/NHSDigital/immunisation-history-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248578861,"owners_count":21127713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-23T02:14:46.069Z","updated_at":"2025-04-12T14:05:28.100Z","avatar_url":"https://github.com/NHSDigital.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Immunisation History\n\n![Build](https://github.com/NHSDigital/immunisation-history/workflows/Build/badge.svg?branch=master)\n\nThis is a RESTful HL7® FHIR® API specification for the *Immunisation-History* API.\n\n* `specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.\n* `sandbox/` This NodeJS application implements a mock implementation of the service. Use it as a back-end service to the interactive documentation to illustrate interactions and concepts. It is not intended to provide an exhaustive/faithful environment suitable for full development and testing.\n* `scripts/` Utilities helpful to developers of this specification.\n* `proxies/` Live (connecting to another service) and sandbox (using the sandbox container) Apigee API Proxy definitions.\n\nConsumers of the API will find developer documentation on the [NHS Digital Developer Hub](https://digital.nhs.uk/developer).\n\n### Pre-requisites\nYou will need the following packages installing: \n    - [Poetry](https://python-poetry.org/docs/)\n    - [get_token](https://docs.apigee.com/api-platform/system-administration/auth-tools#install)\nAnd you will need to be granted access to the APIGEE    \n\n\n### Testing\nTo test this locally you will need a local environment set up, please contact a developer managing this repo for local environment setup for testing.\n\n#### Authorising immunisation targets in production\n\nSuccessful deployment of consumer apps in production requires a custom attribute key-value pair with name `authorised_targets` and a value set to a comma-delimited list of target immunisations, e.g.\n\n```yaml\nauthorised_targets: COVID19,HPV,FLU\n```\n\nor for a single immunisation target, e.g.:\n\n```yaml\nauthorised_targets: COVID19\n```\n\nInvalid values of `authorised_targets` in production (in APIGEE validation) are:\n\n* an empty value (indicated in testing by `\"\"`)\n* \"`*`\" (unless in non-production environments)\n\nAdditionally, requests with will be rejected if `authorised_targets` contains a value which is not one of the pre-defined target immunisation keywords. Contact the maintainers for the up-to-date set of target immunisation keywords.\n\n:bulb: For non-production (\"self-serve\") environments: the custom attribute `authorised_targets` is not required to exist; if it doesn't exist it will automatically be set to \"`*`\" (i.e. valid for any target).\n\n## Contributing\nContributions to this project are welcome from anyone, providing that they conform to the [guidelines for contribution](https://github.com/NHSDigital/immunisation-history/blob/master/CONTRIBUTING.md) and the [community code of conduct](https://github.com/NHSDigital/immunisation-history/blob/master/CODE_OF_CONDUCT.md).\n\n### Licensing\nThis code is dual licensed under the MIT license and the OGL (Open Government License). Any new work added to this repository must conform to the conditions of these licenses. In particular this means that this project may not depend on GPL-licensed or AGPL-licensed libraries, as these would violate the terms of those libraries' licenses.\n\nThe contents of this repository are protected by Crown Copyright (C).\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fimmunisation-history-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhsdigital%2Fimmunisation-history-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhsdigital%2Fimmunisation-history-api/lists"}