Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: [AEA-3932] - Added new statuses to OAS and fleshed out overview. #77

Merged
merged 2 commits into from
Mar 26, 2024

Conversation

MatthewPopat-NHS
Copy link
Contributor

Summary

Remove items from this list if they are not relevant. Remove this line once this has been done

  • Routine Change
  • ❗ Breaking Change
  • 🤖 Operational or Infrastructure Change
  • ✨ New Feature
  • ⚠️ Potential issues that might be caused by this change

Details

Add any summary information of what is in the change. Remove this line if you have nothing to add.

Pull Request Naming

Pull requests should be named using the following format:

Tag: [AEA-NNNN] - Short description

Tag can be one of:

  • Fix - for a bug fix. (Patch release)
  • Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems. (Patch release)
  • New - implemented a new feature. (Minor release)
  • Breaking - for a backwards-incompatible enhancement or feature. (Major release)
  • Docs - changes to documentation only. (Patch release)
  • Build - changes to build process only. (No release)
  • Upgrade - for a dependency upgrade. (Patch release)
  • Chore - for refactoring, adding tests, etc. (anything that isn't user-facing). (Patch release)

If the current release is x.y.z then

  • a patch release increases z by 1
  • a minor release increases y by 1
  • a major release increases x by 1

Correct tagging is necessary for our automated versioning and release process (Release).

The description of your pull request will be used as the commit message for the merge, and also be included in the changelog. Please ensure that your title is sufficiently descriptive.

Rerunning Checks

If you need to rename your pull request, you can restart the checks by either:

  • Closing and reopening the pull request
  • pushing an empty commit
    git commit --allow-empty -m 'trigger build'
    git push
  • Amend your last commit and force push to the branch
    git commit --amend --no-edit
    git push --force

Rerunning the checks from within the pull request will not use the updated title.

Copy link

This branch is work on a ticket in the NHS Digital APM JIRA Project. Here's a handy link to the ticket:

@MatthewPopat-NHS MatthewPopat-NHS changed the title Docs: [AEA-3932] Added new statuses to OAS and fleshed out overview. Docs: [AEA-3932] - Added new statuses to OAS and fleshed out overview. Mar 26, 2024
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@kris-szlapa kris-szlapa merged commit f20b6e3 into main Mar 26, 2024
8 checks passed

It includes some country-specific FHIR extensions, which are built against [FHIR UK Core, specifically [UKcore.stu1 0.5.1](https://simplifier.net/packages/fhir.r4.ukcore.stu1/0.5.1).
It includes some country-specific FHIR extensions, which are built against FHIR UK Core, specifically [UK Core R4 (v4.0.1)](https://simplifier.net/HL7FHIRUKCoreR4/).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The UK Core version is not 4.0.1 (that is the international version). The UKCore version currently published is UK Core STU2 v1.1.3


You do not need to know much about FHIR to use this API. The API only supports GET requests and the responses will be FHIR.
You do not need to know much about FHIR to use this API. The API only supports POST requests containing FHIR messages.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove reference to messages (as this has a different connotation in FHIR). Instead use 'POST requests containing FHIR transactions' (or FHIR resources)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants