pax_global_header00006660000000000000000000000064151120160530014504gustar00rootroot0000000000000052 comment=03d65a031290c7a9fedd2fca02cb9531b5996cf6 NRLF-3.0.31/000077500000000000000000000000001511201605300123315ustar00rootroot00000000000000NRLF-3.0.31/.flake8000066400000000000000000000005331511201605300135050ustar00rootroot00000000000000[flake8] select = T201, # Print statement linter F401, # module imported but unused F402, # import module from line N shadowed by loop variable F403 # ‘from module import *’ used; unable to detect undefined names exclude = .git, __pycache__, dist, .venv, scripts, packages/feature_documentation/* NRLF-3.0.31/.github/000077500000000000000000000000001511201605300136715ustar00rootroot00000000000000NRLF-3.0.31/.github/CODEOWNERS000066400000000000000000000000621511201605300152620ustar00rootroot00000000000000* @NHSDigital/national-record-locator-code-owners NRLF-3.0.31/.github/dependabot.yml000066400000000000000000000012611511201605300165210ustar00rootroot00000000000000# To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 updates: - package-ecosystem: "pip" directory: "/" schedule: interval: "weekly" commit-message: prefix: "poetry" open-pull-requests-limit: 10 - package-ecosystem: "github-actions" directory: "/" schedule: interval: "weekly" commit-message: prefix: "github-actions" open-pull-requests-limit: 10 NRLF-3.0.31/.github/workflows/000077500000000000000000000000001511201605300157265ustar00rootroot00000000000000NRLF-3.0.31/.github/workflows/activate-stack.yml000066400000000000000000000033711511201605300213600ustar00rootroot00000000000000name: Switch Active Stack run-name: Switch active stack to ${{ inputs.stack_name }} in ${{ inputs.environment }} by ${{ github.actor }} on: workflow_dispatch: inputs: environment: description: "Environment to activate the stack in" required: true default: "dev" type: environment stack_name: description: Name of stack to activate required: true type: string permissions: id-token: write contents: read actions: write jobs: activate-stack: name: Activate ${{ inputs.stack_name }} for ${{ inputs.environment }} runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: Get current environment config env: ENVIRONMENT: ${{ inputs.environment }} run: | poetry run python ./scripts/get_env_config.py all $ENVIRONMENT - name: Activate Stack env: STACK_NAME: ${{ inputs.stack_name }} ENVIRONMENT: ${{ inputs.environment }} run: | poetry run python ./scripts/activate_stack.py $STACK_NAME $ENVIRONMENT NRLF-3.0.31/.github/workflows/daily-build.yml000066400000000000000000000040111511201605300206440ustar00rootroot00000000000000name: Build NRL Project on Environment run-name: Build NRL Project on ${{ inputs.environment || 'dev' }} permissions: id-token: write contents: read actions: write on: schedule: - cron: "0 1 * * *" workflow_dispatch: inputs: environment: type: environment description: "The environment to deploy changes to" default: "dev" required: true jobs: build: name: Build - ${{ github.ref }} runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Run Linting run: make lint - name: Run Unit Tests run: make test - name: Build Project run: make build - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment || 'dev' }}-${{ github.run_id }} - name: Add S3 Permissions to Lambda run: | account=$(echo '${{ inputs.environment || 'dev' }}' | cut -d '-' -f1) inactive_stack=$(poetry run python ./scripts/get_env_config.py inactive-stack ${{ inputs.environment || 'dev' }}) make get-s3-perms ENV=${account} TF_WORKSPACE_NAME=${inactive_stack} - name: Save Build Artifacts uses: actions/upload-artifact@v4 with: name: build-artifacts path: | dist/*.zip !dist/nrlf_permissions.zip - name: Save NRLF Permissions cache uses: actions/cache/save@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip NRLF-3.0.31/.github/workflows/deploy-account-wide-infra.yml000066400000000000000000000133561511201605300234320ustar00rootroot00000000000000name: Deploy Account-wide infrastructure run-name: Account-wide infra deployment to ${{ inputs.environment }} of ${{ inputs.branch_name }} by ${{ github.actor }} on: workflow_dispatch: inputs: environment: description: "Account to deploy to" required: true default: "account-dev" type: environment branch_name: description: Branch to deploy required: true permissions: id-token: write contents: read actions: write jobs: check-selected-environment: name: Check Workflow Env runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Validate environment env: IS_VALID_ENV: ${{ startsWith(inputs.environment, 'account-') }} run: | echo "valid workflow environment selected:" $IS_VALID_ENV if [[ $IS_VALID_ENV == true ]]; then exit 0 fi echo "This workflow can only be run with 'account-*' environments as it deploys account-specific infrastructure" exit 1 terraform-plan: name: Terraform Plan - ${{ inputs.environment }} environment: ${{ inputs.environment }} needs: [check-selected-environment] runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Retrieve Server Certificates env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: | make truststore-pull-all-for-account ACCOUNT=${ACCOUNT_NAME} - name: Terraform Init env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: | terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} init terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} workspace new ${ACCOUNT_NAME} || \ terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} workspace select ${ACCOUNT_NAME} - name: Terraform Plan env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }} run: | terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} plan \ -var assume_account=${ACCOUNT_ID} \ -var assume_role=terraform \ -out tfplan - name: Save Terraform Plan env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: | terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} show -no-color tfplan > terraform/account-wide-infrastructure/$ACCOUNT_NAME/tfplan.txt aws s3 cp terraform/account-wide-infrastructure/$ACCOUNT_NAME/tfplan s3://nhsd-nrlf--mgmt--github-ci-logging/acc-$ACCOUNT_NAME/${{ github.run_id }}/tfplan aws s3 cp terraform/account-wide-infrastructure/$ACCOUNT_NAME/tfplan.txt s3://nhsd-nrlf--mgmt--github-ci-logging/acc-$ACCOUNT_NAME/${{ github.run_id }}/tfplan.txt terraform-apply: name: Terraform Apply - ${{ inputs.environment }} needs: [terraform-plan] runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: Download Terraform Plan artifact env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: aws s3 cp s3://nhsd-nrlf--mgmt--github-ci-logging/acc-$ACCOUNT_NAME/${{ github.run_id }}/tfplan terraform/account-wide-infrastructure/${ACCOUNT_NAME}/tfplan - name: Retrieve Server Certificates env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: | make truststore-pull-all-for-account ACCOUNT=${ACCOUNT_NAME} - name: Terraform Init env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: | terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} init terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} workspace new ${ACCOUNT_NAME} || \ terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} workspace select ${ACCOUNT_NAME} - name: Terraform Apply env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }} run: | terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} apply tfplan - name: Update environment config version env: ACCOUNT_NAME: ${{ vars.ACCOUNT_NAME }} run: | deployed_version=$(terraform -chdir=terraform/account-wide-infrastructure/${ACCOUNT_NAME} output --raw version) echo $deployed_version NRLF-3.0.31/.github/workflows/persistent-environment.yml000066400000000000000000000262751511201605300232270ustar00rootroot00000000000000name: Persistent Environment Deploy run-name: Deployment to ${{ inputs.environment }} of ${{ inputs.branch_name }} by ${{ github.actor }} on: workflow_dispatch: inputs: environment: description: "Environment to deploy to" required: true default: "dev" type: environment branch_name: description: Branch to deploy required: true permissions: id-token: write contents: read actions: write jobs: build: name: Build - ${{ inputs.branch_name }} runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Run Linting run: make lint - name: Run Unit Tests run: make test - name: Build Project run: make build - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Add S3 Permissions to Lambda env: ENVIRONMENT: ${{ inputs.environment }} run: | account=$(echo "$ENVIRONMENT" | cut -d '-' -f1) inactive_stack=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) make get-s3-perms ENV=${account} TF_WORKSPACE_NAME=${inactive_stack} - name: Save Build Artifacts uses: actions/upload-artifact@v4 with: name: build-artifacts path: | dist/*.zip !dist/nrlf_permissions.zip - name: Save NRLF Permissions cache uses: actions/cache/save@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip terraform-plan: name: Terraform Plan - ${{ inputs.environment }} needs: [build] environment: ${{ inputs.environment }} runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Retrieve Server Certificates env: ENVIRONMENT: ${{ inputs.environment }} run: | account=$(echo "$ENVIRONMENT" | cut -d '-' -f1) make truststore-pull-server ENV=${account} - name: Download build artifacts uses: actions/download-artifact@v4 with: name: build-artifacts path: dist - name: Restore NRLF permissions cache uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip fail-on-cache-miss: true - name: Terraform Init env: ENVIRONMENT: ${{ inputs.environment }} run: | inactive_stack=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new ${inactive_stack} || \ terraform -chdir=terraform/infrastructure workspace select ${inactive_stack} - name: Terraform Plan env: DEPLOY_ROLE_ARN: ${{ secrets.DEPLOY_ROLE_ARN }} ENVIRONMENT: ${{ inputs.environment }} run: | inactive_stack=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) terraform -chdir=terraform/infrastructure plan \ --var-file=etc/${{ vars.ACCOUNT_NAME }}.tfvars \ --var assume_role_arn=${DEPLOY_ROLE_ARN} \ --var use_shared_resources=$(poetry run python scripts/are_resources_shared_for_stack.py ${inactive_stack}) \ -out tfplan - name: Save Terraform Plan env: ENVIRONMENT: ${{ inputs.environment }} run: | terraform -chdir=terraform/infrastructure show -no-color tfplan > terraform/infrastructure/tfplan.txt aws s3 cp terraform/infrastructure/tfplan s3://nhsd-nrlf--mgmt--github-ci-logging/$ENVIRONMENT/${{ github.run_id }}/tfplan aws s3 cp terraform/infrastructure/tfplan.txt s3://nhsd-nrlf--mgmt--github-ci-logging/$ENVIRONMENT/${{ github.run_id }}/tfplan.txt terraform-apply: name: Terraform Apply - ${{ inputs.environment }} needs: [terraform-plan] runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Download build artifacts uses: actions/download-artifact@v4 with: name: build-artifacts path: dist - name: Restore NRLF permissions cache uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip fail-on-cache-miss: true - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: Download Terraform Plan artifact env: ENVIRONMENT: ${{ inputs.environment }} run: aws s3 cp s3://nhsd-nrlf--mgmt--github-ci-logging/$ENVIRONMENT/${{ github.run_id }}/tfplan terraform/infrastructure/tfplan - name: Retrieve Server Certificates env: ENVIRONMENT: ${{ inputs.environment }} run: | account=$(echo "$ENVIRONMENT" | cut -d '-' -f1) make truststore-pull-server ENV=${account} - name: Terraform Init env: ENVIRONMENT: ${{ inputs.environment }} run: | inactive_stack=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new ${inactive_stack} || \ terraform -chdir=terraform/infrastructure workspace select ${inactive_stack} - name: Terraform Apply run: terraform -chdir=terraform/infrastructure apply tfplan - name: Update environment config version env: ENVIRONMENT: ${{ inputs.environment }} run: | deployed_version=$(terraform -chdir=terraform/infrastructure output --raw version) poetry run python ./scripts/set_env_config.py inactive-version ${deployed_version} $ENVIRONMENT - name: Smoke Test env: ENVIRONMENT: ${{ inputs.environment }} run: | account=$(echo "$ENVIRONMENT" | cut -d '-' -f1) make ENV=${account} truststore-pull-client make ENV=$ENVIRONMENT test-smoke-internal activate-stack: name: Activate - ${{ inputs.environment }} needs: [terraform-apply] runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: Activate Stack env: ENVIRONMENT: ${{ inputs.environment }} run: | inactive_stack=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) poetry run python ./scripts/activate_stack.py ${inactive_stack} $ENVIRONMENT post-release-verify: name: Verify - ${{ inputs.environment }} needs: [activate-stack] runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: "Smoke Test" env: ENVIRONMENT: ${{ inputs.environment }} run: | make ENV=$ENVIRONMENT test-smoke-public rollback-stack: name: Rollback - ${{ inputs.environment }} needs: [post-release-verify] if: always() && ( needs.post-release-verify.result == 'failure' ) runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ inputs.branch_name }} uses: actions/checkout@v4 with: ref: ${{ inputs.branch_name }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: Deactivate Stack env: ENVIRONMENT: ${{ inputs.environment }} run: | inactive_stack_name=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) poetry run python ./scripts/activate_stack.py ${inactive_stack_name} $ENVIRONMENT NRLF-3.0.31/.github/workflows/pr-env-deploy.yml000066400000000000000000000276761511201605300211740ustar00rootroot00000000000000name: Deploy PR Environment run-name: "${{ github.event.action == 'synchronize' && 'Update' || 'Create' }} PR Environment - #${{ github.event.pull_request.number }} (${{ github.event.pull_request.title }})" on: pull_request: types: [opened, reopened, synchronize] concurrency: group: environment-${{ github.event.pull_request.number }} cancel-in-progress: false permissions: id-token: write contents: read actions: write issues: write pull-requests: write jobs: set-environment-id: name: Set Environment ID runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: pull-request steps: - name: Set a ID based on the branch name env: PR_HEAD_REF: ${{ github.event.pull_request.head.ref }} id: set_environment_id run: | JIRA_TICKET=$( echo "$PR_HEAD_REF" | \ grep -Po --color=none '[A-z]{3,4}-[0-9]{3,5}' | \ sed 's/-//g' | \ tr '[:upper:]' '[:lower:]' || \ true ) BRANCH_HASH=$(echo "$PR_HEAD_REF${{ github.event.pull_request.id }}" | sha256sum | head -c 6) if [ -z "$JIRA_TICKET" ]; then echo "environment_id=${BRANCH_HASH}" > $GITHUB_OUTPUT else echo "environment_id=${JIRA_TICKET}-${BRANCH_HASH}" > $GITHUB_OUTPUT fi outputs: environment_id: ${{ steps.set_environment_id.outputs.environment_id }} build: name: Build Application runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: pull-request steps: - name: Git Clone - ${{ github.event.pull_request.head.ref }} uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Run Linting run: make lint - name: Run Unit Tests run: make test - name: Build Project run: make build - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Add S3 Permissions to Lambda run: | make get-s3-perms ENV=dev - name: Save Build Artifacts uses: actions/upload-artifact@v4 with: name: build-artifacts path: | dist/*.zip !dist/nrlf_permissions.zip - name: Save NRLF Permissions cache uses: actions/cache/save@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip - name: Add Failure Pull Request Comment uses: actions/github-script@v7 if: ${{ failure() }} with: script: | github.rest.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, body: `💥 Something went wrong while building the pull request environment.\n[Check Output Logs](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})` }) deploy: name: Deploy PR Environment runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: pull-request needs: [set-environment-id, build] steps: - name: Git Clone - ${{ github.event.pull_request.head.ref }} uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Download Artifacts uses: actions/download-artifact@v4 with: name: build-artifacts path: dist - name: Restore NRLF permissions cache uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip fail-on-cache-miss: true - name: Retrieve Server Certificates run: make truststore-pull-server ENV=dev - name: Terraform Init run: | terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new ${{ needs.set-environment-id.outputs.environment_id }} || \ terraform -chdir=terraform/infrastructure workspace select ${{ needs.set-environment-id.outputs.environment_id }} - name: Terraform Plan env: DEPLOY_ROLE_ARN: ${{ secrets.DEPLOY_ROLE_ARN }} run: | terraform -chdir=terraform/infrastructure plan \ --var-file=etc/dev.tfvars \ --var assume_role_arn=${DEPLOY_ROLE_ARN} \ --var use_shared_resources=$(poetry run python scripts/are_resources_shared_for_stack.py ${{ needs.set-environment-id.outputs.environment_id }}) \ -out tfplan - name: Terraform Apply id: terraform-apply run: terraform -chdir=terraform/infrastructure apply tfplan - name: Add Success Pull Request Comment uses: actions/github-script@v7 if: ${{ success() }} with: script: | github.rest.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, body: "🚀 PR environment successfully deployed.\nCommit Hash: `${{ github.event.pull_request.head.sha }}`\nURL: https://${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk/" }) - name: Add Failure Pull Request Comment uses: actions/github-script@v7 if: ${{ failure() }} with: script: | github.rest.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, body: `💥 Something went wrong while deploying the pull request environment.\n[Check Output Logs](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})` }) integration-test: name: Run Integration Tests needs: [set-environment-id, deploy] environment: pull-request runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git Clone - ${{ github.event.pull_request.head.ref }} uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Retrieve Client Certificates run: make truststore-pull-client ENV=dev - name: Configure Dev Account Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-chaining: true role-to-assume: ${{ secrets.DEPLOY_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Run Integration Tests run: make test-features-integration TF_WORKSPACE_NAME=${{ needs.set-environment-id.outputs.environment_id }} smoke-test: name: Run Smoke Tests needs: [set-environment-id, integration-test] environment: pull-request runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git Clone - ${{ github.event.pull_request.head.ref }} uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Terraform Init run: | terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new ${{ needs.set-environment-id.outputs.environment_id }} || \ terraform -chdir=terraform/infrastructure workspace select ${{ needs.set-environment-id.outputs.environment_id }} - name: Smoke Test run: | make ENV=dev truststore-pull-client make ENV=dev TF_WORKSPACE_NAME=${{ needs.set-environment-id.outputs.environment_id }} test-smoke-internal performance-test: name: Run Performance Tests needs: [set-environment-id, integration-test] environment: pull-request runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git Clone - ${{ github.event.pull_request.head.ref }} uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure AWS Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Pull Client Certificates run: make truststore-pull-client ENV=dev - name: Configure Dev Account Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-chaining: true role-to-assume: ${{ secrets.DEPLOY_ROLE_ARN }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Setup Environment Test Data run: make test-performance-prepare TF_WORKSPACE_NAME=${{ needs.set-environment-id.outputs.environment_id }} - name: Run Performance Test - Baseline run: make test-performance-baseline HOST=${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk ENV_TYPE=dev - name: Run Performance Test - Stress run: make test-performance-stress HOST=${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk ENV_TYPE=dev - name: Process Performance Test Outputs run: make test-performance-output - name: Store Performance Test Outputs uses: actions/upload-artifact@v4 with: name: performance-test-outputs path: dist/*.png - name: Cleanup Environment Test Data run: make test-performance-cleanup TF_WORKSPACE_NAME=${{ needs.set-environment-id.outputs.environment_id }} NRLF-3.0.31/.github/workflows/pr-env-destroy.yml000066400000000000000000000076071511201605300213610ustar00rootroot00000000000000name: Destroy PR Environment run-name: "Destroy PR Environment - #${{ github.event.pull_request.number }} (${{ github.event.pull_request.title }})" on: pull_request: types: [closed] workflow_dispatch: concurrency: group: environment-${{ github.event.pull_request.number }} cancel-in-progress: true permissions: id-token: write contents: read actions: write issues: write pull-requests: write jobs: set-environment-id: name: Set Environment ID runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Set a ID based on the branch name env: PR_HEAD_REF: ${{ github.event.pull_request.head.ref }} id: set_environment_id run: | JIRA_TICKET=$( echo "$PR_HEAD_REF" | \ grep -Po --color=none '[A-z]{3,4}-[0-9]{3,5}' | \ sed 's/-//g' | \ tr '[:upper:]' '[:lower:]' || \ true ) BRANCH_HASH=$(echo "$PR_HEAD_REF${{ github.event.pull_request.id }}" | sha256sum | head -c 6) if [ -z "$JIRA_TICKET" ]; then echo "environment_id=${BRANCH_HASH}" > $GITHUB_OUTPUT else echo "environment_id=${JIRA_TICKET}-${BRANCH_HASH}" > $GITHUB_OUTPUT fi outputs: environment_id: ${{ steps.set_environment_id.outputs.environment_id }} destroy: name: Destroy PR Environment needs: [set-environment-id] environment: pull-request runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git Clone - ${{ github.event.pull_request.head.ref }} uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.merged && github.event.pull_request.base.ref || github.event.pull_request.head.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure AWS Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.CI_ROLE_NAME }} role-session-name: github-actions-ci-${{ needs.set-environment-id.outputs.environment_id }} - name: Get AWS Account ID id: get_account_id run: echo "aws_account_id=$(aws secretsmanager get-secret-value --secret-id nhsd-nrlf--mgmt--dev-account-id --query SecretString --output text)" >> "$GITHUB_OUTPUT" - name: Terraform Init run: | terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace select ${{ needs.set-environment-id.outputs.environment_id }} - name: Build artifacts run: make build get-s3-perms - name: Terraform Destroy env: DEPLOY_ROLE_ARN: ${{ secrets.DEPLOY_ROLE_ARN }} run: | terraform -chdir=terraform/infrastructure destroy \ --var-file=etc/dev.tfvars \ --var assume_role_arn=${DEPLOY_ROLE_ARN} \ -auto-approve - name: Cleanup Terraform Workspace run: | terraform -chdir=terraform/infrastructure workspace select default terraform -chdir=terraform/infrastructure workspace delete ${{ needs.set-environment-id.outputs.environment_id }} - name: Add Failure Pull Request Comment uses: actions/github-script@v7 if: ${{ failure() }} with: script: | github.rest.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, body: `💥 Something went wrong while destroying the pull request environment.\n[Check Output Logs](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId})` }) NRLF-3.0.31/.github/workflows/rollback-stack.yml000066400000000000000000000035061511201605300213510ustar00rootroot00000000000000name: Rollback Stack run-name: Rollback to inactive stack in ${{ inputs.environment }} by ${{ github.actor }} on: workflow_dispatch: inputs: environment: description: "Environment to rollback the stack in" required: true default: "dev" type: environment permissions: id-token: write contents: read actions: write jobs: rollback-stack: name: Rollback to inactive stack for ${{ inputs.environment }} runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id}} - name: Get current environment config env: ENVIRONMENT: ${{ inputs.environment }} run: | poetry run python ./scripts/get_env_config.py all $ENVIRONMENT - name: Rollback env: ENVIRONMENT: ${{ inputs.environment }} run: | inactive_stack_name=$(poetry run python ./scripts/get_env_config.py inactive-stack $ENVIRONMENT) poetry run python ./scripts/activate_stack.py ${inactive_stack_name} $ENVIRONMENT - name: "Smoke Test" env: ENVIRONMENT: ${{ inputs.environment }} run: | make ENV=$ENVIRONMENT test-smoke-public NRLF-3.0.31/.github/workflows/update-lambda-permissions.yml000066400000000000000000000233321511201605300235250ustar00rootroot00000000000000name: Update Lambda Permissions run-name: Updating permissions on ${{ inputs.stack_name }} using ${{ github.ref_name }} by ${{ github.actor }} on: workflow_dispatch: inputs: environment: description: Environment to deploy to required: true default: "dev" type: environment stack_name: description: Stack to update required: true type: string strict_versioning: description: Use strict versioning (recommended) required: true type: boolean default: true permissions: id-token: write contents: read actions: write jobs: check-versions: name: Check versions runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Terraform Init env: STACK_NAME: ${{ inputs.stack_name }} run: | terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new $STACK_NAME || \ terraform -chdir=terraform/infrastructure workspace select $STACK_NAME - name: Check deployed version matches build version env: STRICT_VERSIONING: ${{ inputs.strict_versioning }} run: | this_version="$(./scripts/get-current-info.sh | jq -r .version)" deployed_version="$(terraform -chdir=terraform/infrastructure output --raw version)" echo "code-version=${this_version} deployed-version=${deployed_version}" if [ "${deployed_version}" != "${this_version}" ] then echo "${this_version} does not match deployed version: ${deployed_version}" 1>&2 if [ "$STRICT_VERSIONING" == "true" ]; then echo "Strict version checking failed, cancelling workflow" 1>&2 exit 1 fi fi build-permissions: name: Build permissions runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} needs: [check-versions] steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Create lambda permissions layer env: ENVIRONMENT: ${{ inputs.environment }} STACK_NAME: ${{ inputs.stack_name }} run: | account=$(echo "$ENVIRONMENT" | cut -d '-' -f1) make get-s3-perms ENV=${account} TF_WORKSPACE_NAME=$STACK_NAME - name: Save NRLF permissions in cache uses: actions/cache/save@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip pull-deployed-lambdas: name: Pull deployed lambdas runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} needs: [check-versions] steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Configure Account Role uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-chaining: true role-to-assume: ${{ secrets.DEPLOY_ROLE_ARN }} role-session-name: github-actions-ci-acc-${{ inputs.environment }}-${{ github.run_id }} - name: Pull deployed lambda artifacts env: ENVIRONMENT: ${{ inputs.environment }} STACK_NAME: ${{ inputs.stack_name }} run: | account=$(echo "$ENVIRONMENT" | cut -d '-' -f1) ./scripts/pull-lambda-code-for-stack.sh $STACK_NAME - name: Save lambda artifacts in cache uses: actions/cache/save@v4 with: key: ${{ github.run_id }}-pulled-lambda-artifacts path: dist/*.zip terraform-plan: name: Plan changes runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} needs: [build-permissions, pull-deployed-lambdas] steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Restore pulled lambda artifacts uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-pulled-lambda-artifacts path: dist/*.zip fail-on-cache-miss: true - name: Restore NRLF permissions cache uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip fail-on-cache-miss: true - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Terraform Init env: STACK_NAME: ${{ inputs.stack_name }} run: | terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new $STACK_NAME || \ terraform -chdir=terraform/infrastructure workspace select $STACK_NAME - name: Terraform Plan env: DEPLOY_ROLE_ARN: ${{ secrets.DEPLOY_ROLE_ARN }} STACK_NAME: ${{ inputs.stack_name }} run: | terraform -chdir=terraform/infrastructure plan \ --var-file=etc/${{ vars.ACCOUNT_NAME }}.tfvars \ --var assume_role_arn=${DEPLOY_ROLE_ARN} \ --var use_shared_resources=$(poetry run python scripts/are_resources_shared_for_stack.py $STACK_NAME) \ --out tfplan - name: Save Terraform Plan env: ENVIRONMENT: ${{ inputs.environment }} run: | terraform -chdir=terraform/infrastructure show -no-color tfplan > terraform/infrastructure/tfplan.txt aws s3 cp terraform/infrastructure/tfplan s3://nhsd-nrlf--mgmt--github-ci-logging/$ENVIRONMENT/${{ github.run_id }}/tfplan aws s3 cp terraform/infrastructure/tfplan.txt s3://nhsd-nrlf--mgmt--github-ci-logging/$ENVIRONMENT/${{ github.run_id }}/tfplan.txt terraform-apply: name: Apply permissions runs-on: codebuild-nhsd-nrlf-ci-build-project-${{ github.run_id }}-${{ github.run_attempt }} environment: ${{ inputs.environment }} needs: terraform-plan steps: - name: Git clone - ${{ github.ref }} uses: actions/checkout@v4 with: ref: ${{ github.ref }} - name: Setup environment run: | echo "${HOME}/.asdf/bin" >> $GITHUB_PATH poetry install --no-root - name: Restore pulled lambda artifacts uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-pulled-lambda-artifacts path: dist/*.zip fail-on-cache-miss: true - name: Restore NRLF permissions cache uses: actions/cache/restore@v4 with: key: ${{ github.run_id }}-nrlf-permissions path: dist/nrlf_permissions.zip fail-on-cache-miss: true - name: Configure Management Credentials uses: aws-actions/configure-aws-credentials@7474bc4690e29a8392af63c5b98e7449536d5c3a #v4.3.1 with: aws-region: eu-west-2 role-to-assume: ${{ secrets.MGMT_ROLE_ARN }} role-session-name: github-actions-ci-${{ inputs.environment }}-${{ github.run_id }} - name: Download Terraform Plan artifact env: ENVIRONMENT: ${{ inputs.environment }} run: aws s3 cp s3://nhsd-nrlf--mgmt--github-ci-logging/$ENVIRONMENT/${{ github.run_id }}/tfplan terraform/infrastructure/tfplan - name: Terraform Init env: STACK_NAME: ${{ inputs.stack_name }} run: | terraform -chdir=terraform/infrastructure init terraform -chdir=terraform/infrastructure workspace new $STACK_NAME || \ terraform -chdir=terraform/infrastructure workspace select $STACK_NAME - name: Terraform Apply run: | terraform -chdir=terraform/infrastructure apply tfplan NRLF-3.0.31/.gitignore000066400000000000000000000025631511201605300143270ustar00rootroot00000000000000# Local .terraform directories and files **/.terraform/* **/tfplan terraform/**/output.json terraform/**/.terraform.lock.hcl terraform/**/*.tfplan # documentation report/ # key & certificate files *.pem *.key *.pub *.cer *.csr *.crt # .tfstate files *.tfstate *.tfstate.* # ci tf output files *-tf-init-output*.txt *-tf-apply-output*.txt *-tf-plan-output*.txt *-tf-destroy-output*.txt # Crash log files crash.log # Ignore any .tfvars files that are generated automatically for each Terraform run. Most # .tfvars files are managed as part of configuration and so should be included in # version control. # # example.tfvars # Ignore override files as they are usually used to override resources locally and so # are not checked in override.tf override.tf.json *_override.tf *_override.tf.json # Ignore output of data object terraform/account-wide-infrastructure/modules/glue/files/src.zip # Include override files you do wish to add to version control using negated pattern # # !example_override.tf # Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan # example: *tfplan* # ide config .vscode .idea .yo-rc.json .DS_Store # python __pycache__ *egg-info* .pytest_cache .venv # build dirs build dist .coverage .hypothesis .firehose # Allure results allure-results/* allure-report/* # Performance test ref data tests/performance/reference-data.json NRLF-3.0.31/.pre-commit-config.yaml000066400000000000000000000052541511201605300166200ustar00rootroot00000000000000--- repos: - repo: https://github.com/Yelp/detect-secrets rev: v1.4.0 hooks: - id: detect-secrets exclude: .pre-commit-config.yaml|layer/psycopg2/.* - repo: https://github.com/prettier/pre-commit rev: 57f39166b5a5a504d6808b87ab98d41ebf095b46 hooks: - id: prettier - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.0.1 hooks: - id: check-yaml - id: check-json - id: check-merge-conflict - id: end-of-file-fixer - id: trailing-whitespace - id: no-commit-to-branch name: Prevent commits to develop / main branches entry: no-commit-to-branch language: python args: [-b, develop, -b, master, -b, main] pass_filenames: false # Flake8 for print only (error code T201) - repo: https://github.com/pycqa/flake8 rev: 6.0.0 hooks: - id: flake8 additional_dependencies: - flake8-print args: - "--select=T201,F401,F402,F403" - "--exclude=.git,__pycache__,dist,.venv,scripts/*,packages/feature_documentation/*,layer/psycopg2/*,changelog/scripts/changelog.py" - repo: https://github.com/psf/black rev: 24.3.0 hooks: - id: black language_version: python3 - repo: https://github.com/pycqa/isort rev: 5.12.0 hooks: - id: isort args: [ --profile, black, --filter-files, --project=nrlf, --project=helpers, --project=layer, ] - repo: https://github.com/ducminh-phan/reformat-gherkin rev: v3.0.1 hooks: - id: reformat-gherkin # This uses the root .terraform-version file, make sure to update it you change the actual terraform versions - repo: https://github.com/antonbabenko/pre-commit-terraform rev: v1.76.0 hooks: - id: terraform_fmt args: - --args=-write=true - --args=-recursive # - repo: local # hooks: # - id: forbid_json_loads # name: Don't use json.loads - use json_loads instead # entry: json\.loads # language: pygrep # types: [python] # exclude: layer/nrlf/nrlf/core/validators.py|layer/psycopg2/.*|mi/.* # - repo: local # hooks: # - id: forbid_json_load # name: Don't use json.load - use json_load instead # entry: json\.load # language: pygrep # types: [python] # exclude: layer/nrlf/nrlf/core/validators.py|layer/psycopg2/.*|mi/.* - repo: local hooks: - id: create_changelog name: Create changelog from changelog files entry: changelog/scripts/changelog-pre-commit.sh language: python NRLF-3.0.31/.prettierignore000066400000000000000000000000701511201605300153710ustar00rootroot00000000000000# Ignore producer test cases: **/producer-test-cases.md NRLF-3.0.31/.tool-versions000066400000000000000000000001451511201605300151550ustar00rootroot00000000000000allure 2.34.0 awscli 2.27.20 jq 1.7.1 k6 1.0.0 poetry 1.8.5 python 3.12.10 terraform 1.9.8 yq 4.45.4 NRLF-3.0.31/CHANGELOG.md000066400000000000000000000146751511201605300141570ustar00rootroot00000000000000# Changelog ## 2024-03-14 - NRL-511 - Capability statements - NRL-496 - Update Format code system URL - NRL-521 - Port (duplicate) POST functionality to PUT Interaction ## 2024-02-08 - SPINECLI-1795 Add open source links to documentation ## 2024-01-09 - NRLF-657 Add workspace destroy and unlock commands - SPINECLI-1665 Add asid-check data contract for the new pointer type Lloyd george - NRLF-708 Fix sonarcloud security hotspot changes - SPINECLI-1704 add checks and cleanup to contract integration tests - NRL-445 Add Allure reports - SPINECLI-1666 Documentation Updates - SPINECLI-1774 Fix integration test failures ## 2023-10-26 - SPINECLI-1611 - Create sonar-project.properties file for SonarCloud configuration ## 2023-10-09 - SPINECLI-1090 - Update NRLF Readme with WSL and Powershell Instructions - SPINECLI-1619 - Change the readme - updated section on Reporting to add more info ## 2023-09-21 - SPINECLI-1190 - Add link to postman collection in narrative - NRLF-691 - Amend Document Type used in NRLF Smoke Test to clearly identify as Test-Only in MI Reports - SPINECLI-1043 - 403 when x-correlation-id or x-request-id is missing ## 2023-09-13 - NRLF-696 - BUG: MI report date range - NRLF-697 - Enhancement: MI Max Year - NRLF-702 - Add Postman Collection to API Catalogue ## 2023-09-06 - NRLF-644 - Add missing "Errors" to swagger response in Consumer. - NRLF-646 - Add missing "Errors" to swagger response in Producer. - NRLF-663 - Add Open Source section to Producer/Consumer Narrative - NRLF-693 - Sonarcube Fixes - NRLF-682 - Remove documentation from CI - NRLF-698 - Fix Forward: 4XX isn’t valid in API Gateway - NRLF-582 - (APIGEE) 64L CORS issue with "TRY" Section in API Catalogue - NRLF-690 - (APIGEE) Update dependency ## 2023-08-29 - NRLF-563 - 64L Sort fields that should be treated as Sets, not ordered Lists - NRLF-675 - MI dead letters, resubmission and alerting - NRLF-683 - MI Documentation and reports - NRLF-689 - Update NRLF 1D Converter to v0.0.9 - Dependabot updates: - pydantic (1.10.10 -> 1.10.12) - boto3 (1.26.165 -> 1.28.30) - cryptography (41.0.1 -> 41.0.3) - awscli (1.27.165 -> 1.29.30) - datamodel-code-generator (0.21.2 -> 0.21.4) - cookiecutter (2.2.3 -> 2.3.0) - atlassian-python-api (3.39.0 -> 3.41.0) - hypothesis (6.82.0 -> 6.82.6) - more-itertools (9.1.0 -> 10.1.0) ## 2023-08-21 - NRLF-669 - Changelog now uses rendered markdown - NRLF-653 - Producer MI - Create data model and insert into database - NRLF-583 - Remove 'newman' from APIGEE proxies (APIGEE repos only) ## 2023-08-16 - NRLF-561 - Fix forward: Add missing NEWS2 document type data contract ## 2023-08-14 - NRLF-533 - 409 Conflict error not thrown on duplicate supersede request - NRLF-585 - Add Live URLs to API Catalogue - NRLF-652 - Producer MI - Add infrastructure for dynamodb streams - NRLF-561 - Build an ASID specific document contract - NRLF-634 - Helper script to create Data Contracts - NRLF-642 - Update converter to v0.0.8 in NRLF repository - NRLF-652 - Fix forward: Remove tags from security groups associations - NRLF-561 - Fix forward: Fix ASID url - NRLF-634 - Fix forward: Fix intermittent deploy contract test - NRLF-494 - Fix forward: Revert changes introduced by NRLF-494, due to being too restrictive for converter ## 2023-08-03a - NRLF-491 - Implement int-sandbox splunk environment - NRLF-525 - Add versioning to firehose S3 bucket - NRLF-529 - ASDF Tool manager - NRLF-613 - Increase lambda memory size - NRLF-638 - Can create documents with contact details - NRLF-658 - Consumer S3 Auth ## 2023-07-27 - NRLF-526 - CIS2 - NRLF-560 - JSON Schema / Data contracts - NRLF-640 - Add changelog details to narrative - NRLF-650 - Dependabot updates - NRLF-651 - Converter tests - NRLF-655 - Tag/release fix ## 2023-07-19 - NRLF-586 - Consolidate and publish CHANGELOG.md - NRLF-460 - Merge steps for search, searchPost and count - NRLF-599 - SSO - NRLF-620 - Update the IAM-developer role for mgmt to allow them to call test secrets (done within NRLF-599 branch) - NRLF-624 - Dependabot part 4 - More updates from the dependabot sorting and merging - NRLF-627 - The release tag creation mechanism needs to use changelog file ## 2023-07-11a - NRLF-605 - Update Readme - NRLF-506 - [MI/BI] DB schema and querying the DB ## 2023-07-06 - NRLF 559 - author is included in set of immutable fields - NRLF 492 - Use latest change log for release tag - NRLF 610 - dependabot changes - NRLF 616 - Added feature test for fully populated NRL pointer ## 2023-06-30 - Fix Count End Point has incorrect parameters (NRLF-577) - Fix URL in prod smoke tests (NRLF-614) - Create operation should fail when id(part after '-') has blank or special characters (NRLF-494) ## 2023-06-29 - Remove double hyphen from RDS cluster name ## 2023-06-23 - Authoriser parses headers for authorization into the "request context" to be used by API lambdas - S3 bucket implemented for authorization lookup where nrl.enable-authorisation-lookup has been set - All API lambdas read the authorisation from the event "request context" instead of the event headers - (in nrl-producer-api repo) Update producer apigee proxy to optionally use enable-authorisation-lookup instead of nrl-ods-XXX ## 2023-06-20 - NRLF-522 - errors section in narrative - NRLF-584 - dependabot changes - NRLF-564 - strip empty elements ## 2023-06-14 - NRLF-505 - RDS instance, cluster and other terraform and lambda changes for MI/BI - NRLF-517 - smoke tests that cover the NRL sync functionality - NRLF-550 - Corrections to the ASID system value ## 2023-06-13 - NRLF-578-dependabot changes ## 2023-05-30 - NRLF-535 - New count endpoint - NRLF-543 - type.code feature tests - NRLF-424 - Remove ASID from swagger - NRLF-482 - Make ID immutable field ## 2023-05-15 - Optimisation of status lambda ## 2023-05-11 - Changes to the onboarding documents - Changed the duplicateError to return a 409 instead of 400 - Syncing supersede date ## 2023-05-10 - Supersede will not fail on delete for data sync permissions ## 2023-05-03 - Firehose error alerts - Superseding of created_on and when caller has permission audit-dates-from-payload ## 2023-05-02 Security enhancements: - Deletion protection on DynamoDB - Dependabot improvements ## 2023-04-30 - Fix Count End Point has incorrect parameters - Fix URL in prod smoke tests - Create operation should fail when id(part after '-') has blank or special characters ## 2023-04-25 - Multiple End-User organisations support - Logging improvements - Build improvements - Authentication improvements NRLF-3.0.31/Dockerfile.ci-build000066400000000000000000000024701511201605300160150ustar00rootroot00000000000000FROM ubuntu:22.04 RUN apt update && \ apt upgrade -y && \ DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC apt install -y \ build-essential \ ca-certificates \ curl \ git \ gnupg \ libbz2-dev \ libffi-dev \ libicu70 \ liblzma-dev \ libncursesw5-dev \ libreadline-dev \ libsqlite3-dev \ libssl-dev \ libxml2-dev \ libxmlsec1-dev \ llvm \ lsb-release \ make \ python3 \ tar \ tk-dev \ unzip \ wget \ xz-utils \ zip \ zlib1g-dev && \ apt clean && \ rm -rf /var/lib/apt/lists/* WORKDIR /root RUN git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.13.1 && \ echo ". $HOME/.asdf/asdf.sh" >> ~/.bashrc && \ echo ". $HOME/.asdf/completions/asdf.bash" >> ~/.bashrc && \ echo "export ASDF_DIR=$HOME/.asdf" >> ~/.bashrc && \ echo "export PATH=\$ASDF_DIR/bin:\$PATH" >> ~/.bashrc && \ echo "export PATH=\$ASDF_DIR/shims:\$PATH" >> ~/.bashrc COPY .tool-versions . RUN for plugin in $(cat .tool-versions | cut -d' ' -f1); do \ ./.asdf/bin/asdf plugin add "${plugin}"; \ done && \ ./.asdf/bin/asdf install && \ ln -s $(pwd)/.asdf/shims/* /usr/local/bin/. CMD [ "/bin/bash" ] NRLF-3.0.31/LICENSE000066400000000000000000000020601511201605300133340ustar00rootroot00000000000000MIT License Copyright (c) 2024 Crown Copyright Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. NRLF-3.0.31/Makefile000066400000000000000000000231521511201605300137740ustar00rootroot00000000000000 .EXPORT_ALL_VARIABLES: .NOTPARALLEL: .PHONY: * MAKEFLAGS := --no-print-directory SHELL := /bin/bash DIST_PATH ?= ./dist TEST_ARGS ?= --cov --cov-report=term-missing SMOKE_TEST_ARGS ?= FEATURE_TEST_ARGS ?= ./tests/features --format progress2 TF_WORKSPACE_NAME ?= $(shell terraform -chdir=terraform/infrastructure workspace show) ENV ?= dev ACCOUNT ?= dev APP_ALIAS ?= default HOST ?= $(TF_WORKSPACE_NAME).api.record-locator.$(ENV).national.nhs.uk ENV_TYPE ?= $(ENV) export PATH := $(PATH):$(PWD)/.venv/bin export USE_SHARED_RESOURCES := $(shell poetry run python scripts/are_resources_shared_for_stack.py $(TF_WORKSPACE_NAME)) default: build help: ## Show this help message @echo "Usage: make [target]" @echo @echo "where [target] can be:" @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-30s\033[0m %s\n", $$1, $$2}' asdf-install: ## Install the required tools via ASDF @cat .tool-versions | while read tool_version; do \ tool="$${tool_version% *}"; \ asdf plugin add "$${tool}"; \ done asdf install configure: asdf-install check-warn ## Configure this project repo, including install dependencies cp scripts/commit-msg.py .git/hooks/prepare-commit-msg && chmod ug+x .git/hooks/* poetry install poetry run pre-commit install check: ## Check the build environment is setup correctly @./scripts/check-build-environment.sh check-warn: @SHOULD_WARN_ONLY=true ./scripts/check-build-environment.sh check-deploy: ## check the deploy environment is setup correctly @./scripts/check-deploy-environment.sh check-deploy-warn: @SHOULD_WARN_ONLY=true ./scripts/check-deploy-environment.sh build: check-warn build-api-packages build-layers build-dependency-layer ## Build the project build-dependency-layer: @echo "Building Lambda dependency layer" @mkdir -p $(DIST_PATH) ./scripts/build-lambda-dependency-layer.sh $(DIST_PATH) build-layers: ./layer/* @echo "Building Lambda layers" @mkdir -p $(DIST_PATH) for layer in $^; do \ [ ! -d "$$layer" ] && continue; \ ./scripts/build-lambda-layer.sh $${layer} $(DIST_PATH); \ done build-api-packages: ./api/consumer/* ./api/producer/* @echo "Building API packages" @mkdir -p $(DIST_PATH) for api in $^; do \ [ ! -d "$$api" ] && continue; \ ./scripts/build-lambda-package.sh $${api} $(DIST_PATH); \ done build-ci-image: ## Build the CI image @echo "Building the CI image" docker build \ -t nhsd-nrlf-ci-build:latest \ -f Dockerfile.ci-build ecr-login: ## Login to NRLF ECR repo @echo "Logging into ECR" $(eval AWS_REGION := $(shell aws configure get region)) $(eval AWS_ACCOUNT_ID := $(shell aws sts get-caller-identity | jq -r .Account)) @aws ecr get-login-password --region "$(AWS_REGION)" \ | docker login --username AWS --password-stdin \ $(AWS_ACCOUNT_ID).dkr.ecr.$(AWS_REGION).amazonaws.com publish-ci-image: ## Publish the CI image @echo "Publishing the CI image" $(eval AWS_REGION := $(shell aws configure get region)) $(eval AWS_ACCOUNT_ID := $(shell aws sts get-caller-identity | jq -r .Account)) @docker tag nhsd-nrlf-ci-build:latest \ $(AWS_ACCOUNT_ID).dkr.ecr.$(AWS_REGION).amazonaws.com/nhsd-nrlf-ci-build:latest @docker push $(AWS_ACCOUNT_ID).dkr.ecr.$(AWS_REGION).amazonaws.com/nhsd-nrlf-ci-build:latest test: check-warn ## Run the unit tests @echo "Running unit tests" pytest --ignore=tests/smoke $(TEST_ARGS) test-features-integration: check-warn ## Run the BDD feature tests in the integration environment @echo "Running feature tests in the integration environment ${TF_WORKSPACE_NAME}" behave --define="integration_test=true" \ --define="env=$(TF_WORKSPACE_NAME)" \ --define="account_name=$(ENV)" \ --define="use_shared_resources=${USE_SHARED_RESOURCES}" \ $(FEATURE_TEST_ARGS) integration-test-with-custom_tag: @echo "Running feature tests in the integration environment ${TF_WORKSPACE_NAME}" behave --define="integration_test=true" --tags=@custom_tag \ --define="env=$(TF_WORKSPACE_NAME)" \ --define="account_name=$(ENV)" \ --define="use_shared_resources=${USE_SHARED_RESOURCES}" \ $(FEATURE_TEST_ARGS) test-features-integration-report: check-warn ## Run the BDD feature tests in the integration environment and generate allure report therafter @echo "Cleaning previous Allure results and reports" rm -rf ./allure-results rm -rf ./allure-report @echo "Running feature tests in the integration environment" behave --define="integration_test=true" \ --define="env=$(TF_WORKSPACE_NAME)" \ --define="account_name=$(ENV)" \ --define="use_shared_resources=${USE_SHARED_RESOURCES}" \ $(FEATURE_TEST_ARGS) @echo "Generating Allure report" allure generate ./allure-results -o ./allure-report --clean @echo "Opening Allure report" allure open ./allure-report test-smoke-internal: check-warn ## Run the smoke tests against the internal environment @echo "Running smoke tests against the internal environment ${TF_WORKSPACE_NAME}" TEST_ENVIRONMENT_NAME=$(ENV) \ TEST_STACK_NAME=$(TF_WORKSPACE_NAME) \ TEST_STACK_DOMAIN=$(shell terraform -chdir=terraform/infrastructure output -raw domain 2>/dev/null) \ TEST_CONNECT_MODE="internal" \ pytest ./tests/smoke/scenarios/* $(SMOKE_TEST_ARGS) test-smoke-public: check-warn ## Run the smoke tests for the external access points @echo "Running smoke tests for the public endpoints ${ENV}" TEST_ENVIRONMENT_NAME=$(ENV) \ TEST_STACK_NAME=$(TF_WORKSPACE_NAME) \ TEST_CONNECT_MODE="public" \ pytest ./tests/smoke/scenarios/* $(SMOKE_TEST_ARGS) test-performance-prepare: mkdir -p $(DIST_PATH) PYTHONPATH=. poetry run python tests/performance/environment.py setup $(TF_WORKSPACE_NAME) test-performance: check-warn test-performance-baseline test-performance-stress ## Run the performance tests test-performance-baseline: @echo "Running consumer performance baseline test" k6 run --out csv=$(DIST_PATH)/consumer-baseline.csv tests/performance/consumer/baseline.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE) test-performance-stress: @echo "Running consumer performance stress test" k6 run --out csv=$(DIST_PATH)/consumer-stress.csv tests/performance/consumer/stress.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE) test-performance-soak: @echo "Running consumer performance soak test" k6 run --out csv=$(DIST_PATH)/consumer-soak.csv tests/performance/consumer/soak.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE) test-performance-output: ## Process outputs from the performance tests @echo "Processing performance test outputs" poetry run python tests/performance/process_results.py baseline $(DIST_PATH)/consumer-baseline.csv poetry run python tests/performance/process_results.py stress $(DIST_PATH)/consumer-stress.csv test-performance-cleanup: PYTHONPATH=. poetry run python tests/performance/environment.py cleanup $(TF_WORKSPACE_NAME) lint: check-warn ## Lint the project SKIP="no-commit-to-branch" pre-commit run --all-files clean: ## Remove all generated and temporary files [ -n "$(DIST_PATH)" ] && \ rm -rf $(DIST_PATH)/*.zip && \ rmdir $(DIST_PATH) 2>/dev/null || true get-access-token: check-warn ## Get an access token for an environment @poetry run python tests/utilities/get_access_token.py $(ENV) $(APP_ALIAS) get-s3-perms: check-warn ## Get s3 permissions for an environment poetry run python scripts/get_s3_permissions.py ${USE_SHARED_RESOURCES} $(ENV) $(TF_WORKSPACE_NAME) "$(DIST_PATH)" @echo "Creating new Lambda NRLF permissions layer zip" ./scripts/add-perms-to-lambda.sh $(DIST_PATH) set-smoketest-perms: check-warn ## Set the permissions for the smoke tests @echo "Setting permissions for smoke tests of env=$(ENV) stack=$(TF_WORKSPACE_NAME)...." poetry run python scripts/set_smoketest_permissions.py $(ENV) $(TF_WORKSPACE_NAME) $(ENV) truststore-build-all: check-warn ## Build all truststore resources @./scripts/truststore.sh build-all truststore-build-ca: check-warn ## Build a CA (Certificate Authority) @./scripts/truststore.sh build-ca "$(CA_NAME)" "$(CA_SUBJECT)" truststore-build-cert: check-warn ## Build a certificate @./scripts/truststore.sh build-cert "$(CA_NAME)" "$(CERT_NAME)" "$(CERT_SUBJECT)" truststore-pull-all-for-account: check-warn ## Pull all certificates for each environment in a given account @./scripts/truststore.sh pull-all-for-account "$(ACCOUNT)" truststore-pull-all: check-warn ## Pull all certificates @./scripts/truststore.sh pull-all "$(ENV)" truststore-pull-server: check-warn ## Pull a server certificate @./scripts/truststore.sh pull-server "$(ENV)" truststore-pull-client: check-warn ## Pull a client certificate @./scripts/truststore.sh pull-client "$(ENV)" truststore-pull-ca: check-warn ## Pull a CA certificate @./scripts/truststore.sh pull-ca "$(ENV)" swagger-merge: check-warn ## Generate Swagger Documentation @./scripts/swagger.sh merge "$(TYPE)" generate-models: check-warn ## Generate Pydantic Models @echo "Generating producer models" mkdir -p ./layer/nrlf/producer/fhir/r4 poetry run datamodel-codegen \ --input ./api/producer/swagger.yaml \ --input-file-type openapi \ --output ./layer/nrlf/producer/fhir/r4/model.py \ --output-model-type "pydantic_v2.BaseModel" \ --base-class nrlf.core.parent_model.Parent poetry run datamodel-codegen \ --strict-types {str,bytes,int,float,bool} \ --input ./api/producer/swagger.yaml \ --input-file-type openapi \ --output ./layer/nrlf/producer/fhir/r4/strict_model.py \ --base-class nrlf.core.parent_model.Parent \ --output-model-type "pydantic_v2.BaseModel" @echo "Generating consumer model" mkdir -p ./layer/nrlf/consumer/fhir/r4 poetry run datamodel-codegen \ --input ./api/consumer/swagger.yaml \ --input-file-type openapi \ --output ./layer/nrlf/consumer/fhir/r4/model.py \ --base-class nrlf.core.parent_model.Parent \ --output-model-type "pydantic_v2.BaseModel" NRLF-3.0.31/README.md000066400000000000000000000370511511201605300136160ustar00rootroot00000000000000# NRLF ## Overview This project has been given the name `nrlf` which stands for `National Records Locator (Futures)` as a replacement of the existing NRL. This project uses the `Makefile` to build, test and deploy. This will ensure that a developer can reproduce any operation that the CI/CD pipelines does, meaning they can test the application locally or on their own deployed dev environment. ## Table of Contents - [Before You Begin](#before-you-begin) - [Getting Started](#getting-started) - [Deploying](#deploying) - [Feature Tests](#feature-tests) - [OAuth Tokens for API request](#oauth-tokens-for-api-requests) - [Route53 & Hosted Zones](#route53--hosted-zones) - [Sandbox](#sandbox) - [Releases](#releases) - [Reports](#reports) ## Before You Begin Before you start using this repository, you will need to: - Follow the instructions on the [Developer Onboarding Guide](https://nhsd-confluence.digital.nhs.uk/pages/viewpage.action?spaceKey=CLP&title=NRLF+-+Developer+Onboarding) in confluence - Install `asdf` using https://asdf-vm.com/guide/getting-started.html Confirm `asdf` is installed and is working with: ``` asdf --version ``` Then install all the dependency packages with: ``` make configure ``` ### Set up AWS CLI access There are several ways to set up your AWS CLI access. The recommended way is to use [granted](https://docs.commonfate.io/granted/getting-started). Follow the instructions on their website to install and configure `granted`. One of the gotchas with using `granted` is that you need to ensure that you source the environment variables into your shell session. You can do this by running: ``` source assume ``` Where `` is one of the profiles which should be in your `~/.aws/config`. You can customize the profile names to your liking. From here on, you can use the AWS CLI as normal and run commands that need AWS access on that terminal session. As a short guideline about profiles to assume for a typical workflow: - Assume mgmt account for stack specific terraform deployment as indicated in `terraform/infrastructure/README.md`. - Assume the specific environment for running feature tests against that environment. ### Set up NRLF certificates In order to execute make commands that need AWS access, you will need to pull the NRLF certificates. In order to do this, make sure you have AWS CLI installed and configured, assume the mgmt account, then run: ``` make ENV=env truststore-pull-all ``` Where `env` is one of `dev`, `qa` , `int`, `perftest`, `ref` or `prod`. ## Getting Started To build packages: ``` make ``` To run the linters over your changes: ``` make lint ``` To run the unit tests: ``` make test ``` To run the local feature tests: ``` make test-features ``` ### Troubleshooting To check your environment: ``` make check ``` this will provide a report of the dependencies in your environment and should highlight the things that are not configured correctly or things that are missing. ### Integration testing For the integration tests, you need to have deployed your infrastructure (using Terraform). To run integration tests: ``` make test-integration ``` To run the Firehose integration tests: ``` make test-firehose-integration ``` To run all the feature integration tests: ``` make test-features-integration ``` To run individual feature test scenario(s) using the custom tag : 1. Add `@custom_tag` before each 'Scenario' that needs to be run (in each .feature file) 2. Run the command below: ``` make integration-test-with-custom_tag ``` To run all the feature integration tests and generate an interactive Allure report thereafter : ``` make test-features-integration-report ``` ### Debugging Behave Integration Tests in VS Code Integration tests can be debugged directly in **VS Code** using a launch configuration. Instructions on how to set this up for the first time and run the debugger are below. --- #### 1. Create the Launch Configuration To get started: 1. Open VS Code and press `Ctrl+Shift+P` 2. Search for **“Add Configuration”** and select it 3. Choose **Python** > **Module** 4. Replace the generated entry in `.vscode/launch.json` with an appropriate launch.json configuration. Below is a example which can be modified as required: ```json // .vscode/launch.json { "version": "0.2.0", "configurations": [ { "name": "Debug Behave", "type": "debugpy", "request": "launch", "module": "behave", "args": [ "-D", "env=example-env", "tests/features", "-D", "integration_test=true", "--tags=@custom_tag" ], "console": "integratedTerminal", "justMyCode": true, "env": { "PYTHONPATH": "${workspaceFolder}" // adds your project code to Python path }, "cwd": "${workspaceFolder}" // resolves to the root directory } ] } ``` Once steps 1-4 are done, "Debug Behave" should appear in the Run and Debug panel. #### 2. Customizing the Debug Configuration You can tailor the args section in .vscode/launch.json to suit your specific environment, tags, or test structure. For example: To run only tests with the @api tag, set the --tags accordingly: ``` "args": ["--tags=@api"..] ``` #### 3. Running the Debugger To start debugging using the launch configuration from VS Code: 1. Go to the Run and Debug panel `Ctrl+Shift+D` 2. Ensure **“Debug Behave”** (if this is the name used in **“launch.json”**) is selected from the dropdown at the top 3. Press `F5` to start debugging ### Smoke testing For smoke tests, you need to have deployed your infrastructure (using Terraform). Before the first run of the smoke tests, you need to set the required permissions in your deployment. You can do this by running: ``` make set-smoketest-perms ``` To run the internal smoke tests against your stack, do this: ``` make test-smoke-internal ``` To run the smoke tests against the public access endpoints (via APIGEE proxies), do this: ``` make test-smoke-public ``` ## API Documentation If the API changes, the API documentation needs to be updated in the appropriate API repo. This is done by making changes to the API specification `.yaml` files in each repo. For Consumer API changes, update [NRL Consumer API - consumer.yaml](https://github.com/NHSDigital/nrl-consumer-api/blob/master/specification/record-locator/consumer.yaml) For Producer API changes, update [NRL Producer API - producer.yaml](https://github.com/NHSDigital/nrl-producer-api/blob/master/specification/record-locator/producer.yaml) Changes to the files in those repos will be reflected when each one is released. See the documentation in each repo for this process. ## Deploying The NRLF is deployed using terraform. The infrastructure is split into two parts. All account wide resources like Route 53 hosted zones or IAM roles are found in `terraform/account-wide-infrastructure` All resources that are not account specific (lambdas, API gateways etc) can be found in `terraform/infrastructure` Information on deploying these two parts: - [NRLF main infrastructure](./terraform/infrastructure/README.md) - [NRLF account wide infrastructure](./terraform/account-wide-infrastructure/README.md) ## Feature tests Referring to the sample feature test below: ```gherkin Scenario: Successfully create a Document Pointer of type Mental health crisis plan Given {ACTOR TYPE} "{ACTOR}" (Organisation ID "{ORG_ID}") is requesting to {ACTION} Document Pointers And {ACTOR TYPE} "{ACTOR}" is registered in the system for application "APP 1" (ID "{APP ID 1}") for document types | system | value | | http://snomed.info/sct | 736253002 | And {ACTOR TYPE} "{ACTOR}" has authorisation headers for application "APP 2" (ID "{APP ID 2}") When {ACTOR TYPE} "{ACTOR}" {ACTION} a Document Reference from DOCUMENT template | property | value | | identifier | 1234567890 | | type | 736253002 | | custodian | {ORG_ID} | | subject | 9278693472 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | Then the operation is {RESULT} ``` The following notes should be made: 1. ACTOR TYPE, ACTOR and ACTION are forced to be consistent throughout your test 2. ACTOR TYPE, ACTOR, ACTION, ORG_ID, APP, APP ID, and RESULT are enums: their values are restricted to a predefined set 3. ACTOR is equivalent to to both custodian and organisation 4. The request method (GET, POST, ...) and slug (e.g. DocumentReference/\_search) for ACTION is taken from the swagger. 5. ”Given ... is requesting to” is mandatory: it sets up the base request 6. ”And ... is registered to” sets up a org:app:doc-types entry in Auth table 7. ”And ... has authorisation headers” sets up authorisation headers ## OAuth tokens for API requests Clients must provide OAuth access tokens when making requests to the NRLF APIs. To create an access token for the dev environment, you can do the following: ``` make get-access-token ``` To create an access token for another environment: ``` $ make ENV=[env-name] get-access-token ``` Valid `[env-name]` values are `dev`, `int`, `ref` and `prod` for each associated NRLF environment. Once you have your access token, you provide it as a bearer token in your API requests using the `Authorization` header, like this: ``` Authorization: Bearer ``` If you need to get an API token for the `nrl_sync` application, the command is: ``` $ make ENV=[env-name] APP_ALIAS=nrl_sync get-access-token ``` ## Route53 & Hosted Zones There are 2 parts to the Route53 configuration: ### 1. environment accounts In `terraform/account-wide-infrastructure/prod/route53.tf`, we have a Hosted Zone: ```terraform resource "aws_route53_zone" "dev-ns" { name = "dev.internal.record-locator.devspineservices.nhs.uk" } ``` ### 2. mgmt account In `terraform/account-wide-infrastructure/mgmt/route53.tf` we have both a Hosted Zone and a Record per environment: ```terraform resource "aws_route53_zone" "prodspine" { name = "record-locator.spineservices.nhs.uk" tags = { Environment = terraform.workspace } } resource "aws_route53_record" "prodspine" { zone_id = aws_route53_zone.prodspine.zone_id name = "prod.internal.record-locator.spineservices.nhs.uk" records = ["ns-904.awsdns-49.net.", "ns-1539.awsdns-00.co.uk.", "ns-1398.awsdns-46.org.", "ns-300.awsdns-37.com." ] ttl = 300 type = "NS" } ``` The `records` property is derived by first deploying to a specific environment, in this instance, production, and from the AWS Console navigating to the Route53 Hosted Zone that was just deployed and copying the "Value/Route traffic to" information into the `records` property. Finally, deploy to the mgmt account with the new information. --- ## Sandbox The public-facing sandbox is an additional persistent workspace (`int-sandbox`) deployed in our INT (`int` / `test`) environment, alongside the persistent workspace named `ref`. It is identical to our live API, except it is open to the world via Apigee (which implements rate limiting on our behalf). ### Sandbox deployment In order to deploy to a sandbox environment (`dev-sandbox`, `qa-sandbox`, `int-sandbox`) you should use the GitHub Action for persistent environments, where you should select the option to deploy to the sandbox workspace. ### Sandbox database clear and reseed Any workspace suffixed with `-sandbox` has a small amount of additional infrastructure deployed to clear and reseed the DynamoDB tables (auth and document pointers) using a Lambda running on a cron schedule that can be found in the `cron/seed_sandbox` directory in the root of this project. The data used to seed the DynamoDB tables can found in the `cron/seed_sandbox/data` directory. ### Sandbox authorisation The configuration of organisations auth / permissions is dealt with in the "apigee" repos, i.e. - https://github.com/NHSDigital/record-locator/producer - https://github.com/NHSDigital/record-locator/consumer Specifically, the configuration can be found in the file proxies/sandbox/apiproxy/resources/jsc/ConnectionMetadata.SetRequestHeaders.js in these repos. 💡 Developers should make sure that these align between the three repos according to any user journeys that they envisage. Additionally, and less importantly, there are also fixed organization details in proxies/sandbox/apiproxy/resources/jsc/ClientRPDetailsHeader.SetRequestHeaders.js in these repos. ## Releases The process to create a new release is as follows: 1. In [Github Releases](https://github.com/NHSDigital/NRLF/releases), press the "Draft new release" button. 2. Press "Choose a tag" and enter the version of the release, say `v3.0.1`. This will be the tag we use to release from. 3. Select `develop` for the release Target 4. Press "Generate release notes" button. This will populate the description with everything that's changed since the last release. 5. Enter the version of the release into the Release Title field, say `v3.0.1` 6. Arrange and update the description to accuruately represent the highlights of the release. 7. Make sure the "Set as a pre-release" checkbox it set 8. Press the "Publish release" button to complete the release process Once your new release has been created, you can then deploy this release through the NRLF environments using the "Persistent Environment Deploy" Github Action. Once your release has been deployed to prod, edit the release and set the "Set as the latest release" checkbox. If the Consumer API has changed, or the documentation for that API has changed, you will also need to release [NRL Consumer API](https://github.com/NHSDigital/nrl-consumer-api). If the Producer API has changed, or the documentation for that API has changed, you will also need to release [NRL Producer API](https://github.com/NHSDigital/nrl-producer-api). ### Deploying releases Once you have a new release version ready, you can deploy it through our environments as follows: 1. Use the "Persistent Environment Deploy" Github Action workflow to deploy the release tag to `dev`, `dev-sandbox`, `qa`, `qa-sandbox`, `int`, `int-sandbox` and `perftest` environments. 2. If any issues arise in the deployment, fix the issues, create a new release version and start this process again. 3. Once the deployments are complete, use the "Persistent Environment Deploy" Github Action workflow to deploy the release version to `ref`. 4. Once that is complete, use the "Persistent Environment Deploy" workflow to deploy the release version to `prod`. ## Reports Reports are provided as scripts in the `reports/` directory. To run a report: 1. Login to your AWS account on the command line, choosing the account that contains the resources you want to report on. 2. Run your chosen report script, giving the script the resource names and parameters it requires. See each report script for details. For example, to count the number of pointers from X26 in the pointers table in the dev environment: ``` $ poetry run python ./scripts/count_pointers_for_custodian.py \ nhsd-nrlf--dev-pointers-table \ X26 ``` ### Running reports in the prod environment The reports scripts may require resources that could affect the performance of the live production system. Because of this, it is recommended that you take steps to minimise this impact before running reports. If you are running a report against the DynamoDB pointers table in prod, you should create a copy (or restore a PITR backup) of the table and run your report against the copy. Please ensure any duplicated resource/data is deleted from the prod environment once you have finished using it. NRLF-3.0.31/api/000077500000000000000000000000001511201605300131025ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/000077500000000000000000000000001511201605300147355ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/readDocumentReference/000077500000000000000000000000001511201605300211665ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/readDocumentReference/read_document_reference.py000066400000000000000000000053671511201605300264020ustar00rootroot00000000000000import sys import urllib.parse from pydantic import ValidationError from nrlf.consumer.fhir.r4.model import DocumentReference from nrlf.core.decorators import request_handler from nrlf.core.dynamodb.repository import DocumentPointerRepository from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, ReadDocumentReferencePathParams from nrlf.core.response import Response, SpineErrorConcept, SpineErrorResponse @request_handler(path=ReadDocumentReferencePathParams) def handler( repository: DocumentPointerRepository, metadata: ConnectionMetadata, path: ReadDocumentReferencePathParams, ) -> Response: """ Reads a document reference based on the provided parameters. Args: repository (DocumentPointerRepository): The repository used to retrieve the document reference. metadata (ConnectionMetadata): The metadata containing connection information. path (ReadDocumentReferencePathParams): The path parameters for the document reference. Returns: Response: The response containing the document reference. Raises: OperationOutcomeError: If an error occurs while parsing the document reference. SpineErrorResponse: If the requested document reference is not found or access is denied. """ logger.log(LogReference.CONREAD000) parsed_id = urllib.parse.unquote(path.id) result = repository.get_by_id(parsed_id) if result is None: logger.log(LogReference.CONREAD001) return SpineErrorResponse.NO_RECORD_FOUND( diagnostics="The requested DocumentReference could not be found" ) if result.type not in metadata.pointer_types: logger.log( LogReference.CONREAD002, ods_code=metadata.ods_code, type=result.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.ACCESS_DENIED( diagnostics="The requested DocumentReference is not of a type that this organisation is allowed to access" ) try: document_reference = DocumentReference.model_validate_json(result.document) except ValidationError as exc: logger.log( LogReference.CONREAD003, exc_info=sys.exc_info(), error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred while parsing the document reference", ) from exc response = Response.from_resource(document_reference) logger.log(LogReference.CONREAD999) return response NRLF-3.0.31/api/consumer/readDocumentReference/tests/000077500000000000000000000000001511201605300223305ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/readDocumentReference/tests/test_read_document_reference_consumer.py000066400000000000000000000142451511201605300325110ustar00rootroot00000000000000import json from moto import mock_aws from api.consumer.readDocumentReference.read_document_reference import handler from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_read_document_reference_happy_path(repository: DocumentPointerRepository): # Create the document pointer doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == doc_ref.model_dump(exclude_none=True) @mock_aws @mock_repository def test_read_document_reference_not_found(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "404", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "coding": [ { "code": "NO_RECORD_FOUND", "display": "No record found", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The requested DocumentReference could not be found", } ], } def test_read_document_reference_missing_id(): event = create_test_api_gateway_event(headers=create_headers(), path_parameters={}) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_PARAMETER", "display": "Invalid parameter", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid path parameter (id: Field required)", "expression": ["id"], } ], } @mock_aws @mock_repository def test_read_document_reference_unauthorised_for_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("RQI-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(app_id="12356", ods_code="RQI"), path_parameters={"id": doc_pointer.id}, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "403", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "code": "ACCESS DENIED", "display": "Access has been denied to process this request", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The requested DocumentReference is not of a type that this organisation is allowed to access", } ], } @mock_aws @mock_repository def test_document_reference_invalid_json(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) doc_pointer.document = "invalid json" repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": doc_pointer.id}, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "500", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred while parsing the document reference", } ], } NRLF-3.0.31/api/consumer/searchDocumentReference/000077500000000000000000000000001511201605300215205ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/searchDocumentReference/search_document_reference.py000066400000000000000000000136461511201605300272650ustar00rootroot00000000000000from pydantic import ValidationError from nrlf.consumer.fhir.r4.model import ( Bundle, DocumentReference, OperationOutcome, OperationOutcomeIssue, ) from nrlf.core.codes import SpineErrorConcept from nrlf.core.config import Config from nrlf.core.decorators import request_handler from nrlf.core.dynamodb.repository import DocumentPointerRepository from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, ConsumerRequestParams from nrlf.core.response import Response, SpineErrorResponse from nrlf.core.validators import validate_category, validate_type @request_handler(params=ConsumerRequestParams) def handler( metadata: ConnectionMetadata, params: ConsumerRequestParams, repository: DocumentPointerRepository, ) -> Response: """ Searches for document references based on the provided parameters. Args: metadata (ConnectionMetadata): The connection metadata. params (ConsumerRequestParams): The consumer request parameters. repository (DocumentPointerRepository): The document pointer repository. Returns: Response: The response containing the search results. Raises: OperationOutcomeError: If an error occurs while parsing the document reference. """ logger.log(LogReference.CONSEARCH000) if not params.nhs_number: logger.log( LogReference.CONSEARCH001, subject_identifier=params.subject_identifier ) return SpineErrorResponse.INVALID_NHS_NUMBER( diagnostics="A valid NHS number is required to search for document references", expression="subject:identifier", ) config = Config() base_url = f"https://{config.ENVIRONMENT}.api.service.nhs.uk/" self_link = f"{base_url}record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{params.nhs_number}" if not validate_type(params.type, metadata.pointer_types): logger.log( LogReference.CONSEARCH002, type=params.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="Invalid query parameter (The provided type does not match the allowed types for this organisation)", expression="type", ) categories = params.category.root.split(",") if params.category else [] if not validate_category(categories): logger.log( LogReference.CONSEARCH002b, category=params.category, ) # TODO - Should update error message once permissioning by category is implemented return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="Invalid query parameter (The provided category is not valid)", expression="category", ) custodian_id = ( params.custodian_identifier.root.split("|", maxsplit=1)[1] if params.custodian_identifier else None ) if custodian_id: self_link += f"&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|{custodian_id}" pointer_types = [params.type.root] if params.type else metadata.pointer_types if params.type: self_link += f"&type={params.type.root}" if params.category: self_link += f"&category={params.category.root}" if params.field_summary: self_link += f"&_summary={params.field_summary.root}" bundle = { "resourceType": "Bundle", "type": "searchset", "link": [{"relation": "self", "url": self_link}], "total": 0, "entry": [], } logger.log( LogReference.CONSEARCH003, nhs_number=params.nhs_number, custodian=custodian_id, pointer_types=pointer_types, ) if params.field_summary and params.field_summary.root == "count": bundle = { "resourceType": "Bundle", "type": "searchset", "link": [{"relation": "self", "url": self_link}], "total": 0, } logger.log(LogReference.CONSEARCH006) total = repository.count_by_nhs_number( nhs_number=params.nhs_number, pointer_types=pointer_types, ) bundle["total"] = total logger.log(LogReference.CONSEARCH007, total=total) response = Response.from_resource(Bundle.model_validate(bundle)) logger.log(LogReference.CONSEARCH999) return response for result in repository.search( nhs_number=params.nhs_number, custodian=custodian_id, pointer_types=pointer_types, categories=categories, ): try: document_reference = DocumentReference.model_validate_json(result.document) bundle["total"] += 1 bundle["entry"].append( {"resource": document_reference.model_dump(exclude_none=True)} ) logger.log( LogReference.CONSEARCH004, id=document_reference.id, count=bundle["total"], ) except ValidationError as exc: logger.log( LogReference.CONSEARCH005, error=str(exc), document=result.document ) operation_outcome = OperationOutcome( resourceType="OperationOutcome", issue=[ OperationOutcomeIssue( severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred whilst parsing the document reference search results", ) ], ) bundle["total"] += 1 bundle["entry"].append( {"resource": operation_outcome.model_dump(exclude_none=True)} ) response = Response.from_resource(Bundle.model_validate(bundle)) logger.log(LogReference.CONSEARCH999) return response NRLF-3.0.31/api/consumer/searchDocumentReference/tests/000077500000000000000000000000001511201605300226625ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/searchDocumentReference/tests/test_search_document_reference_consumer.py000066400000000000000000000667041511201605300334040ustar00rootroot00000000000000import json from unittest.mock import patch from moto import mock_aws from api.consumer.searchDocumentReference.search_document_reference import handler from nrlf.consumer.fhir.r4.model import CodeableConcept, Identifier from nrlf.core.constants import ( CATEGORY_ATTRIBUTES, TYPE_ATTRIBUTES, Categories, PointerTypes, ) from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_search_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_accession_number_in_pointer( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.identifier = [ Identifier( type=CodeableConcept(text="Accession-Number"), value="Y05868.123456789" ) ] doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } created_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert created_doc_pointer is not None assert json.loads(created_doc_pointer.document)["identifier"] == [ {"type": {"text": "Accession-Number"}, "value": "Y05868.123456789"} ] @mock_aws @mock_repository def test_search_document_reference_happy_path_with_custodian( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "custodian:identifier": "https://fhir.nhs.uk/Id/ods-organization-code|Y05868", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|Y05868", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "http://snomed.info/sct|736253002", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_category( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&category=http://snomed.info/sct|734163000", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_category_and_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000", "type": "http://snomed.info/sct|736253002", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002&category=http://snomed.info/sct|734163000", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_category_and_type_no_results( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|1102421000000108", "type": "http://snomed.info/sct|736253002", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002&category=http://snomed.info/sct|1102421000000108", } ], "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_multiple_categories_and_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", "type": "http://snomed.info/sct|736253002", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002&category=http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_multiple_categories( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&category=http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", } ], "total": 2, "entry": [ {"resource": doc_ref2.model_dump(exclude_none=True)}, {"resource": doc_ref.model_dump(exclude_none=True)}, ], } @mock_aws @mock_repository def test_search_document_reference_happy_path_with_nicip_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.type.coding[0].code = "MAULR" doc_ref.type.coding[0].system = "https://nicip.nhs.uk" doc_ref.type.coding[0].display = "MRA Upper Limb Rt" doc_ref.category[0].coding[0].code = "721981007" doc_ref.category[0].coding[0].display = "Diagnostic Studies Report" doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "https://nicip.nhs.uk|MAULR", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=https://nicip.nhs.uk|MAULR", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_no_results(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_document_reference_missing_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_PARAMETER", "display": "Invalid parameter", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid query parameter (subject:identifier: Field required)", "expression": ["subject:identifier"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|123" }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "A valid NHS number is required to search for document references", "expression": ["subject:identifier"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_type(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid query parameter (The provided type does not match the allowed types for this organisation)", "expression": ["type"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_category( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid query parameter (The provided category is not valid)", "expression": ["category"], } ], } @mock_aws @mock_repository def test_search_document_reference_filters_by_summary_count( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "_summary": "count", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&_summary=count", } ], } @mock_aws @mock_repository @patch("api.consumer.searchDocumentReference.search_document_reference.logger") def test_search_document_reference_invalid_json( mock_logger, repository: DocumentPointerRepository ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_pointer_invalid = DocumentPointer.from_document_reference(doc_ref) doc_pointer_invalid.id = "Y05868-11111-99999-999992" doc_pointer_invalid.document = "invalid json" repository.create(doc_pointer_invalid) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191" }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) expected_operation_outcome = { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred whilst parsing the document reference search results", } ], } assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "total": 2, "entry": [ {"resource": doc_ref.model_dump(exclude_none=True)}, {"resource": expected_operation_outcome}, ], } assert any( call[0][0].name == "CONSEARCH005" for call in mock_logger.log.call_args_list ) NRLF-3.0.31/api/consumer/searchPostDocumentReference/000077500000000000000000000000001511201605300223665ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/searchPostDocumentReference/search_post_document_reference.py000066400000000000000000000141061511201605300311700ustar00rootroot00000000000000from pydantic import ValidationError from nrlf.consumer.fhir.r4.model import Bundle, DocumentReference from nrlf.core.codes import SpineErrorConcept from nrlf.core.config import Config from nrlf.core.decorators import request_handler from nrlf.core.dynamodb.repository import DocumentPointerRepository from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, ConsumerRequestParams from nrlf.core.response import Response, SpineErrorResponse from nrlf.core.validators import validate_category, validate_type from nrlf.producer.fhir.r4.model import OperationOutcome, OperationOutcomeIssue @request_handler(body=ConsumerRequestParams) def handler( body: ConsumerRequestParams, metadata: ConnectionMetadata, repository: DocumentPointerRepository, ) -> Response: """ Search for document references based on the provided parameters. Args: body (ConsumerRequestParams): The request parameters for the search. metadata (ConnectionMetadata): The metadata containing pointer types. repository (DocumentPointerRepository): The repository for document pointers. Returns: Response: The response containing the search results. Raises: SpineErrorResponse.INVALID_NHS_NUMBER: If a valid NHS number is not provided. SpineErrorResponse.INVALID_CODE_SYSTEM: If the provided type system is invalid. OperationOutcomeError: If an error occurs while parsing the document reference. """ logger.log(LogReference.CONPOSTSEARCH000) if not body.nhs_number: logger.log( LogReference.CONPOSTSEARCH001, subject_identifier=body.subject_identifier ) return SpineErrorResponse.INVALID_NHS_NUMBER( diagnostics="A valid NHS number is required to search for document references", expression="subject:identifier", ) config = Config() base_url = f"https://{config.ENVIRONMENT}.api.service.nhs.uk/" self_link = f"{base_url}record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|{body.nhs_number}" if not validate_type(body.type, metadata.pointer_types): logger.log( LogReference.CONPOSTSEARCH002, type=body.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="The provided type does not match the allowed types for this organisation", expression="type", ) categories = body.category.root.split(",") if body.category else [] if not validate_category(categories): logger.log( LogReference.CONPOSTSEARCH002b, category=body.category, ) # TODO - Should update error message once permissioning by category is implemented return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="The provided category is not valid", expression="category", ) custodian_id = ( body.custodian_identifier.root.split("|", maxsplit=1)[1] if body.custodian_identifier else None ) if custodian_id: self_link += f"&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|{custodian_id}" pointer_types = [body.type.root] if body.type else metadata.pointer_types if body.type: self_link += f"&type={body.type.root}" if body.category: self_link += f"&category={body.category.root}" if body.field_summary: self_link += f"&_summary={body.field_summary.root}" bundle = { "resourceType": "Bundle", "type": "searchset", "link": [{"relation": "self", "url": self_link}], "total": 0, "entry": [], } logger.log( LogReference.CONPOSTSEARCH003, nhs_number=body.nhs_number, custodian_id=custodian_id, pointer_types=pointer_types, ) if body.field_summary and body.field_summary.root == "count": bundle = { "resourceType": "Bundle", "type": "searchset", "link": [{"relation": "self", "url": self_link}], "total": 0, } logger.log(LogReference.CONPOSTSEARCH006) total = repository.count_by_nhs_number( nhs_number=body.nhs_number, pointer_types=pointer_types, ) bundle["total"] = total logger.log(LogReference.CONPOSTSEARCH007, total=total) response = Response.from_resource(Bundle.model_validate(bundle)) logger.log(LogReference.CONPOSTSEARCH999) return response for result in repository.search( nhs_number=body.nhs_number, custodian=custodian_id, pointer_types=pointer_types, categories=categories, ): try: document_reference = DocumentReference.model_validate_json(result.document) bundle["total"] += 1 bundle["entry"].append( {"resource": document_reference.model_dump(exclude_none=True)} ) logger.log( LogReference.CONPOSTSEARCH004, id=document_reference.id, count=bundle["total"], ) except ValidationError as exc: logger.log( LogReference.CONPOSTSEARCH005, error=str(exc), document=result.document ) operation_outcome = OperationOutcome( resourceType="OperationOutcome", issue=[ OperationOutcomeIssue( severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred whilst parsing the document reference search results", ) ], ) bundle["total"] += 1 bundle["entry"].append( {"resource": operation_outcome.model_dump(exclude_none=True)} ) response = Response.from_resource(Bundle.model_validate(bundle)) logger.log(LogReference.CONPOSTSEARCH999) return response NRLF-3.0.31/api/consumer/searchPostDocumentReference/tests/000077500000000000000000000000001511201605300235305ustar00rootroot00000000000000test_search_post_document_reference_consumer.py000066400000000000000000000447161511201605300352370ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/searchPostDocumentReference/testsimport json from unittest.mock import patch from moto import mock_aws from api.consumer.searchPostDocumentReference.search_post_document_reference import ( handler, ) from nrlf.core.constants import ( CATEGORY_ATTRIBUTES, TYPE_ATTRIBUTES, Categories, PointerTypes, ) from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_search_post_document_reference_happy_path( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_post_document_reference_happy_path_with_custodian( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "custodian:identifier": "https://fhir.nhs.uk/Id/ods-organization-code|Y05868", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|Y05868", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_post_document_reference_happy_path_with_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "http://snomed.info/sct|736253002", }, ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&type=http://snomed.info/sct|736253002", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_post_document_reference_happy_path_with_category( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000", }, ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&category=http://snomed.info/sct|734163000", } ], "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_post_document_reference_happy_path_with_multiple_categories( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&category=http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", } ], "total": 2, "entry": [ {"resource": doc_ref2.model_dump(exclude_none=True)}, {"resource": doc_ref.model_dump(exclude_none=True)}, ], } @mock_aws @mock_repository def test_search_document_reference_no_results(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_post_document_reference_missing_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event(headers=create_headers(), body="{}") result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (subject:identifier: Field required)", "expression": ["subject:identifier"], } ], } @mock_aws @mock_repository def test_search_post_document_reference_invalid_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( {"subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|123"} ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "A valid NHS number is required to search for document references", "expression": ["subject:identifier"], } ], } @mock_aws @mock_repository def test_search_post_document_reference_invalid_type( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The provided type does not match the allowed types for this organisation", "expression": ["type"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_category( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The provided category is not valid", "expression": ["category"], } ], } @mock_aws @mock_repository def test_search_document_reference_filters_by_summary_count( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "_summary": "count", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191&_summary=count", } ], } @mock_aws @mock_repository @patch("api.consumer.searchPostDocumentReference.search_post_document_reference.logger") def test_search_post_document_reference_invalid_json_adds_operation_outcome( mock_logger, repository: DocumentPointerRepository ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_pointer_invalid = DocumentPointer.from_document_reference(doc_ref) doc_pointer_invalid.id = "Y05868-11111-99999-999992" doc_pointer_invalid.document = "invalid json" repository.create(doc_pointer_invalid) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) expected_operation_outcome = { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred whilst parsing the document reference search results", } ], } assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "link": [ { "relation": "self", "url": "https://pytest.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|6700028191", } ], "total": 2, "entry": [ {"resource": doc_ref.model_dump(exclude_none=True)}, {"resource": expected_operation_outcome}, ], } assert any( call[0][0].name == "CONPOSTSEARCH005" for call in mock_logger.log.call_args_list ) NRLF-3.0.31/api/consumer/status/000077500000000000000000000000001511201605300162605ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/status/status.py000066400000000000000000000021341511201605300201550ustar00rootroot00000000000000import sys from nrlf.core.config import Config from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.logger import LogReference, logger from nrlf.core.response import Response @request_handler(skip_request_verification=True) def handler(event, context) -> Response: """ Retrieves the status of the API. Returns: Response: The response object containing the status code and body. """ try: logger.log(LogReference.STATUS000) logger.log(LogReference.STATUS001) config = Config() logger.log(LogReference.STATUS002) repository = DocumentPointerRepository(table_name=config.TABLE_NAME) repository.get_by_id("ODSX-NULL") response = Response(statusCode="200", body="OK") logger.log(LogReference.STATUS999) return response except Exception as exc: logger.log( LogReference.STATUS003, error=str(exc), exc_info=sys.exc_info(), stacklevel=5, ) return Response(statusCode="503", body="Service unavailable") NRLF-3.0.31/api/consumer/status/tests/000077500000000000000000000000001511201605300174225ustar00rootroot00000000000000NRLF-3.0.31/api/consumer/status/tests/test_status_consumer.py000066400000000000000000000021021511201605300242640ustar00rootroot00000000000000import os from moto import mock_aws from api.consumer.status.status import handler from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_status_happy_path(repository): event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) assert result == { "statusCode": "200", "headers": default_response_headers(), "body": "OK", "isBase64Encoded": False, } @mock_aws @mock_repository def test_status_unhandled_exception(repository): region = os.environ.pop("AWS_REGION") event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) assert result == { "statusCode": "503", "headers": default_response_headers(), "body": "Service unavailable", "isBase64Encoded": False, } os.environ.update(AWS_REGION=region) NRLF-3.0.31/api/consumer/swagger.yaml000066400000000000000000002150451511201605300172670ustar00rootroot00000000000000openapi: 3.0.0 # This is an OpenAPI Specification (https://swagger.io/specification/) # for the National Record Locator Consumer FHIR API # owned by NHS Digital (https://digital.nhs.uk/) info: title: National Record Locator Consumer - FHIR API version: 1.0.0 license: name: MIT contact: name: NHS Digital API Management url: "https://digital.nhs.uk/developer/help-and-support" email: api.management@nhs.net servers: - url: https://sandbox.api.service.nhs.uk/record-locator/consumer/FHIR/R4 description: Sandbox environment. - url: https://int.api.service.nhs.uk/record-locator/consumer/FHIR/R4 description: Integration test environment. - url: https://api.service.nhs.uk/record-locator/consumer/FHIR/R4 description: Production environment. tags: paths: /DocumentReference: get: tags: summary: Retrieve patient's document pointers (GET) operationId: searchDocumentReference parameters: - $ref: "#/components/parameters/subject" - $ref: "#/components/parameters/custodian" - $ref: "#/components/parameters/type" - $ref: "#/components/parameters/category" - $ref: "#/components/parameters/nextPageToken" - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "200": description: Successful response content: application/fhir+json: schema: $ref: "#/components/schemas/Bundle" example: resourceType: Bundle type: searchset total: 1 entry: - resource: resourceType: DocumentReference id: Y05868-1634567890 meta: profile: - http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0 masterIdentifier: system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7 identifier: - system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234 status: current docStatus: preliminary type: coding: - system: http://snomed.info/sct code: "736253002" display: Mental health crisis plan category: - coding: - system: http://loinc.org code: 34108-1 display: Outpatient Note subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "4409815415" date: "2022-12-20T09:45:41+11:00" author: - identifier: value: Practitioner/A985657ZA authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 description: Physical securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/MentalHealthCrisisPlan.pdf hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk= title: Physical creation: "2022-12-20T09:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:handp:2008 display: History and Physical Specification context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_searchDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Retrieve the document pointers for a single patient. Your request is constrained by the document pointer types agreed during onboarding. The results can also be filtered to return documents by a given `type` and/or created by a given producer (`custodian`). This operation is also available as a http POST, which is the preferred method (see below). /DocumentReference/_search: post: tags: summary: Retrieve patient's document pointers (POST) operationId: searchPostDocumentReference parameters: - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestParams" responses: "200": description: Search successful response content: application/fhir+json: schema: $ref: "#/components/schemas/Bundle" example: resourceType: Bundle type: searchset total: 1 entry: - resource: resourceType: DocumentReference id: Y05868-1234567895 meta: profile: - http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0 masterIdentifier: system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.9 identifier: - system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1239 status: current docStatus: final type: coding: - system: http://snomed.info/sct code: "736253002" display: Mental Health Crisis Plan category: - coding: - system: http://loinc.org code: 55112-7 display: Document summary subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "4409815415" date: "2022-12-21T10:45:41+11:00" author: - identifier: value: Practitioner/A985657ZA authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 description: Physical securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EOLSummaryReport.pdf size: 4000 hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk= title: Physical creation: "2021-12-21T10:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:cm:2008 display: Care Management context: - event: - coding: system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system - period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" - facilityType: - coding: system: http://snomed.info/sct code: "82242000" display: Children's hospital - practiceSetting: - coding: system: http://snomed.info/sct code: "788002001" display: Adult mental health service - related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_searchPostDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Retrieve the document pointers for a single patient. Your request is constrained by the document pointer types agreed during onboarding. The results can also be filtered to return documents by a given `type` and/or created by a given `custodian`. This operation is also available as a http GET for convenience (see above), but POST is preferred for the following reasons. * query string parameters are visible on the network and in logs, and may have privacy implications for consumers. * GET operations can be cached by intermediary network infrastructure, such as CDNs, routers and proxies. * URLs have a maximum length of 2,048 characters which complex searches can exceed. NRL does not currently exceed this limit, but may evolve in the future. /DocumentReference/{id}: get: tags: summary: Get a single document pointer operationId: readDocumentReference parameters: - $ref: "#/components/parameters/id" - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "200": description: Search successful response content: application/fhir+json: schema: $ref: "#/components/schemas/DocumentReference" example: resourceType: DocumentReference id: Y05868-1234567892 status: current docStatus: final type: coding: - system: http://snomed.info/sct code: "887701000000100" display: Emergency health care plan category: - coding: - system: http://loinc.org code: 68552-9 display: Emergency medicine Emergency department Admission evaluation note subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "4409815415" date: "2022-12-22T11:45:41+11:00" author: - identifier: value: Practitioner/A985657ZA authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EmergencyHealthPlan.pdf creation: "2022-12-22T09:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:handp:2008 display: History and Physical Specification context: - event: - coding: system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system - period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" - facilityType: - coding: system: http://snomed.info/sct code: "82242000" display: Children's hospital - practiceSetting: - coding: system: http://snomed.info/sct code: "788002001" display: Adult mental health service - related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_readDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Read a single document pointer by specifying the `DocumentReference.id`. Note that you will only be able to retrieve document pointers that have the `type` that was agreed during the [onboarding](#api-description__onboarding) process. /metadata: get: summary: Retrieve FHIR Capability Statement operationId: getCapabilityStatement responses: "200": description: Capability statement response content: application/json: schema: type: object x-amazon-apigateway-integration: type: MOCK requestTemplates: application/json: '{ "statusCode": 200 }' responses: default: statusCode: "200" responseTemplates: # prettier-ignore application/json: '${capability_statement_json}' /_status: get: tags: summary: _status endpoint for APIGEE integration operationId: status responses: "200": description: Consumer API is operational content: application/json: schema: type: object properties: message: type: string enum: ["OK"] x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_status} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT components: requestBodies: DocumentReference: content: application/fhir+json: schema: $ref: "#/components/schemas/DocumentReference" required: true schemas: OperationOutcome: type: object properties: resourceType: type: string enum: - OperationOutcome id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. meta: $ref: "#/components/schemas/Meta" description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. implicitRules: type: string pattern: \S* description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The base language in which the resource is written. text: $ref: "#/components/schemas/Narrative" description: A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. issue: type: array items: $ref: "#/components/schemas/OperationOutcomeIssue" description: An error, warning, or information message that results from a system action. minItems: 1 required: - resourceType - issue OperationOutcomeIssue: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. severity: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Indicates whether the issue indicates a variation from successful processing. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element. details: $ref: "#/components/schemas/CodeableConcept" description: Additional details about the error. This may be a text description of the error or a system code that identifies the error. diagnostics: type: string pattern: "[ \\r\\n\\t\\S]+" description: Additional diagnostic information about the issue. location: type: array items: type: string pattern: "[ \\r\\n\\t\\S]+" description: "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name." expression: type: array items: type: string pattern: "[ \\r\\n\\t\\S]+" description: A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. required: - severity - code DocumentReference: type: object properties: resourceType: type: string enum: - DocumentReference id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. meta: $ref: "#/components/schemas/Meta" description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. implicitRules: type: string pattern: \S* description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The base language in which the resource is written. text: $ref: "#/components/schemas/Narrative" description: A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. masterIdentifier: $ref: "#/components/schemas/Identifier" description: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. identifier: type: array items: $ref: "#/components/schemas/Identifier" description: Other identifiers associated with the document, including version independent identifiers. status: type: string pattern: "^current$" description: The status of this document reference. docStatus: type: string enum: ["entered-in-error", "amended", "preliminary", "final"] description: The status of the underlying document. type: $ref: "#/components/schemas/CodeableConcept" description: Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. category: type: array items: $ref: "#/components/schemas/CodeableConcept" description: A categorization for the type of document referenced – helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. subject: $ref: "#/components/schemas/Reference" description: Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). date: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: When the document reference was created. author: type: array items: $ref: "#/components/schemas/Reference" description: Identifies who is responsible for adding the information to the document. authenticator: $ref: "#/components/schemas/Reference" description: Which person or organization authenticates that this document is valid. custodian: $ref: "#/components/schemas/Reference" description: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. relatesTo: type: array items: $ref: "#/components/schemas/DocumentReferenceRelatesTo" description: Relationships that this document has with other document references that already exist. description: type: string pattern: "[ \\r\\n\\t\\S]+" description: Human–readable description of the source document. securityLabel: type: array items: $ref: "#/components/schemas/CodeableConcept" description: A set of Security–Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. content: type: array items: $ref: "#/components/schemas/DocumentReferenceContent" description: The document and format referenced. There may be multiple content element repetitions, each with a different format. minItems: 1 context: $ref: "#/components/schemas/DocumentReferenceContext" description: The clinical context in which the document was prepared. required: - resourceType - status - content Bundle: type: object properties: resourceType: type: string enum: - Bundle id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. meta: $ref: "#/components/schemas/Meta" description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. implicitRules: type: string pattern: \S* description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The base language in which the resource is written. identifier: $ref: "#/components/schemas/Identifier" description: A persistent identifier for the bundle that won't change as a bundle is copied from server to server. type: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Indicates the purpose of this bundle – how it is intended to be used. timestamp: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle. total: type: integer format: int32 description: If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. link: type: array items: $ref: "#/components/schemas/BundleLink" description: A series of links that provide context to this bundle. entry: type: array items: $ref: "#/components/schemas/BundleEntry" description: An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only). signature: $ref: "#/components/schemas/Signature" description: Digital Signature – base64 encoded. XML–DSig or a JWT. required: - resourceType - type BundleEntry: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. link: type: array items: $ref: "#/components/schemas/BundleLink" description: A series of links that provide context to this entry. fullUrl: type: string pattern: \S* description: "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified." resource: oneOf: - $ref: "#/components/schemas/DocumentReference" - $ref: "#/components/schemas/OperationOutcome" description: The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. search: $ref: "#/components/schemas/BundleEntrySearch" description: Information about the search process that lead to the creation of this entry. request: $ref: "#/components/schemas/BundleEntryRequest" description: Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. response: $ref: "#/components/schemas/BundleEntryResponse" description: Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. BundleEntryResponse: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. status: type: string pattern: "[ \\r\\n\\t\\S]+" description: The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. location: type: string pattern: \S* description: The location header created by processing this operation, populated if the operation returns a location. etag: type: string pattern: "[ \\r\\n\\t\\S]+" description: The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). lastModified: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: The date/time that the resource was modified on the server. outcome: $ref: "#/components/schemas/DocumentReference" description: An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. required: - status BundleEntryRequest: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. method: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. url: type: string pattern: \S* description: The URL for this entry, relative to the root (the address to which the request is posted). ifNoneMatch: type: string pattern: "[ \\r\\n\\t\\S]+" description: If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread). ifModifiedSince: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread). ifMatch: type: string pattern: "[ \\r\\n\\t\\S]+" description: Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). ifNoneExist: type: string pattern: "[ \\r\\n\\t\\S]+" description: Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL – what follows the "?" (not including the "?"). required: - method - url BundleEntrySearch: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. mode: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. score: type: number description: When searching, the server's search ranking score for the entry. BundleLink: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. relation: type: string pattern: "[ \\r\\n\\t\\S]+" description: A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1). url: type: string pattern: \S* description: The reference details for the link. required: - relation - url DocumentReferenceContext: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. encounter: type: array items: $ref: "#/components/schemas/Reference" description: Describes the clinical encounter or type of care that the document content is associated with. event: type: array items: $ref: "#/components/schemas/CodeableConcept" description: This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. period: $ref: "#/components/schemas/Period" description: The time period over which the service that is described by the document was provided. facilityType: $ref: "#/components/schemas/CodeableConcept" description: The kind of facility where the patient was seen. practiceSetting: $ref: "#/components/schemas/CodeableConcept" description: This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. sourcePatientInfo: $ref: "#/components/schemas/Reference" description: The Patient Information as known when the document was published. May be a reference to a version specific, or contained. related: type: array items: $ref: "#/components/schemas/Reference" description: Related identifiers or resources associated with the DocumentReference. required: - practiceSetting DocumentReferenceContent: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. attachment: $ref: "#/components/schemas/Attachment" description: The document or URL of the document along with critical metadata to prove content has integrity. format: $ref: "#/components/schemas/NRLFormatCode" description: An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. extension: type: array items: oneOf: - $ref: "#/components/schemas/ContentStabilityExtension" - $ref: "#/components/schemas/NRLRetrievalMechanismExtension" - $ref: "#/components/schemas/Extension" description: Additional extensions which include Content Stability and Retrieval Mechanism. minItems: 1 required: - attachment - format - extension DocumentReferenceRelatesTo: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The type of relationship that this document has with anther document. target: $ref: "#/components/schemas/Reference" description: The target document of this relationship. required: - code - target Attachment: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. contentType: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The human language of the content. The value can be any valid value according to BCP 47. data: type: string pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+ description: The actual data of the attachment – a sequence of bytes, base64 encoded. url: type: string pattern: \S* description: A location where the data can be accessed. size: type: integer format: int32 description: The number of bytes of data that make up this attachment (before base64 encoding, if that is done). hash: type: string pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+ description: The calculated hash of the data using SHA–1. Represented using base64. title: type: string pattern: "[ \\r\\n\\t\\S]+" description: A label or set of text to display in place of the data. creation: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)? description: The date that the attachment was first created. required: - contentType - url CodeableConcept: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. coding: type: array items: $ref: "#/components/schemas/Coding" description: A reference to a code defined by a terminology system. text: type: string pattern: "[ \\r\\n\\t\\S]+" description: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Coding: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. system: type: string pattern: \S* description: The identification of the code system that defines the meaning of the symbol in the code. version: type: string pattern: "[ \\r\\n\\t\\S]+" description: The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination). display: type: string pattern: "[ \\r\\n\\t\\S]+" description: A representation of the meaning of the code in the system, following the rules of the system. userSelected: type: boolean description: Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays). Extension: type: object properties: valueCodeableConcept: $ref: "#/components/schemas/CodeableConcept" description: A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1). url: type: string pattern: \S* description: The reference details for the link. ContentStabilityExtension: allOf: - $ref: "#/components/schemas/Extension" - type: object properties: url: type: string enum: - "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" valueCodeableConcept: $ref: "#/components/schemas/ContentStabilityExtensionValueCodeableConcept" required: - url - valueCodeableConcept ContentStabilityExtensionValueCodeableConcept: allOf: - $ref: "#/components/schemas/CodeableConcept" - type: object properties: coding: type: array items: $ref: "#/components/schemas/ContentStabilityExtensionCoding" minItems: 1 maxItems: 1 required: - coding ContentStabilityExtensionCoding: allOf: - $ref: "#/components/schemas/Coding" - type: object properties: system: type: string enum: - "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability" code: type: string enum: ["static", "dynamic"] display: type: string enum: ["Static", "Dynamic"] required: - system - code - display NRLRetrievalMechanismExtension: allOf: - $ref: "#/components/schemas/Extension" - type: object properties: url: type: string enum: - "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" valueCodeableConcept: $ref: "#/components/schemas/NRLRetrievalMechanismExtensionValueCodeableConcept" required: - url - valueCodeableConcept NRLRetrievalMechanismExtensionValueCodeableConcept: allOf: - $ref: "#/components/schemas/CodeableConcept" - type: object properties: coding: type: array items: $ref: "#/components/schemas/NRLRetrievalMechanismExtensionCoding" minItems: 1 maxItems: 1 required: - coding NRLRetrievalMechanismExtensionCoding: allOf: - $ref: "#/components/schemas/Coding" - type: object properties: system: type: string enum: - "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism" code: type: string enum: ["SSP", "Direct", "LDR", "InContext"] display: type: string enum: [ "Spine Secure Proxy", "Direct", "Large Document Retrieval", "Direct using In-Context", ] required: - system - code - display NRLFormatCode: allOf: - $ref: "#/components/schemas/Coding" - type: object properties: system: type: string enum: - "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode" description: The system URL for the NRLF Format Code. code: type: string enum: - "urn:nhs-ic:record-contact" - "urn:nhs-ic:unstructured" - "urn:nhs-ic:structured" description: The code representing the format of the document. display: type: string enum: - "Contact details (HTTP Unsecured)" - "Unstructured Document" - "Structured Document" description: The display text for the code. required: - system - code - display Identifier: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. use: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The purpose of this identifier. type: $ref: "#/components/schemas/CodeableConcept" description: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. system: type: string pattern: \S* description: Establishes the namespace for the value – that is, a URL that describes a set values that are unique. value: type: string pattern: "[ \\r\\n\\t\\S]+" description: The portion of the identifier typically relevant to the user and which is unique within the context of the system. period: $ref: "#/components/schemas/Period" description: Time period during which identifier is/was valid for use. assigner: $ref: "#/components/schemas/Reference" description: Organization that issued/manages the identifier. Period: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. start: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)? description: The start of the period. The boundary is inclusive. end: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)? description: The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Quantity: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. value: type: number description: The value of the measured amount. The value includes an implicit precision in the presentation of the value. comparator: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. unit: type: string pattern: "[ \\r\\n\\t\\S]+" description: A human–readable form of the unit. system: type: string pattern: \S* description: The identification of the system that provides the coded form of the unit. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A computer processable form of the unit in some unit representation system. Reference: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. reference: type: string pattern: "[ \\r\\n\\t\\S]+" description: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. type: type: string pattern: \S* description: |- The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). identifier: $ref: "#/components/schemas/Identifier" description: An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. display: type: string pattern: "[ \\r\\n\\t\\S]+" description: Plain text narrative that identifies the resource in addition to the resource reference. Signature: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. type: type: array items: $ref: "#/components/schemas/Coding" description: An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. minItems: 1 when: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: When the digital signature was signed. who: $ref: "#/components/schemas/Reference" description: A reference to an application–usable description of the identity that signed (e.g. the signature used their private key). onBehalfOf: $ref: "#/components/schemas/Reference" description: A reference to an application–usable description of the identity that is represented by the signature. targetFormat: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A mime type that indicates the technical format of the target resources signed by the signature. sigFormat: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. data: type: string pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+ description: The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. required: - type - when - who Meta: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. versionId: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. lastUpdated: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: When the resource last changed – e.g. when the version changed. source: type: string pattern: \S* description: A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. profile: type: array items: type: string pattern: \S* description: A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url). security: type: array items: $ref: "#/components/schemas/Coding" description: Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. tag: type: array items: $ref: "#/components/schemas/Coding" description: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Narrative: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. status: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. div: type: string description: The actual narrative content, a stripped down version of XHTML. required: - status - div DocumentId: type: string pattern: '[A-Za-z0-9\-\.]{1,64}' # https://build.fhir.org/datatypes.html#id RequestPathParams: type: object properties: id: $ref: "#/components/schemas/DocumentId" required: - id RequestHeader: type: object properties: odsCode: $ref: "#/components/schemas/RequestHeaderOdsCode" required: - odsCode RequestParams: type: object properties: subject:identifier: $ref: "#/components/schemas/RequestQuerySubject" custodian:identifier: $ref: "#/components/schemas/RequestQueryCustodian" type: $ref: "#/components/schemas/RequestQueryType" category: $ref: "#/components/schemas/RequestQueryCategory" _summary: $ref: "#/components/schemas/RequestQuerySummary" next-page-token: $ref: "#/components/schemas/NextPageToken" required: - subject:identifier CountRequestParams: type: object properties: subject:identifier: $ref: "#/components/schemas/RequestQuerySubject" required: - subject:identifier RequestQuerySubject: type: string pattern: ^https\:\/\/fhir\.nhs\.uk\/Id\/nhs-number\|(\d+)$ example: "https://fhir.nhs.uk/Id/nhs-number|4409815415" RequestQueryCustodian: type: string pattern: ^https\:\/\/fhir\.nhs\.uk\/Id\/ods-organization-code\|(\w+)$ example: "https://fhir.nhs.uk/Id/ods-organization-code|Y05868" RequestQueryType: type: string example: "http://snomed.info/sct|736253002" RequestQueryCategory: type: string example: "http://snomed.info/sct|103693007" RequestQuerySummary: type: string example: "count" NextPageToken: type: string RequestHeaderOdsCode: type: string RequestHeaderOrganisationExtensionCode: type: string RequestHeaderRequestId: type: string pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" example: 60E0B220-8136-4CA5-AE46-1D97EF59D068 RequestHeaderCorrelationId: type: string example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA parameters: id: name: id in: path required: true description: logical identifier schema: $ref: "#/components/schemas/DocumentId" examples: valid: summary: Valid value: Y05868-1234567892 invalid: summary: Unknown value: Y05861-1234567800 subject: name: subject:identifier in: query schema: $ref: "#/components/schemas/RequestQuerySubject" required: true examples: none: summary: None value: "" valid_1: summary: "Valid #1" value: https://fhir.nhs.uk/Id/nhs-number|4409815415 valid_2: summary: "Valid #2" value: https://fhir.nhs.uk/Id/nhs-number|3495456481 invalid: summary: Unknown value: https://fhir.nhs.uk/Id/nhs-number|3495456001 custodian: name: custodian:identifier in: query schema: $ref: "#/components/schemas/RequestQueryCustodian" examples: none: summary: None value: "" valid: summary: Valid value: https://fhir.nhs.uk/Id/ods-organization-code|Y05868 invalid: summary: Unknown value: https://fhir.nhs.uk/Id/another-code|XYZ type: name: type in: query schema: $ref: "#/components/schemas/RequestQueryType" examples: none: summary: None value: "" SNOMED_CODES_MENTAL_HEALTH_CRISIS_PLAN: summary: Mental health crisis plan value: http://snomed.info/sct|736253002 SNOMED_CODES_EMERGENCY_HEALTH_CARE_PLAN: summary: Emergency health care plan value: http://snomed.info/sct|887701000000100 SNOMED_CODES_END_OF_LIFE_CARE_COORDINATION_SUMMARY: summary: End of Life Care Coordination Summary value: http://snomed.info/sct|861421000000109 SNOMED_CODES_RESPECT_FORM: summary: ReSPECT form value: http://snomed.info/sct|1382601000000107 SNOMED_CODES_NEWS2_CHART: summary: Royal College of Physicians NEWS2 chart value: http://snomed.info/sct|1363501000000100 SNOMED_CODES_CONTINGENCY_PLAN: summary: Contingency plan value: http://snomed.info/sct|325691000000100 SNOMED_CODES_END_OF_LIFE_CARE_PLAN: summary: End of life care plan value: http://snomed.info/sct|736373009 SNOMED_CODES_LLOYD_GEORGE_RECORD_FOLDER: summary: Lloyd George record folder value: http://snomed.info/sct|16521000000101 SNOMED_CODES_ADVANCE_CARE_PLAN: summary: Advance care plan value: http://snomed.info/sct|736366004 SNOMED_CODES_TREATMENT_ESCALATION_PLAN: summary: Treatment escalation plan value: http://snomed.info/sct|735324008 SNOMED_CODES_SUMMARY_RECORD: summary: Summary record value: http://snomed.info/sct|824321000000109 SNOME_CODES_PERSONALISED_CARE_AND_SUPPORT_PLAN: summary: Personalised Care and Support Plan value: http://snomed.info/sct|2181441000000107 invalid: summary: Unknown value: http://snomed.info/sct|410970009 category: name: category in: query schema: $ref: "#/components/schemas/RequestQueryCategory" examples: none: summary: None value: "" SNOMED_CODES_CARE_PLAN: summary: Care plan value: http://snomed.info/sct|734163000 SNOMED_CODES_OBSERVATIONS: summary: Observations value: http://snomed.info/sct|1102421000000108 SNOMED_CODES_CLINICAL_NOTE: summary: Clinical note value: http://snomed.info/sct|823651000000106 SNOMED_CODES_DIAGNOSTIC_STUDIES_REPORT: summary: Diagnostic studies report value: http://snomed.info/sct|721981007 SNOMED_CODES_DIAGNOSTIC_PROCEDURE: summary: Diagnostic procedure value: http://snomed.info/sct|103693007 invalid: summary: Unknown value: http://snomed.info/sct|410970009 _summary: name: summary in: query schema: $ref: "#/components/schemas/RequestQuerySummary" examples: none: summary: None value: "" SNOMED_CODES_CARE_PLAN: summary: Search only, just returns a count of the matching resources, without returning the actual matches value: count nextPageToken: name: next-page-token description: | A token that can be sent as either a query parameter or in the post body parameter to retrieve the next set of 20 records. This token is returned in the meta.tag field. in: query schema: $ref: "#/components/schemas/NextPageToken" odsCode: name: NHSD-End-User-Organisation-ODS description: ODS Code for Organisation in: header schema: $ref: "#/components/schemas/RequestHeaderOdsCode" required: true examples: valid: summary: Valid value: Y05868 invalid: summary: Unknown value: XYZ requestId: name: X-Request-ID description: | A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header. in: header required: true schema: $ref: "#/components/schemas/RequestHeaderRequestId" correlationId: name: X-Correlation-ID description: | An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk. If you re-send a failed request please re-send this ID in the header. It can take any value, but we recommend avoiding `.` characters. Mirrored back in a response header. in: header required: false schema: $ref: "#/components/schemas/RequestHeaderCorrelationId" responses: Success: description: Success Response content: application/fhir+json: schema: $ref: "#/components/schemas/OperationOutcome" Error: description: Error Response content: application/fhir+json: schema: $ref: "#/components/schemas/OperationOutcome" headers: CorrelationId: schema: type: string example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA description: | The X-Correlation-ID from the request header, if supplied, mirrored back. RequestId: schema: type: string pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" example: 60E0B220-8136-4CA5-AE46-1D97EF59D068 description: | The X-Request-ID from the request header mirrored back. NRLF-3.0.31/api/producer/000077500000000000000000000000001511201605300147255ustar00rootroot00000000000000NRLF-3.0.31/api/producer/createDocumentReference/000077500000000000000000000000001511201605300215065ustar00rootroot00000000000000NRLF-3.0.31/api/producer/createDocumentReference/create_document_reference.py000066400000000000000000000230021511201605300272340ustar00rootroot00000000000000from uuid import uuid4 from nrlf.core.codes import SpineErrorConcept from nrlf.core.constants import ( PERMISSION_AUDIT_DATES_FROM_PAYLOAD, PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL, TYPES_WITH_MULTIPLES, ) from nrlf.core.decorators import request_handler from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata from nrlf.core.response import NRLResponse, Response, SpineErrorResponse from nrlf.core.utils import create_fhir_instant from nrlf.core.validators import DocumentReferenceValidator from nrlf.producer.fhir.r4.model import DocumentReference, Meta def _set_create_time_fields( create_time: str, document_reference: DocumentReference, nrl_permissions: list[str] ) -> DocumentReference: """ Set the date and lastUpdated timestamps on the provided DocumentReference """ if not document_reference.meta: document_reference.meta = Meta() document_reference.meta.lastUpdated = create_time if ( document_reference.date and PERMISSION_AUDIT_DATES_FROM_PAYLOAD in nrl_permissions ): # Perserving the original date if it exists and the permission is set logger.log( LogReference.PROCREATE011, id=document_reference.id, date=document_reference.date, ) else: document_reference.date = create_time return document_reference def _create_core_model(resource: DocumentReference, metadata: ConnectionMetadata): """ Create the DocumentPointer model from the provided DocumentReference """ creation_time = create_fhir_instant() document_reference = _set_create_time_fields( creation_time, document_reference=resource, nrl_permissions=metadata.nrl_permissions, ) return DocumentPointer.from_document_reference( document_reference, created_on=creation_time ) def _check_permissions( core_model: DocumentPointer, metadata: ConnectionMetadata ) -> Response | None: """ Check the requester has permissions to create the DocumentReference """ if metadata.ods_code != core_model.custodian: logger.log( LogReference.PROCREATE004, ods_code=metadata.ods_code, custodian=core_model.custodian, ) return SpineErrorResponse.UNPROCESSABLE_ENTITY( diagnostics="The custodian of the provided DocumentReference does not match the expected ODS code for this organisation", expression="custodian.identifier.value", ) if core_model.type not in metadata.pointer_types: logger.log( LogReference.PROCREATE005, ods_code=metadata.ods_code, type=core_model.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR( diagnostics="The type of the provided DocumentReference is not in the list of allowed types for this organisation", expression="type.coding[0].code", ) def _get_document_ids_to_supersede( resource: DocumentReference, core_model: DocumentPointer, metadata: ConnectionMetadata, repository: DocumentPointerRepository, can_ignore_delete_fail: bool, ): """ Get the list of document IDs to supersede based on the relatesTo field """ if not resource.relatesTo: return [] logger.log(LogReference.PROCREATE006, relatesTo=resource.relatesTo) ids_to_delete = [] for idx, relates_to in enumerate(resource.relatesTo): identifier = _validate_identifier(relates_to, idx) _validate_producer_id(identifier, metadata, idx) if not can_ignore_delete_fail: existing_pointer = _check_existing_pointer(identifier, repository, idx) _validate_pointer_details(existing_pointer, core_model, identifier, idx) _append_id_if_replaces(relates_to, ids_to_delete, identifier) return ids_to_delete def _validate_identifier(relates_to, idx): """ Validate that there is a identifier in relatesTo target """ identifier = getattr(relates_to.target.identifier, "value", None) if not identifier: logger.log(LogReference.PROCREATE007a) _raise_operation_outcome_error( "No identifier value provided for relatesTo target", idx ) return identifier def _validate_producer_id(identifier, metadata, idx): """ Validate that there is an ODS code in the relatesTo target identifier """ producer_id = identifier.split("-", 1)[0] if metadata.ods_code != producer_id: logger.log( LogReference.PROCREATE007b, related_identifier=identifier, ods_code=metadata.ods_code, ) _raise_operation_outcome_error( "The relatesTo target identifier value does not include the expected ODS code for this organisation", idx, ) def _check_existing_pointer(identifier, repository, idx): """ Check that there is an existing pointer that will be deleted when superseding """ existing_pointer = repository.get_by_id(identifier) if not existing_pointer: logger.log(LogReference.PROCREATE007c, related_identifier=identifier) _raise_operation_outcome_error( "The relatesTo target document does not exist", idx ) return existing_pointer def _validate_pointer_details(existing_pointer, core_model, identifier, idx): """ Validate that the nhs numbers and type matches between the existing pointer and the requested one. """ if existing_pointer.nhs_number != core_model.nhs_number: logger.log(LogReference.PROCREATE007d, related_identifier=identifier) _raise_operation_outcome_error( "The relatesTo target document NHS number does not match the NHS number in the request", idx, ) if existing_pointer.type != core_model.type: logger.log(LogReference.PROCREATE007e, related_identifier=identifier) _raise_operation_outcome_error( "The relatesTo target document type does not match the type in the request", idx, ) def _append_id_if_replaces(relates_to, ids_to_delete, identifier): """ Append pointer ID if the if the relatesTo code is 'replaces' """ if relates_to.code == "replaces": logger.log( LogReference.PROCREATE008, relates_to_code=relates_to.code, identifier=identifier, ) ids_to_delete.append(identifier) def _raise_operation_outcome_error(diagnostics, idx): """ General function to raise an operation outcome error """ raise OperationOutcomeError( severity="error", code="business-rule", details=SpineErrorConcept.from_code("UNPROCESSABLE_ENTITY"), diagnostics=diagnostics, expression=[f"relatesTo[{idx}].target.identifier.value"], status_code="422", ) @request_handler(body=DocumentReference) def handler( metadata: ConnectionMetadata, repository: DocumentPointerRepository, body: DocumentReference, ) -> Response: """ Creates a document reference. Args: metadata (ConnectionMetadata): The connection metadata. repository (DocumentPointerRepository): The document pointer repository. body (DocumentReference): The document reference to create. Returns: Response: The response indicating the result of the operation. """ logger.log(LogReference.PROCREATE000) logger.log(LogReference.PROCREATE001, resource=body) body.id = f"{metadata.ods_code}-{uuid4()}" validator = DocumentReferenceValidator() result = validator.validate(body) if not result.is_valid: logger.log(LogReference.PROCREATE002) return Response.from_issues(issues=result.issues, statusCode="422") core_model = _create_core_model(result.resource, metadata) if error_response := _check_permissions(core_model, metadata): return error_response can_ignore_delete_fail = ( PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL in metadata.nrl_permissions ) if ids_to_delete := _get_document_ids_to_supersede( result.resource, core_model, metadata, repository, can_ignore_delete_fail ): logger.log( LogReference.PROCREATE010, pointer_id=result.resource.id, ids_to_delete=ids_to_delete, ) repository.supersede(core_model, ids_to_delete, can_ignore_delete_fail) logger.log(LogReference.PROCREATE999) return NRLResponse.RESOURCE_SUPERSEDED(resource_id=result.resource.id) pointer_type = core_model.type if pointer_type not in TYPES_WITH_MULTIPLES: nhs_number = core_model.nhs_number existing_pointers_count = repository.count_by_nhs_number( nhs_number, [pointer_type] ) if existing_pointers_count > 0: logger.log( LogReference.PROCREATE012, new_pointer_id=core_model.id, new_pointer_master_id=core_model.master_identifier, pointer_type=pointer_type, nhs_number=nhs_number, custodian=core_model.custodian, existing_pointers_count=existing_pointers_count, ) logger.log(LogReference.PROCREATE009, pointer_id=result.resource.id) repository.create(core_model) logger.log(LogReference.PROCREATE999) return NRLResponse.RESOURCE_CREATED(resource_id=result.resource.id) NRLF-3.0.31/api/producer/createDocumentReference/tests/000077500000000000000000000000001511201605300226505ustar00rootroot00000000000000NRLF-3.0.31/api/producer/createDocumentReference/tests/test_create_document_reference.py000066400000000000000000001650251511201605300314510ustar00rootroot00000000000000import json from unittest.mock import Mock, patch from freeze_uuid import freeze_uuid from freezegun import freeze_time from moto import mock_aws from pytest import mark from api.producer.createDocumentReference.create_document_reference import ( _set_create_time_fields, handler, ) from nrlf.core.constants import SNOMED_SYSTEM_URL from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.producer.fhir.r4.model import ( DocumentReferenceRelatesTo, Identifier, Reference, ) from nrlf.tests.data import load_document_reference, load_document_reference_data from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref_data = load_document_reference_data("Y05868-736253002-Valid") event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id( "Y05868-00000000-0000-0000-0000-000000000001" ) assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", "id": "Y05868-00000000-0000-0000-0000-000000000001", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_happy_path_with_ssp( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data( "Y05868-736253002-Valid-with-ssp-content" ) event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id( "Y05868-00000000-0000-0000-0000-000000000001" ) assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", "id": "Y05868-00000000-0000-0000-0000-000000000001", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_without_related_value_exception( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context = { "practiceSetting": { "coding": [ { "system": SNOMED_SYSTEM_URL, "code": "788002001", "display": "Adult mental health service", } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191", } }, "related": [{"identifier": {"system": "https://fhir.nhs.uk/Id/nhsSpineASID"}}], } event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid ASID value ''. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[0].identifier.value"], } ], } def test_create_document_reference_no_body(): event = create_test_api_gateway_event( headers=create_headers(), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "BAD_REQUEST", "display": "Bad request", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body is required", } ], } def test_create_document_reference_invalid_body(): event = create_test_api_gateway_event( headers=create_headers(), body="{}", ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (resourceType: Field required)", "expression": ["resourceType"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (status: Field required)", "expression": ["status"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (type: Field required)", "expression": ["type"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (category: Field required)", "expression": ["category"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (author: Field required)", "expression": ["author"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (content: Field required)", "expression": ["content"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (context: Field required)", "expression": ["context"], }, ], } def test_create_document_reference_empty_fields_in_body(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.author = [] doc_ref.custodian = {"identifier": {}, "reference": None} doc_ref.category = [{"coding": [{"system": "", "code": None}]}] doc_ref.text = "" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: text, author, custodian.reference, custodian.identifier, category[0].coding[0].system, category[0].coding[0].code)", "expression": ["DocumentReference"], } ], } def test_create_document_reference_invalid_resource(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.custodian = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "The required field 'custodian' is missing", "expression": ["custodian"], }, ], } def test_create_document_reference_with_no_custodian(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.custodian = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "The required field 'custodian' is missing", "expression": ["custodian"], }, ], } def test_create_document_reference_with_no_practiceSetting(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.context.practiceSetting = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (context.practiceSetting: Field required)", "expression": ["context.practiceSetting"], }, ], } def test_create_document_reference_with_invalid_docStatus(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.docStatus = "invalid" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (docStatus: Input should be 'entered-in-error', 'amended', 'preliminary' or 'final')", "expression": ["docStatus"], }, ], } def test_create_document_reference_invalid_custodian_id(): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.custodian and doc_ref.custodian.identifier doc_ref.custodian.identifier.value = "X26" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The custodian of the provided DocumentReference does not match the expected ODS code for this organisation", "expression": ["custodian.identifier.value"], } ], } def test_create_document_reference_invalid_pointer_type(): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.type and doc_ref.type.coding doc_ref.type.coding[0].code = "invalid" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid type code: invalid Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)", "expression": ["type.coding[0].code"], } ], } @mock_aws @mock_repository @patch("nrlf.core.decorators.parse_permissions_file") def test_create_document_reference_pointer_type_not_allowed( parse_permissions_mock, repository: DocumentPointerRepository ): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.type and doc_ref.type.coding event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) parse_permissions_mock.return_value = ["invalid"] result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "403", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The type of the provided DocumentReference is not in the list of allowed types for this organisation", "expression": ["type.coding[0].code"], } ], } def test_create_document_reference_invalid_category_type(): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.category and doc_ref.category[0].coding doc_ref.category[0].coding[0].code = "1102421000000108" doc_ref.category[0].coding[0].display = "Observations" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The Category code of the provided document 'http://snomed.info/sct|1102421000000108' must match the allowed category for pointer type 'http://snomed.info/sct|736253002' with a category value of 'http://snomed.info/sct|734163000'", "expression": ["category.coding[0].code"], } ], } @mock_aws @mock_repository def test_create_document_reference_cannot_set_status_to_not_current(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_ref.status = "somethingElse" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (status: String should match pattern '^current$')", "expression": ["status"], } ], } def test_create_document_reference_no_relatesto_target(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo(code="transforms", target=Reference()) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: relatesTo[0].target)", "expression": ["DocumentReference"], } ], } def test_create_document_reference_invalid_relatesto_target_producer_id(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="X26-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target identifier value does not include the expected ODS code for this organisation", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_create_document_reference_invalid_relatesto_not_exists(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference( identifier=Identifier(value="Y05868-123456-123456-123456"), ), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document does not exist", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_create_document_reference_invalid_relatesto_nhs_number( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-123456" assert doc_ref.subject and doc_ref.subject.identifier doc_ref.subject.identifier.value = "9999999999" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document NHS number does not match the NHS number in the request", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_create_document_reference_invalid_relatesto_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-123456" assert doc_ref.type and doc_ref.type.coding doc_ref.type.coding[0].code = "861421000000109" doc_ref.type.coding[0].display = "End of life care coordination summary" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers( app_id="123456", ), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document type does not match the type in the request", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_create_document_reference_with_no_context_related_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") del doc_ref.context.related event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Missing context.related. It must be provided and contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } ], } @mock_aws @mock_repository def test_create_document_reference_with_no_asid_in_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context.related = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/not-an-asid", "value": "some-other-value", } } ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Missing ASID identifier. context.related must contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } ], } @mock_aws @mock_repository def test_create_document_reference_with_invalid_asid_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context.related = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "not-a-valid-asid", } } ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid ASID value 'not-a-valid-asid'. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[0].identifier.value"], } ], } @mock_aws @mock_repository @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_supersede_deletes_old_pointers_replace( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-123456" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_SUPERSEDED", "display": "Resource created and resource(s) deleted", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been superseded by a new version", } ], } old_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert old_doc_pointer is None @mock_aws @mock_repository @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_supersede_succeeds_with_toggle( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") # Add reference to a non-existing pointer doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference(identifier=Identifier(value="Y05868-99999-99999-000000")), ) ] event = create_test_api_gateway_event( headers=create_headers(nrl_permissions=["supersede-ignore-delete-fail"]), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_SUPERSEDED", "display": "Resource created and resource(s) deleted", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been superseded by a new version", } ], } non_existent_pointer = repository.get_by_id("Y05868-99999-99999-000000") assert non_existent_pointer is None @mock_aws @mock_repository def test_create_document_reference_supersede_fails_without_toggle( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") # Add reference to a non-existing pointer doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference(identifier=Identifier(value="Y05868-99999-99999-000000")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document does not exist", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_create_relatesto_not_replaces( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-123456" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } old_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert old_doc_pointer is not None @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_with_date_ignored( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data("Y05868-736253002-Valid-with-date") event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id( "Y05868-00000000-0000-0000-0000-000000000001" ) assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", "id": "Y05868-00000000-0000-0000-0000-000000000001", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_with_date_and_meta_lastupdated_ignored( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data( "Y05868-736253002-Valid-with-date-and-meta-lastupdated" ) event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id( "Y05868-00000000-0000-0000-0000-000000000001" ) assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", "id": "Y05868-00000000-0000-0000-0000-000000000001", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") @freeze_uuid("00000000-0000-0000-0000-000000000001") def test_create_document_reference_with_date_overidden( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data("Y05868-736253002-Valid-with-date") event = create_test_api_gateway_event( headers=create_headers(nrl_permissions=["audit-dates-from-payload"]), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id( "Y05868-00000000-0000-0000-0000-000000000001" ) assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-20T00:00:01.000Z", "id": "Y05868-00000000-0000-0000-0000-000000000001", } @freeze_time("2024-03-25") @mark.parametrize( "doc_ref_name", [ "Y05868-736253002-Valid", "Y05868-736253002-Valid-with-date", "Y05868-736253002-Valid-with-date-and-meta-lastupdated", ], ) def test__set_create_time_fields(doc_ref_name: str): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference(doc_ref_name) test_perms = [] response = _set_create_time_fields(test_time, test_doc_ref, test_perms) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": "2024-03-24T12:34:56.789Z", }, "date": "2024-03-24T12:34:56.789Z", } @freeze_time("2024-03-25") @mark.parametrize( "doc_ref_name", [ "Y05868-736253002-Valid-with-date", "Y05868-736253002-Valid-with-date-and-meta-lastupdated", ], ) def test__set_create_time_fields_when_doc_has_date_and_perms(doc_ref_name: str): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference(doc_ref_name) test_perms = ["audit-dates-from-payload"] response = _set_create_time_fields(test_time, test_doc_ref, test_perms) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": test_time, }, "date": test_doc_ref.date, } @freeze_time("2024-03-25") def test__set_create_time_fields_when_no_date_but_perms(): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference("Y05868-736253002-Valid") test_perms = ["audit-dates-from-payload"] response = _set_create_time_fields(test_time, test_doc_ref, test_perms) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": test_time, }, "date": test_time, } @mock_aws @mock_repository @freeze_uuid("00000000-0000-0000-0000-000000000001") @patch("api.producer.createDocumentReference.create_document_reference.logger") def test_create_logs_for_unexpected_multi_pointer( mock_logger: Mock, repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-master-id") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } assert any( call[0][0].name == "PROCREATE012" for call in mock_logger.log.call_args_list ) assert { "existing_pointers_count": 1, "nhs_number": ( doc_ref.subject.identifier.value if doc_ref.subject and doc_ref.subject.identifier else None ), "pointer_type": ( f"{doc_ref.type.coding[0].system}|{doc_ref.type.coding[0].code}" if doc_ref.type and doc_ref.type.coding else None ), "custodian": ( doc_ref.custodian.identifier.value if doc_ref.custodian and doc_ref.custodian.identifier else None ), "new_pointer_id": "Y05868-00000000-0000-0000-0000-000000000001", "new_pointer_master_id": ( doc_ref.masterIdentifier.value if doc_ref.masterIdentifier else None ), } == [ call[1:][0] for call in mock_logger.log.call_args_list if call[0][0].name == "PROCREATE012" ][ 0 ] @mock_aws @mock_repository @freeze_uuid("00000000-0000-0000-0000-000000000001") @patch("api.producer.createDocumentReference.create_document_reference.logger") def test_create_logs_for_expected_multi_pointer( mock_logger: Mock, repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-Appointment-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-00000000-0000-0000-0000-000000000001", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } assert not any( call[0][0].name == "PROCREATE012" for call in mock_logger.log.call_args_list ) NRLF-3.0.31/api/producer/deleteDocumentReference/000077500000000000000000000000001511201605300215055ustar00rootroot00000000000000NRLF-3.0.31/api/producer/deleteDocumentReference/delete_document_reference.py000066400000000000000000000032411511201605300272350ustar00rootroot00000000000000import urllib.parse from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, DeleteDocumentReferencePathParams from nrlf.core.response import NRLResponse, Response, SpineErrorResponse @request_handler(path=DeleteDocumentReferencePathParams) def handler( metadata: ConnectionMetadata, repository: DocumentPointerRepository, path: DeleteDocumentReferencePathParams, ) -> Response: """ Deletes a document reference. Args: metadata (ConnectionMetadata): The connection metadata. repository (DocumentPointerRepository): The document pointer repository. path (DeleteDocumentReferencePathParams): The path parameters. Returns: Response: The response indicating the result of the deletion. """ logger.log(LogReference.PRODELETE000) pointer_id = urllib.parse.unquote(path.id) producer_id, _ = pointer_id.split("-", 1) if metadata.ods_code != producer_id: logger.log( LogReference.PRODELETE001, ods_code=metadata.ods_code, producer_id=producer_id, ) return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR( diagnostics="The requested DocumentReference cannot be deleted because it belongs to another organisation", ) if not (core_model := repository.get_by_id(pointer_id)): logger.log(LogReference.PRODELETE002, pointer_id=pointer_id) return NRLResponse.RESOURCE_DOES_NOT_EXIST_DELETE() repository.delete(core_model) logger.log(LogReference.PRODELETE999) return NRLResponse.RESOURCE_DELETED() NRLF-3.0.31/api/producer/deleteDocumentReference/tests/000077500000000000000000000000001511201605300226475ustar00rootroot00000000000000NRLF-3.0.31/api/producer/deleteDocumentReference/tests/test_delete_document_reference.py000066400000000000000000000122531511201605300314410ustar00rootroot00000000000000import json from moto import mock_aws from api.producer.deleteDocumentReference.delete_document_reference import handler from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_delete_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_DELETED", "display": "Resource deleted", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The requested DocumentReference has been deleted", } ], } assert repository.get_by_id("Y05868-99999-99999-999999") is None def test_delete_document_reference_invalid_id_in_path(): event = create_test_api_gateway_event(headers=create_headers(), path_parameters={}) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_PARAMETER", "display": "Invalid parameter", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid path parameter (id: Field required)", "expression": ["id"], } ], } def test_delete_document_reference_invalid_producer_id(): event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "X26-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "403", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The requested DocumentReference cannot be deleted because it belongs to another organisation", } ], } @mock_aws @mock_repository def test_delete_document_reference_not_exists(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_DELETED", "display": "Resource deleted", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The requested DocumentReference could not be found", } ], } NRLF-3.0.31/api/producer/readDocumentReference/000077500000000000000000000000001511201605300211565ustar00rootroot00000000000000NRLF-3.0.31/api/producer/readDocumentReference/read_document_reference.py000066400000000000000000000051371511201605300263650ustar00rootroot00000000000000import sys import urllib.parse from pydantic import ValidationError from nrlf.core.codes import SpineErrorConcept from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, ReadDocumentReferencePathParams from nrlf.core.response import Response, SpineErrorResponse from nrlf.producer.fhir.r4.model import DocumentReference @request_handler(path=ReadDocumentReferencePathParams) def handler( metadata: ConnectionMetadata, repository: DocumentPointerRepository, path: ReadDocumentReferencePathParams, ) -> Response: """ Reads a document reference based on the provided metadata, repository, and path. Args: metadata (ConnectionMetadata): The connection metadata. repository (DocumentPointerRepository): The document pointer repository. path (ReadDocumentReferencePathParams): The path parameters. Returns: Response: The response containing the document reference. Raises: OperationOutcomeError: If an error occurs while parsing the document reference. """ logger.log(LogReference.PROREAD000) parsed_id = urllib.parse.unquote(path.id) producer_id = parsed_id.split("-", maxsplit=1)[0] if metadata.ods_code != producer_id: logger.log( LogReference.PROREAD001, ods_code=metadata.ods_code, producer_id=producer_id, ) return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR( diagnostics="The requested DocumentReference cannot be read because it belongs to another organisation", ) result = repository.get_by_id(parsed_id) if result is None: logger.log(LogReference.PROREAD002) return SpineErrorResponse.NO_RECORD_FOUND( diagnostics="The requested DocumentReference could not be found", ) try: document_reference = DocumentReference.model_validate_json(result.document) except ValidationError as exc: logger.log( LogReference.PROREAD003, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred while parsing the document reference", ) from exc logger.log(LogReference.PROREAD999) return Response.from_resource(document_reference) NRLF-3.0.31/api/producer/readDocumentReference/tests/000077500000000000000000000000001511201605300223205ustar00rootroot00000000000000NRLF-3.0.31/api/producer/readDocumentReference/tests/test_read_document_reference_producer.py000066400000000000000000000136561511201605300324760ustar00rootroot00000000000000import json from moto import mock_aws from api.producer.readDocumentReference.read_document_reference import handler from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_read_document_reference_happy_path(repository: DocumentPointerRepository): # Create the document pointer doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == doc_ref.model_dump(exclude_none=True) @mock_aws @mock_repository def test_read_document_reference_not_found(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "404", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "coding": [ { "code": "NO_RECORD_FOUND", "display": "No record found", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The requested DocumentReference could not be found", } ], } def test_read_document_reference_missing_id(): event = create_test_api_gateway_event(headers=create_headers(), path_parameters={}) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_PARAMETER", "display": "Invalid parameter", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid path parameter (id: Field required)", "expression": ["id"], } ], } def test_read_document_reference_incorrect_ods_code(): event = create_test_api_gateway_event( headers=create_headers(ods_code="RQI"), path_parameters={"id": "Y05868-99999-99999-999999"}, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "403", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The requested DocumentReference cannot be read because it belongs to another organisation", } ], } @mock_aws @mock_repository def test_read_document_reference_invalid_json(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) doc_pointer.document = "invalid json" repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"} ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "500", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred while parsing the document reference", } ], } NRLF-3.0.31/api/producer/searchDocumentReference/000077500000000000000000000000001511201605300215105ustar00rootroot00000000000000NRLF-3.0.31/api/producer/searchDocumentReference/search_document_reference.py000066400000000000000000000113121511201605300272410ustar00rootroot00000000000000from pydantic import ValidationError from nrlf.core.codes import SpineErrorConcept from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, ProducerRequestParams from nrlf.core.response import Response, SpineErrorResponse from nrlf.core.validators import validate_category, validate_type from nrlf.producer.fhir.r4.model import ( Bundle, DocumentReference, OperationOutcome, OperationOutcomeIssue, ) @request_handler(params=ProducerRequestParams) def handler( metadata: ConnectionMetadata, params: ProducerRequestParams, repository: DocumentPointerRepository, ) -> Response: """ Search for document references based on the provided parameters. Args: metadata (ConnectionMetadata): The connection metadata. params (ProducerRequestParams): The request parameters. repository (DocumentPointerRepository): The document pointer repository. Returns: Response: The response containing the search results. """ logger.log(LogReference.PROSEARCH000) if params.subject_identifier and not params.nhs_number: logger.log( LogReference.PROSEARCH001, subject_identifier=params.subject_identifier ) return SpineErrorResponse.INVALID_NHS_NUMBER( diagnostics="Invalid NHS number provided in the search parameters", expression="subject:identifier", ) if not params.nhs_number: logger.log( LogReference.PROSEARCH001, subject_identifier=params.subject_identifier ) return SpineErrorResponse.INVALID_NHS_NUMBER( diagnostics="NHS number is missing from the search parameters", expression="subject:identifier", ) if not validate_type(params.type, metadata.pointer_types): logger.log( LogReference.PROSEARCH002, type=params.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="Invalid query parameter (The provided type does not match the allowed types for this organisation)", expression="type", ) categories = params.category.root.split(",") if params.category else [] if not validate_category(categories): logger.log( LogReference.PROSEARCH002b, category=params.category, ) # TODO - Should update error message once permissioning by category is implemented return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="Invalid query parameter (The provided category is not valid)", expression="category", ) pointer_types = [params.type.root] if params.type else metadata.pointer_types bundle = {"resourceType": "Bundle", "type": "searchset", "total": 0, "entry": []} logger.log( LogReference.PROSEARCH003, custodian=metadata.ods_code, nhs_number=params.nhs_number, pointer_types=pointer_types, categories=params.category.root.split(",") if params.category else [], ) for result in repository.search( custodian=metadata.ods_code, nhs_number=params.nhs_number, pointer_types=pointer_types, categories=params.category.root.split(",") if params.category else [], ): try: document_reference = DocumentReference.model_validate_json(result.document) bundle["total"] += 1 bundle["entry"].append( {"resource": document_reference.model_dump(exclude_none=True)} ) logger.log( LogReference.PROSEARCH004, id=document_reference.id, count=bundle["total"], ) except ValidationError as exc: logger.log( LogReference.PROSEARCH005, error=str(exc), document=result.document ) operation_outcome = OperationOutcome( resourceType="OperationOutcome", issue=[ OperationOutcomeIssue( severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred whilst parsing the document reference search results", ) ], ) bundle["total"] += 1 bundle["entry"].append( {"resource": operation_outcome.model_dump(exclude_none=True)} ) response = Response.from_resource(Bundle.model_validate(bundle)) logger.log(LogReference.PROSEARCH999) return response NRLF-3.0.31/api/producer/searchDocumentReference/tests/000077500000000000000000000000001511201605300226525ustar00rootroot00000000000000NRLF-3.0.31/api/producer/searchDocumentReference/tests/test_search_document_reference_producer.py000066400000000000000000000372741511201605300333640ustar00rootroot00000000000000import json from unittest.mock import patch from moto import mock_aws from api.producer.searchDocumentReference.search_document_reference import handler from nrlf.core.constants import ( CATEGORY_ATTRIBUTES, TYPE_ATTRIBUTES, Categories, PointerTypes, ) from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_search_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_no_results(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_document_reference_missing_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "issue": [ { "code": "invalid", "details": { "coding": [ { "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", }, ], }, "diagnostics": "NHS number is missing from the search parameters", "expression": [ "subject:identifier", ], "severity": "error", }, ], "resourceType": "OperationOutcome", } @mock_aws @mock_repository def test_search_document_reference_invalid_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|123" }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid NHS number provided in the search parameters", "expression": ["subject:identifier"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_type(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid query parameter (The provided type does not match the allowed types for this organisation)", "expression": ["type"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_category( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid query parameter (The provided category is not valid)", "expression": ["category"], } ], } @mock_aws @mock_repository def test_search_document_reference_only_returns_custodian_pointers( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(ods_code="X26"), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_document_reference_filters_by_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": PointerTypes.MENTAL_HEALTH_PLAN.value, }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_filters_by_category( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": Categories.CARE_PLAN.value, }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_filters_with_multiple_categories( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 2, "entry": [ {"resource": doc_ref2.model_dump(exclude_none=True)}, {"resource": doc_ref.model_dump(exclude_none=True)}, ], } @mock_aws @mock_repository def test_search_document_reference_filters_by_pointer_types( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(app_id="123445", ods_code="X26"), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": [], } @mock_aws @mock_repository @patch("api.producer.searchDocumentReference.search_document_reference.logger") def test_search_document_reference_invalid_json( mock_logger, repository: DocumentPointerRepository ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_pointer_invalid = DocumentPointer.from_document_reference(doc_ref) doc_pointer_invalid.id = "Y05868-11111-99999-999992" doc_pointer_invalid.document = "invalid json" repository.create(doc_pointer_invalid) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={ "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191" }, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) expected_operation_outcome = { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred whilst parsing the document reference search results", } ], } assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 2, "entry": [ {"resource": doc_ref.model_dump(exclude_none=True)}, {"resource": expected_operation_outcome}, ], } assert any( call[0][0].name == "PROSEARCH005" for call in mock_logger.log.call_args_list ) NRLF-3.0.31/api/producer/searchPostDocumentReference/000077500000000000000000000000001511201605300223565ustar00rootroot00000000000000NRLF-3.0.31/api/producer/searchPostDocumentReference/search_post_document_reference.py000066400000000000000000000104771511201605300311670ustar00rootroot00000000000000from pydantic import ValidationError from nrlf.core.codes import SpineErrorConcept from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, ProducerRequestParams from nrlf.core.response import Response, SpineErrorResponse from nrlf.core.validators import validate_category, validate_type from nrlf.producer.fhir.r4.model import ( Bundle, DocumentReference, OperationOutcome, OperationOutcomeIssue, ) @request_handler(body=ProducerRequestParams) def handler( body: ProducerRequestParams, metadata: ConnectionMetadata, repository: DocumentPointerRepository, ) -> Response: """ Search for document references based on the provided parameters. Args: body (ProducerRequestParams): The request parameters for the search. metadata (ConnectionMetadata): The connection metadata. repository (DocumentPointerRepository): The repository for document pointers. Returns: Response: The response containing the search results. Raises: OperationOutcomeError: If an error occurs while parsing the document reference. """ logger.log(LogReference.PROPOSTSEARCH000) if not body.nhs_number: logger.log( LogReference.PROPOSTSEARCH001, subject_identifier=body.subject_identifier ) return SpineErrorResponse.INVALID_NHS_NUMBER( diagnostics="A valid NHS number is required to search for document references", expression="subject:identifier", ) if not validate_type(body.type, metadata.pointer_types): logger.log( LogReference.PROPOSTSEARCH002, type=body.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="The provided type does not match the allowed types for this organisation", expression="type", ) categories = body.category.root.split(",") if body.category else [] if not validate_category(categories): logger.log( LogReference.PROPOSTSEARCH002b, category=body.category, ) # TODO - Should update error message once permissioning by category is implemented return SpineErrorResponse.INVALID_CODE_SYSTEM( diagnostics="The provided category is not valid", expression="category", ) pointer_types = [body.type.root] if body.type else metadata.pointer_types bundle = {"resourceType": "Bundle", "type": "searchset", "total": 0, "entry": []} logger.log( LogReference.PROPOSTSEARCH003, custodian=metadata.ods_code, nhs_number=body.nhs_number, pointer_types=pointer_types, categories=categories, ) for result in repository.search( custodian=metadata.ods_code, nhs_number=body.nhs_number, pointer_types=pointer_types, categories=categories, ): try: document_reference = DocumentReference.model_validate_json(result.document) bundle["total"] += 1 bundle["entry"].append( {"resource": document_reference.model_dump(exclude_none=True)} ) logger.log( LogReference.PROPOSTSEARCH004, id=document_reference.id, count=bundle["total"], ) except ValidationError as exc: logger.log( LogReference.PROPOSTSEARCH005, error=str(exc), document=result.document ) operation_outcome = OperationOutcome( resourceType="OperationOutcome", issue=[ OperationOutcomeIssue( severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred whilst parsing the document reference search results", ) ], ) bundle["total"] += 1 bundle["entry"].append( {"resource": operation_outcome.model_dump(exclude_none=True)} ) logger.log(LogReference.PROPOSTSEARCH999) return Response.from_resource(Bundle.model_validate(bundle)) NRLF-3.0.31/api/producer/searchPostDocumentReference/tests/000077500000000000000000000000001511201605300235205ustar00rootroot00000000000000test_search_post_document_reference_producer.py000066400000000000000000000375061511201605300352160ustar00rootroot00000000000000NRLF-3.0.31/api/producer/searchPostDocumentReference/testsimport json from unittest.mock import patch from moto import mock_aws from api.producer.searchPostDocumentReference.search_post_document_reference import ( handler, ) from nrlf.core.constants import ( CATEGORY_ATTRIBUTES, TYPE_ATTRIBUTES, Categories, PointerTypes, ) from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_search_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_no_results(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_document_reference_missing_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "BAD_REQUEST", "display": "Bad request", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body is required", } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_nhs_number( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( {"subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|123"} ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "A valid NHS number is required to search for document references", "expression": ["subject:identifier"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_type(repository: DocumentPointerRepository): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The provided type does not match the allowed types for this organisation", "expression": ["type"], } ], } @mock_aws @mock_repository def test_search_document_reference_invalid_category( repository: DocumentPointerRepository, ): event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "https://fhir.nhs.uk/CodeSystem/Document-Type|invalid", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "code-invalid", "details": { "coding": [ { "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The provided category is not valid", "expression": ["category"], } ], } @mock_aws @mock_repository def test_search_document_reference_only_returns_custodian_pointers( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(ods_code="X26"), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": [], } @mock_aws @mock_repository def test_search_document_reference_filters_by_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "type": PointerTypes.MENTAL_HEALTH_PLAN.value, } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_document_reference_filters_by_category( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": Categories.CARE_PLAN.value, } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 1, "entry": [{"resource": doc_ref.model_dump(exclude_none=True)}], } @mock_aws @mock_repository def test_search_post_document_reference_filters_with_multiple_categories( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Second pointer different category doc_ref2 = load_document_reference("Y05868-736253002-Valid") doc_ref2.id = "Y05868-736253002-Valid2" doc_ref2.type.coding[0].code = PointerTypes.NEWS2_CHART.coding_value() doc_ref2.type.coding[0].display = TYPE_ATTRIBUTES.get( PointerTypes.NEWS2_CHART.value ).get("display") doc_ref2.category[0].coding[0].code = Categories.OBSERVATIONS.coding_value() doc_ref2.category[0].coding[0].display = CATEGORY_ATTRIBUTES.get( Categories.OBSERVATIONS.value ).get("display") repository.create(DocumentPointer.from_document_reference(doc_ref2)) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", "category": "http://snomed.info/sct|734163000,http://snomed.info/sct|1102421000000108", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 2, "entry": [ {"resource": doc_ref2.model_dump(exclude_none=True)}, {"resource": doc_ref.model_dump(exclude_none=True)}, ], } @mock_aws @mock_repository def test_search_document_reference_filters_by_pointer_types( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(app_id="12356", ods_code="X26"), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 0, "entry": [], } @mock_aws @mock_repository @patch("api.producer.searchPostDocumentReference.search_post_document_reference.logger") def test_search_post_document_reference_invalid_json_adds_operation_outcome( mock_logger, repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_pointer_invalid = DocumentPointer.from_document_reference(doc_ref) doc_pointer_invalid.id = "Y05868-11111-99999-999992" doc_pointer_invalid.document = "invalid json" repository.create(doc_pointer_invalid) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|6700028191", } ), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) expected_operation_outcome = { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred whilst parsing the document reference search results", } ], } assert parsed_body == { "resourceType": "Bundle", "type": "searchset", "total": 2, "entry": [ {"resource": doc_ref.model_dump(exclude_none=True)}, {"resource": expected_operation_outcome}, ], } assert any( call[0][0].name == "PROPOSTSEARCH005" for call in mock_logger.log.call_args_list ) NRLF-3.0.31/api/producer/status/000077500000000000000000000000001511201605300162505ustar00rootroot00000000000000NRLF-3.0.31/api/producer/status/status.py000066400000000000000000000020051511201605300201420ustar00rootroot00000000000000import sys from nrlf.core.config import Config from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.logger import LogReference, logger from nrlf.core.response import Response @request_handler(skip_request_verification=True) def handler(event, context) -> Response: """ Entrypoint for the status function """ try: logger.log(LogReference.STATUS000) logger.log(LogReference.STATUS001) config = Config() logger.log(LogReference.STATUS002) repository = DocumentPointerRepository(table_name=config.TABLE_NAME) repository.get_by_id("ODSX-NULL") response = Response(statusCode="200", body="OK") logger.log(LogReference.STATUS999) return response except Exception as exc: logger.log( LogReference.STATUS003, error=str(exc), exc_info=sys.exc_info(), stacklevel=5, ) return Response(statusCode="503", body="Service unavailable") NRLF-3.0.31/api/producer/status/tests/000077500000000000000000000000001511201605300174125ustar00rootroot00000000000000NRLF-3.0.31/api/producer/status/tests/test_status.py000066400000000000000000000021021511201605300223410ustar00rootroot00000000000000import os from moto import mock_aws from api.producer.status.status import handler from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository def test_status_happy_path(repository): event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) assert result == { "statusCode": "200", "headers": default_response_headers(), "body": "OK", "isBase64Encoded": False, } @mock_aws @mock_repository def test_status_unhandled_exception(repository): region = os.environ.pop("AWS_REGION") event = create_test_api_gateway_event(headers=create_headers()) result = handler(event, create_mock_context()) assert result == { "statusCode": "503", "headers": default_response_headers(), "body": "Service unavailable", "isBase64Encoded": False, } os.environ.update(AWS_REGION=region) NRLF-3.0.31/api/producer/swagger.yaml000066400000000000000000002776441511201605300172740ustar00rootroot00000000000000openapi: 3.0.0 # This is an OpenAPI Specification (https://swagger.io/specification/) # for the National Record Locator Producer FHIR API # owned by NHS Digital (https://digital.nhs.uk/) info: title: National Record Locator Producer - FHIR API version: 1.0.0 license: name: MIT contact: name: NHS Digital API Management url: "https://digital.nhs.uk/developer/help-and-support" email: api.management@nhs.net servers: - url: https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4 description: Sandbox environment. - url: https://int.api.service.nhs.uk/record-locator/producer/FHIR/R4 description: Integration test environment. - url: https://api.service.nhs.uk/record-locator/producer/FHIR/R4 description: Production environment. tags: paths: /DocumentReference: post: tags: summary: Create new, or Supersede existing, document pointers operationId: createDocumentReference responses: "201": description: Create / Supersede successful response $ref: "#/components/responses/Success" content: application/fhir+json: example: resourceType: OperationOutcome id: 76db24dc-324a-468a-bf02-c06e82279488 meta: profile: - https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome issue: - severity: information code: informational details: coding: - system: https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode code: RESOURCE_CREATED display: Resource created diagnostics: Resource created requestBody: $ref: "#/components/requestBodies/DocumentReference" parameters: - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_createDocumentReference} responses: default: statusCode: "201" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Create new pointers, or Supersede existing ones. To create a document pointer you must ensure: * the body must be a valid [FHIR R4 DocumentReference](https://hl7.org/fhir/R4/documentreference.html) * `subject` MUST be a `Patient` reference using a valid NHS number. e.g. ``` "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "3495456481" } }, ``` * `custodian` MUST be an `Organization` reference using a valid ODS code, agreed during [onboarding](#api-description__onboarding). e.g. ``` "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ``` * `type` MUST match one of the Document Types agreed during [onboarding](#api-description__onboarding). e.g. ``` "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "1363501000000100", "display": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart" } ] } ``` * `category` MUST indicate the broader class of the Document Type as agreed during [onboarding](#api-description__onboarding). e.g. ``` "category": { "coding": [ { "system": "http://snomed.info/sct", "code": "1102421000000108", "display": "Observations" } ] } ``` * `content` MUST have at least one entry. * `content[].format[]` SHOULD indicate whether the data is structured or not, e.g. ``` "format": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured" "display": "Unstructured Document" } ] ``` * `author` SHOULD have an entry with an `Organization` reference using a valid ODS code. ``` "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ] ``` * `context` MUST include a `practiceSetting` and `related` entry containing the ASID if the document is to be accessed via SSP, e.g. ``` "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001" "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "230811201350" } } ] } ``` To supersede existing pointers you must further specify: * at least one existing pointer in the `relatesTo` with a `code` of `replaces`. ``` [ { "code": "replaces", "target": { "type": "DocumentReference", "identifier": { "value": "XYZ-1234567890" } } } ] ``` * the following fields MUST match the pointers being superseded: * `subject` * `type` This will cause a new pointer to be created and superseded pointers to be deleted. Multiple documents can be superseded. A globally unique `id` will be generated by NRLF for the newly created pointer. The id will be prefixed with the custodian's ODS code, and can be found in the `location` response header. get: tags: summary: Retrieve document pointers (GET) operationId: searchDocumentReference parameters: - $ref: "#/components/parameters/subject" - $ref: "#/components/parameters/type" - $ref: "#/components/parameters/category" - $ref: "#/components/parameters/nextPageToken" - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "200": description: successful response content: application/fhir+json: schema: $ref: "#/components/schemas/Bundle" example: resourceType: Bundle type: searchset total: 2 entry: - resource: resourceType: DocumentReference id: Y05868-1834567891 meta: profile: - http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0 masterIdentifier: system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2004.3.7 identifier: - system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1134 status: current docStatus: "preliminary " type: coding: - system: http://snomed.info/sct code: "1363501000000100" display: Royal College of Physicians NEWS2 (National Early Warning Score 2) chart category: - coding: - system: http://loinc.org code: 34769-0 display: General medicine Physician attending Note subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "3495456481" date: "2022-12-22T11:45:41+11:00" author: - identifier: value: Practitioner/A782161SZ authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/PhysicianNote.pdf creation: "2022-12-22T09:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:handp:2008 display: History and Physical Specification context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" - resource: resourceType: DocumentReference id: Y05868-1234567891 meta: profile: - http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0 masterIdentifier: system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7 identifier: - system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234 status: current docStatus: final type: coding: - system: http://snomed.info/sct code: "861421000000109" display: End of life care coordination summary category: - coding: - system: http://loinc.org code: 55112-7 display: Document summary subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "3495456481" date: "2022-12-21T10:45:41+11:00" author: - identifier: value: Practitioner/A985657ZA authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 description: Physical securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EOLSummaryReport.pdf size: 3654 hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk= title: Physical creation: "2022-12-21T10:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:cm:2008 display: Care Management context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_searchDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Search through document pointers. Results are restricted to pointers you created, but can be further filtered by `subject` and `type`. Results are limited to 20 records per request, and further records are available by submitting subsequent requests with the `next-page-token` found in the `meta` portion of the response. This operation is also available as a http POST, which is the preferred method (see below). put: tags: summary: Create document pointers with a specific id operationId: upsertDocumentReference parameters: - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "201": $ref: "#/components/responses/Success" description: Create / Supersede successful response content: application/fhir+json: example: resourceType: OperationOutcome id: 76db24dc-324a-468a-bf02-c06e82279488 meta: profile: - https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome issue: - severity: information code: informational details: coding: - system: https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode code: RESOURCE_CREATED display: Resource created diagnostics: Resource created requestBody: $ref: "#/components/requestBodies/DocumentReference" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_upsertDocumentReference} responses: default: statusCode: "201" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Create a new pointer with a unique identifier that you specify. This is the "upsert" or "update as create" functionality in the FHIR R4 REST standard. In addition to the criteria for DocumentReference validity detailed in the POST interaction, you must ensure: * `id` is a composite of the ODS Code and an identifier that is locally unique to your system. NRL does not generate globally unique ids, instead relies on producers to provide a locally unique id prefixed with their ODS code, making it globally unique. e.g. ``` XYZ-1234567890 ``` To supersede existing pointers you must further specify: * at least one existing pointer in the `relatesTo` with a `code` of `replaces`. ``` [ { "code": "replaces", "target": { "type": "DocumentReference", "identifier": { "value": "XYZ-1234567890" } } } ] ``` * the following fields MUST match the pointers being superseded: * `subject` * `type` This will cause a new pointer to be created and superseded pointers to be deleted. Multiple documents can be superseded. /DocumentReference/_search: post: tags: summary: Retrieve document pointers (POST) operationId: searchPostDocumentReference parameters: - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestParams" responses: "200": description: Successful response content: application/fhir+json: schema: $ref: "#/components/schemas/Bundle" example: resourceType: Bundle type: searchset total: 2 entry: - resource: resourceType: DocumentReference id: Y05868-1834567891 meta: profile: - http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0 masterIdentifier: system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2004.3.7 identifier: - system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1134 status: current docStatus: "preliminary " type: coding: - system: http://snomed.info/sct code: "1363501000000100" display: Royal College of Physicians NEWS2 (National Early Warning Score 2) chart category: - coding: - system: http://loinc.org code: 34769-0 display: General medicine Physician attending Note subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "3495456481" date: "2022-12-22T11:45:41+11:00" author: - identifier: value: Practitioner/A782161SZ authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/PhysicianNote.pdf creation: "2022-12-22T09:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:handp:2008 display: History and Physical Specification context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" - resource: resourceType: DocumentReference id: Y05868-1234567891 meta: profile: - http://fhir.nhs.net/StructureDefinition/nrls-documentreference-1-0 masterIdentifier: system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7 identifier: - system: urn:ietf:rfc:3986 value: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234 status: current docStatus: final type: coding: - system: http://snomed.info/sct code: "861421000000109" display: End of life care coordination summary category: - coding: - system: http://loinc.org code: 55112-7 display: Document summary subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "3495456481" date: "2022-12-21T10:45:41+11:00" author: - identifier: value: Practitioner/A985657ZA authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 description: Physical securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EOLSummaryReport.pdf size: 3654 hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk= title: Physical creation: "2022-12-21T10:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:cm:2008 display: Care Management context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_searchPostDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Search through document pointers. Results are restricted to pointers you created, but can be further filtered by `subject` and `type`. Results are limited to 20 records per request, and further records are available by submitting subsequent requests with the `next-page-token` found in the `meta` portion of the response. This operation is also available as a http GET for convenience (see above), but POST is preferred for the following reasons: * query string parameters are visible on the network and in logs, and may have privacy implications for consumers. * GET operations can be cached by intermediary network infrastructure, such as CDNs, routers and proxies. * URLs have a maximum length of 2,048 characters which complex searches can exceed. NRL does not currently exceed this limit, but may evolve in the future. /DocumentReference/{id}: get: tags: summary: Get a single document pointer operationId: readDocumentReference parameters: - $ref: "#/components/parameters/id" - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "200": description: Successful response content: application/fhir+json: schema: $ref: "#/components/schemas/DocumentReference" example: resourceType: DocumentReference id: Y05868-1234567892 status: current docStatus: final type: coding: - system: http://snomed.info/sct code: "887701000000100" display: Emergency health care plan category: - coding: - system: http://loinc.org code: 68552-9 display: Emergency medicine Emergency department Admission evaluation note subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "4409815415" date: "2022-12-22T11:45:41+11:00" author: - identifier: value: Practitioner/A985657ZA authenticator: identifier: value: Organization/Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EmergencyCarPlan.pdf creation: "2022-12-22T09:45:41+11:00" format: system: urn:oid:1.3.6.1.4.1.19376.1.2.3 code: urn:ihe:pcc:handp:2008 display: History and Physical Specification context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_readDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Read a single document pointer by specifying the `DocumentReference.id`. Note that you will only be able to retrieve document pointers that have been created by the organisation specified in the `ODS-End-User-Organisation-ODS` header, and agreed during [onboarding](#onbaroding). put: tags: summary: Update a single document pointer operationId: updateDocumentReference parameters: - $ref: "#/components/parameters/id" - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "200": description: Successful response $ref: "#/components/responses/Success" content: application/fhir+json: example: resourceType: OperationOutcome id: fc39effb-144c-4342-bdf2-4214f0cb728b meta: profile: - https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome issue: - severity: information code: informational details: coding: - system: https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode code: RESOURCE_UPDATED display: Resource updated diagnostics: Resource updated "201": description: Successful response $ref: "#/components/responses/Success" content: application/fhir+json: example: resourceType: OperationOutcome id: fc39effb-144c-4342-bdf2-4214f0cb728b meta: profile: - https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome issue: - severity: information code: informational details: coding: - system: https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode code: RESOURCE_UPDATED display: Resource updated diagnostics: Resource updated requestBody: $ref: "#/components/requestBodies/DocumentReference" x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_updateDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Update a single pointer you created. Note that the following fields cannot change: * `id` * `subject` * `custodian` * `type` * `masterIdentifier` * `identifier` * `status` * `date` * `relatesTo` * `author` Note that unlike NRL STU3 changing the `status` field does NOT delete document pointers. To delete document pointers use the `DELETE` endpoint. delete: tags: summary: Delete a single document pointer operationId: deleteDocumentReference parameters: - $ref: "#/components/parameters/id" - $ref: "#/components/parameters/odsCode" - $ref: "#/components/parameters/requestId" - $ref: "#/components/parameters/correlationId" responses: "204": description: Successful response $ref: "#/components/responses/Success" content: application/fhir+json: example: resourceType: OperationOutcome id: c6113a50-70bf-436e-b417-7c8024d2e8bf meta: profile: - https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome issue: - severity: information code: informational details: coding: - system: https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode code: RESOURCE_REMOVED display: Resource removed diagnostics: Resource removed "200": $ref: "#/components/responses/Success" description: Successful response content: application/fhir+json: example: resourceType: OperationOutcome id: c6113a50-70bf-436e-b417-7c8024d2e8bf meta: profile: - https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome issue: - severity: information code: informational details: coding: - system: https://fhir.nhs.uk/CodeSystem/NRLF-SuccessCode code: RESOURCE_REMOVED display: Resource removed diagnostics: Resource removed x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_deleteDocumentReference} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT description: | Delete a single document pointer that your created. /metadata: get: summary: Retrieve FHIR Capability Statement operationId: getCapabilityStatement responses: "200": description: Capability statement response content: application/json: schema: type: object x-amazon-apigateway-integration: type: MOCK requestTemplates: application/json: '{ "statusCode": 200 }' responses: default: statusCode: "200" responseTemplates: # prettier-ignore application/json: '${capability_statement_json}' /_status: get: summary: _status endpoint for APIGEE integration operationId: status responses: "200": description: Producer API is operational content: application/json: schema: type: object properties: message: type: string enum: ["OK"] x-amazon-apigateway-integration: type: aws_proxy httpMethod: POST uri: ${method_status} responses: default: statusCode: "200" passthroughBehavior: when_no_match contentHandling: CONVERT_TO_TEXT components: requestBodies: DocumentReference: content: application/fhir+json: schema: $ref: "#/components/schemas/DocumentReference" example: resourceType: DocumentReference id: Y05868-00000000-make-unique-for-sandbox-request status: current docStatus: final type: coding: - system: http://snomed.info/sct code: "736253002" display: Mental health crisis plan category: - coding: - system: http://snomed.info/sct code: "734163000" display: Care plan subject: identifier: system: https://fhir.nhs.uk/Id/nhs-number value: "6700028191" author: - identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 custodian: identifier: system: https://fhir.nhs.uk/Id/ods-organization-code value: Y05868 description: Physical document mental health crisis plan securityLabel: - coding: - system: http://terminology.hl7.org/CodeSystem/v3-Confidentiality code: V display: very restricted content: - attachment: contentType: application/pdf language: en-US url: https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf size: 3654 hash: 2jmj7l5rSw0yVb/vlWAYkK/YBwk= title: Mental health crisis plan report creation: "2022-12-21T10:45:41+11:00" format: system: https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode code: "urn:nhs-ic:unstructured" display: Unstructured Document context: event: - coding: - system: http://snomed.info/sct code: "445627002" display: Assessment using adult early warning scoring system period: start: "2022-12-20T09:00:41+11:00" end: "2022-12-20T09:45:41+11:00" facilityType: coding: - system: http://snomed.info/sct code: "82242000" display: Children's hospital practiceSetting: coding: - system: http://snomed.info/sct code: "788002001" display: Adult mental health service related: - identifier: system: https://fhir.nhs.uk/Id/nhsSpineASID value: "200000000610" required: true schemas: OperationOutcome: type: object properties: resourceType: type: string enum: - OperationOutcome id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. meta: $ref: "#/components/schemas/Meta" description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. implicitRules: type: string pattern: \S* description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The base language in which the resource is written. text: $ref: "#/components/schemas/Narrative" description: A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. issue: type: array items: $ref: "#/components/schemas/OperationOutcomeIssue" description: An error, warning, or information message that results from a system action. minItems: 1 required: - resourceType - issue OperationOutcomeIssue: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. severity: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Indicates whether the issue indicates a variation from successful processing. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element. details: $ref: "#/components/schemas/CodeableConcept" description: Additional details about the error. This may be a text description of the error or a system code that identifies the error. diagnostics: type: string pattern: "[ \\r\\n\\t\\S]+" description: Additional diagnostic information about the issue. location: type: array items: type: string pattern: "[ \\r\\n\\t\\S]+" description: "This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be \"http.\" + the parameter name." expression: type: array items: type: string pattern: "[ \\r\\n\\t\\S]+" description: A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. required: - severity - code DocumentReference: type: object properties: resourceType: type: string enum: - DocumentReference id: type: string pattern: "^(?=.{1,64}$)[A-Za-z0-9\\.]+-[A-Za-z0-9]+[A-Za-z0-9\\_\\-]*$" description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. meta: $ref: "#/components/schemas/Meta" description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. implicitRules: type: string pattern: \S* description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The base language in which the resource is written. text: $ref: "#/components/schemas/Narrative" description: A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. masterIdentifier: $ref: "#/components/schemas/Identifier" description: Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. identifier: type: array items: $ref: "#/components/schemas/Identifier" description: Other identifiers associated with the document, including version independent identifiers. status: type: string pattern: "^current$" description: The status of this document reference. docStatus: type: string enum: ["entered-in-error", "amended", "preliminary", "final"] description: The status of the underlying document. type: $ref: "#/components/schemas/NRLCodeableConcept" description: Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. category: type: array items: $ref: "#/components/schemas/NRLCodeableConcept" description: A categorization for the type of document referenced – helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. subject: $ref: "#/components/schemas/Reference" description: Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). date: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: When the document reference was created. author: type: array items: $ref: "#/components/schemas/Reference" description: Identifies who is responsible for adding the information to the document. authenticator: $ref: "#/components/schemas/Reference" description: Which person or organization authenticates that this document is valid. custodian: $ref: "#/components/schemas/Reference" description: Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. relatesTo: type: array items: $ref: "#/components/schemas/DocumentReferenceRelatesTo" description: Relationships that this document has with other document references that already exist. description: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: Human–readable description of the source document. securityLabel: type: array items: $ref: "#/components/schemas/CodeableConcept" description: A set of Security–Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. content: type: array items: $ref: "#/components/schemas/DocumentReferenceContent" description: The document and format referenced. There may be multiple content element repetitions, each with a different format. minItems: 1 context: $ref: "#/components/schemas/DocumentReferenceContext" description: The clinical context in which the document was prepared. required: - resourceType - status - content - author - context - type - category Bundle: type: object properties: resourceType: type: string enum: - Bundle id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. meta: $ref: "#/components/schemas/Meta" description: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. implicitRules: type: string pattern: \S* description: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The base language in which the resource is written. identifier: $ref: "#/components/schemas/Identifier" description: A persistent identifier for the bundle that won't change as a bundle is copied from server to server. type: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Indicates the purpose of this bundle – how it is intended to be used. timestamp: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle. total: type: integer format: int32 description: If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle. link: type: array items: $ref: "#/components/schemas/BundleLink" description: A series of links that provide context to this bundle. entry: type: array items: $ref: "#/components/schemas/BundleEntry" description: An entry in a bundle resource – will either contain a resource or information about a resource (transactions and history only). signature: $ref: "#/components/schemas/Signature" description: Digital Signature – base64 encoded. XML–DSig or a JWT. required: - resourceType - type BundleEntry: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. link: type: array items: $ref: "#/components/schemas/BundleLink" description: A series of links that provide context to this entry. fullUrl: type: string pattern: \S* description: "The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified." resource: oneOf: - $ref: "#/components/schemas/DocumentReference" - $ref: "#/components/schemas/OperationOutcome" description: The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. search: $ref: "#/components/schemas/BundleEntrySearch" description: Information about the search process that lead to the creation of this entry. request: $ref: "#/components/schemas/BundleEntryRequest" description: Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry. response: $ref: "#/components/schemas/BundleEntryResponse" description: Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history. BundleEntryResponse: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. status: type: string pattern: "[ \\r\\n\\t\\S]+" description: The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code. location: type: string pattern: \S* description: The location header created by processing this operation, populated if the operation returns a location. etag: type: string pattern: "[ \\r\\n\\t\\S]+" description: The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)). lastModified: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: The date/time that the resource was modified on the server. outcome: $ref: "#/components/schemas/DocumentReference" description: An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction. required: - status BundleEntryRequest: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. method: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred. url: type: string pattern: \S* description: The URL for this entry, relative to the root (the address to which the request is posted). ifNoneMatch: type: string pattern: "[ \\r\\n\\t\\S]+" description: If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread). ifModifiedSince: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread). ifMatch: type: string pattern: "[ \\r\\n\\t\\S]+" description: Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). ifNoneExist: type: string pattern: "[ \\r\\n\\t\\S]+" description: Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL – what follows the "?" (not including the "?"). required: - method - url BundleEntrySearch: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. mode: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. score: type: number description: When searching, the server's search ranking score for the entry. BundleLink: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. relation: type: string pattern: "[ \\r\\n\\t\\S]+" description: A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1). url: type: string pattern: \S* description: The reference details for the link. required: - relation - url DocumentReferenceContext: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. encounter: type: array items: $ref: "#/components/schemas/Reference" description: Describes the clinical encounter or type of care that the document content is associated with. event: type: array items: $ref: "#/components/schemas/CodeableConcept" description: This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. period: $ref: "#/components/schemas/Period" description: The time period over which the service that is described by the document was provided. facilityType: $ref: "#/components/schemas/CodeableConcept" description: The kind of facility where the patient was seen. practiceSetting: $ref: "#/components/schemas/NRLCodeableConcept" description: This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. sourcePatientInfo: $ref: "#/components/schemas/Reference" description: The Patient Information as known when the document was published. May be a reference to a version specific, or contained. related: type: array items: $ref: "#/components/schemas/Reference" description: Related identifiers or resources associated with the DocumentReference. required: - practiceSetting DocumentReferenceContent: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. attachment: $ref: "#/components/schemas/Attachment" description: The document or URL of the document along with critical metadata to prove content has integrity. format: $ref: "#/components/schemas/NRLFormatCode" description: An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. extension: type: array items: oneOf: - $ref: "#/components/schemas/ContentStabilityExtension" - $ref: "#/components/schemas/NRLRetrievalMechanismExtension" - $ref: "#/components/schemas/Extension" description: Additional extensions which include Content Stability and Retrieval Mechanism. minItems: 1 required: - attachment - format - extension DocumentReferenceRelatesTo: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The type of relationship that this document has with anther document. target: $ref: "#/components/schemas/Reference" description: The target document of this relationship. required: - code - target Attachment: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. contentType: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. language: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The human language of the content. The value can be any valid value according to BCP 47. data: type: string pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+ description: The actual data of the attachment – a sequence of bytes, base64 encoded. url: type: string pattern: \S* description: A location where the data can be accessed. size: type: integer format: int32 description: The number of bytes of data that make up this attachment (before base64 encoding, if that is done). hash: type: string pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+ description: The calculated hash of the data using SHA–1. Represented using base64. title: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A label or set of text to display in place of the data. creation: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)? description: The date that the attachment was first created. required: - contentType - url CodeableConcept: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. coding: type: array items: $ref: "#/components/schemas/Coding" description: A reference to a code defined by a terminology system. text: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. NRLCodeableConcept: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. coding: type: array items: $ref: "#/components/schemas/NRLCoding" description: A reference to a code defined by a terminology system. minItems: 1 maxItems: 1 text: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. required: - coding Coding: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. system: type: string pattern: \S+ description: The identification of the code system that defines the meaning of the symbol in the code. version: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination). display: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A representation of the meaning of the code in the system, following the rules of the system. userSelected: type: boolean description: Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays). NRLCoding: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. system: type: string pattern: \S+ description: The identification of the code system that defines the meaning of the symbol in the code. version: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination). display: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A representation of the meaning of the code in the system, following the rules of the system. userSelected: type: boolean description: Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays). required: - system - code - display Extension: type: object properties: valueCodeableConcept: $ref: "#/components/schemas/CodeableConcept" description: A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1). url: type: string pattern: \S* description: The reference details for the link. ContentStabilityExtension: allOf: - $ref: "#/components/schemas/Extension" - type: object properties: url: type: string enum: - "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" valueCodeableConcept: $ref: "#/components/schemas/ContentStabilityExtensionValueCodeableConcept" required: - url - valueCodeableConcept ContentStabilityExtensionValueCodeableConcept: allOf: - $ref: "#/components/schemas/CodeableConcept" - type: object properties: coding: type: array items: $ref: "#/components/schemas/ContentStabilityExtensionCoding" minItems: 1 maxItems: 1 required: - coding ContentStabilityExtensionCoding: allOf: - $ref: "#/components/schemas/Coding" - type: object properties: system: type: string enum: - "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability" code: type: string enum: ["static", "dynamic"] display: type: string enum: ["Static", "Dynamic"] required: - system - code - display NRLRetrievalMechanismExtension: allOf: - $ref: "#/components/schemas/Extension" - type: object properties: url: type: string enum: - "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" valueCodeableConcept: $ref: "#/components/schemas/NRLRetrievalMechanismExtensionValueCodeableConcept" required: - url - valueCodeableConcept NRLRetrievalMechanismExtensionValueCodeableConcept: allOf: - $ref: "#/components/schemas/CodeableConcept" - type: object properties: coding: type: array items: $ref: "#/components/schemas/NRLRetrievalMechanismExtensionCoding" minItems: 1 maxItems: 1 required: - coding NRLRetrievalMechanismExtensionCoding: allOf: - $ref: "#/components/schemas/Coding" - type: object properties: system: type: string enum: - "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism" code: type: string enum: ["SSP", "Direct", "LDR", "InContext"] display: type: string enum: [ "Spine Secure Proxy", "Direct", "Large Document Retrieval", "Direct using In-Context", ] required: - system - code - display NRLFormatCode: allOf: - $ref: "#/components/schemas/Coding" - type: object properties: system: type: string enum: - "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode" description: The system URL for the NRLF Format Code. code: type: string enum: - "urn:nhs-ic:record-contact" - "urn:nhs-ic:unstructured" - "urn:nhs-ic:structured" description: The code representing the format of the document. display: type: string enum: - "Contact details (HTTP Unsecured)" - "Unstructured Document" - "Structured Document" description: The display text for the code. required: - system - code - display Identifier: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. use: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The purpose of this identifier. type: $ref: "#/components/schemas/CodeableConcept" description: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. system: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: Establishes the namespace for the value – that is, a URL that describes a set values that are unique. value: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: The portion of the identifier typically relevant to the user and which is unique within the context of the system. period: $ref: "#/components/schemas/Period" description: Time period during which identifier is/was valid for use. assigner: $ref: "#/components/schemas/Reference" description: Organization that issued/manages the identifier. Period: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. start: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)? description: The start of the period. The boundary is inclusive. end: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)? description: The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Quantity: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. value: type: number description: The value of the measured amount. The value includes an implicit precision in the presentation of the value. comparator: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. unit: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A human–readable form of the unit. system: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: The identification of the system that provides the coded form of the unit. code: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A computer processable form of the unit in some unit representation system. Reference: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. reference: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. type: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: |- The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). identifier: $ref: "#/components/schemas/Identifier" description: An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. display: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: Plain text narrative that identifies the resource in addition to the resource reference. Signature: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. type: type: array items: $ref: "#/components/schemas/Coding" description: An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document. minItems: 1 when: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: When the digital signature was signed. who: $ref: "#/components/schemas/Reference" description: A reference to an application–usable description of the identity that signed (e.g. the signature used their private key). onBehalfOf: $ref: "#/components/schemas/Reference" description: A reference to an application–usable description of the identity that is represented by the signature. targetFormat: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A mime type that indicates the technical format of the target resources signed by the signature. sigFormat: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc. data: type: string pattern: (\s*([0-9a-zA-Z\+/=]){4}\s*)+ description: The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty. required: - type - when - who Meta: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. versionId: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. lastUpdated: type: string pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)) description: When the resource last changed – e.g. when the version changed. source: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. profile: type: array items: type: string pattern: "[\\S]+[ \\r\\n\\t\\S]*" description: A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url). security: type: array items: $ref: "#/components/schemas/Coding" description: Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. tag: type: array items: $ref: "#/components/schemas/Coding" description: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Narrative: type: object properties: id: type: string pattern: "[A-Za-z0-9\\-\\.]{1,64}" description: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. status: type: string pattern: "[^\\s]+(\\s[^\\s]+)*" description: The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. div: type: string description: The actual narrative content, a stripped down version of XHTML. required: - status - div DocumentId: type: string pattern: '[A-Za-z0-9\-\.]{1,64}' # https://build.fhir.org/datatypes.html#id RequestPathParams: type: object properties: id: $ref: "#/components/schemas/DocumentId" required: - id RequestHeader: type: object properties: odsCode: $ref: "#/components/schemas/RequestHeaderOdsCode" required: - odsCode RequestParams: type: object properties: subject:identifier: $ref: "#/components/schemas/RequestQuerySubject" type: $ref: "#/components/schemas/RequestQueryType" category: $ref: "#/components/schemas/RequestQueryCategory" next-page-token: $ref: "#/components/schemas/NextPageToken" RequestQuerySubject: type: string pattern: ^https\:\/\/fhir\.nhs\.uk\/Id\/nhs-number\|(\d+)$ example: "https://fhir.nhs.uk/Id/nhs-number|4409815415" RequestQueryType: type: string example: "http://snomed.info/sct|736253002" RequestQueryCategory: type: string example: "http://snomed.info/sct|103693007" NextPageToken: type: string RequestHeaderOdsCode: type: string RequestHeaderOrganisationExtensionCode: type: string RequestHeaderRequestId: type: string pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" example: 60E0B220-8136-4CA5-AE46-1D97EF59D068 RequestHeaderCorrelationId: type: string example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA parameters: id: name: id in: path required: true description: logical identifier schema: $ref: "#/components/schemas/DocumentId" examples: valid: summary: Valid value: Y05868-1234567892 invalid: summary: Unknown value: Y05861-1234567800 subject: name: subject:identifier in: query schema: $ref: "#/components/schemas/RequestQuerySubject" examples: none: summary: None value: "" valid_1: summary: "Valid #1" value: https://fhir.nhs.uk/Id/nhs-number|4409815415 valid_2: summary: "Valid #2" value: https://fhir.nhs.uk/Id/nhs-number|3495456481 invalid: summary: Unknown value: https://fhir.nhs.uk/Id/nhs-number|3495456001 type: name: type in: query schema: $ref: "#/components/schemas/RequestQueryType" examples: none: summary: None value: "" SNOMED_CODES_MENTAL_HEALTH_CRISIS_PLAN: summary: Mental health crisis plan value: http://snomed.info/sct|736253002 SNOMED_CODES_EMERGENCY_HEALTH_CARE_PLAN: summary: Emergency health care plan value: http://snomed.info/sct|887701000000100 SNOMED_CODES_END_OF_LIFE_CARE_COORDINATION_SUMMARY: summary: End of Life Care Coordination Summary value: http://snomed.info/sct|861421000000109 SNOMED_CODES_RESPECT_FORM: summary: ReSPECT form value: http://snomed.info/sct|1382601000000107 SNOMED_CODES_NEWS2_CHART: summary: Royal College of Physicians NEWS2 chart value: http://snomed.info/sct|1363501000000100 SNOMED_CODES_CONTINGENCY_PLAN: summary: Contingency plan value: http://snomed.info/sct|325691000000100 SNOMED_CODES_END_OF_LIFE_CARE_PLAN: summary: End of life care plan value: http://snomed.info/sct|736373009 SNOMED_CODES_LLOYD_GEORGE_RECORD_FOLDER: summary: Lloyd George record folder value: http://snomed.info/sct|16521000000101 SNOMED_CODES_ADVANCE_CARE_PLAN: summary: Advance care plan value: http://snomed.info/sct|736366004 SNOMED_CODES_TREATMENT_ESCALATION_PLAN: summary: Treatment escalation plan value: http://snomed.info/sct|735324008 SNOMED_CODES_SUMMARY_RECORD: summary: Summary record value: http://snomed.info/sct|824321000000109 SNOME_CODES_PERSONALISED_CARE_AND_SUPPORT_PLAN: summary: Personalised Care and Support Plan value: http://snomed.info/sct|2181441000000107 invalid: summary: Unknown value: http://snomed.info/sct|410970009 category: name: category in: query schema: $ref: "#/components/schemas/RequestQueryCategory" examples: none: summary: None value: "" SNOMED_CODES_CARE_PLAN: summary: Care plan value: http://snomed.info/sct|734163000 SNOMED_CODES_OBSERVATIONS: summary: Observations value: http://snomed.info/sct|1102421000000108 SNOMED_CODES_CLINICAL_NOTE: summary: Clinical note value: http://snomed.info/sct|823651000000106 SNOMED_CODES_DIAGNOSTIC_STUDIES_REPORT: summary: Diagnostic studies report value: http://snomed.info/sct|721981007 SNOMED_CODES_DIAGNOSTIC_PROCEDURE: summary: Diagnostic procedure value: http://snomed.info/sct|103693007 invalid: summary: Unknown value: http://snomed.info/sct|410970009 nextPageToken: name: next-page-token in: query description: | A token that can be sent as either a query parameter or in the post body parameter to retrieve the next set of 20 records. This token is returned in the meta.tag field. schema: $ref: "#/components/schemas/NextPageToken" odsCode: name: NHSD-End-User-Organisation-ODS description: ODS Code for Organisation in: header schema: $ref: "#/components/schemas/RequestHeaderOdsCode" required: true examples: valid: summary: Valid value: Y05868 invalid: summary: Unknown value: XYZ requestId: name: X-Request-ID description: | A globally unique identifier (GUID) for the request, which can be used to trace the request if you contact our helpdesk. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header. in: header required: true schema: $ref: "#/components/schemas/RequestHeaderRequestId" correlationId: name: X-Correlation-ID description: | An optional ID which you can use to track transactions across multiple systems, and we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk. If you re-send a failed request please re-send this ID in the header. It can take any value, but we recommend avoiding `.` characters. Mirrored back in a response header. in: header required: false schema: $ref: "#/components/schemas/RequestHeaderCorrelationId" responses: Success: description: Success Response headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" content: application/fhir+json: schema: $ref: "#/components/schemas/OperationOutcome" Error: description: Error Response headers: X-Correlation-Id: $ref: "#/components/headers/CorrelationId" X-Request-Id: $ref: "#/components/headers/RequestId" content: application/fhir+json: schema: $ref: "#/components/schemas/OperationOutcome" headers: CorrelationId: schema: type: string example: 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA description: | The X-Correlation-ID from the request header, if supplied, mirrored back. RequestId: schema: type: string pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" example: 60E0B220-8136-4CA5-AE46-1D97EF59D068 description: | The X-Request-ID from the request header mirrored back. NRLF-3.0.31/api/producer/updateDocumentReference/000077500000000000000000000000001511201605300215255ustar00rootroot00000000000000NRLF-3.0.31/api/producer/updateDocumentReference/tests/000077500000000000000000000000001511201605300226675ustar00rootroot00000000000000NRLF-3.0.31/api/producer/updateDocumentReference/tests/test_update_document_reference.py000066400000000000000000001017041511201605300315010ustar00rootroot00000000000000import json from freezegun import freeze_time from moto import mock_aws from pytest import mark from api.producer.updateDocumentReference.update_document_reference import ( _set_update_time_fields, handler, ) from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.producer.fhir.r4.model import CodeableConcept, Coding, DocumentReference from nrlf.tests.data import load_document_reference from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_update_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) existing_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert existing_doc_pointer is not None existing_doc_ref = DocumentReference.model_validate_json( existing_doc_pointer.document ) assert existing_doc_ref.docStatus == "final" doc_ref.docStatus = "entered-in-error" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_UPDATED", "display": "Resource updated", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The DocumentReference has been updated", } ], } updated_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert updated_doc_pointer is not None updated_doc_ref = DocumentReference.model_validate_json( updated_doc_pointer.document ) assert updated_doc_ref.docStatus == "entered-in-error" assert updated_doc_ref.meta.lastUpdated == "2024-03-21T12:34:56.789Z" assert updated_doc_pointer.updated_on == "2024-03-21T12:34:56.789Z" assert updated_doc_pointer.created_on == existing_doc_pointer.created_on @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_update_document_reference_happy_path_with_ssp( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) existing_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert existing_doc_pointer is not None existing_doc_ref = DocumentReference.model_validate_json( existing_doc_pointer.document ) assert existing_doc_ref.docStatus == "final" doc_ref.docStatus = "entered-in-error" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_UPDATED", "display": "Resource updated", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The DocumentReference has been updated", } ], } updated_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert updated_doc_pointer is not None updated_doc_ref = DocumentReference.model_validate_json( updated_doc_pointer.document ) assert updated_doc_ref.docStatus == "entered-in-error" assert updated_doc_ref.meta.lastUpdated == "2024-03-21T12:34:56.789Z" assert updated_doc_pointer.updated_on == "2024-03-21T12:34:56.789Z" assert updated_doc_pointer.created_on == existing_doc_pointer.created_on def test_create_document_reference_no_body(): event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=None, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "BAD_REQUEST", "display": "Bad request", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body is required", } ], } def test_update_document_reference_invalid_body(): event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body="{}", ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (resourceType: Field required)", "expression": ["resourceType"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (status: Field required)", "expression": ["status"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (type: Field required)", "expression": ["type"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (category: Field required)", "expression": ["category"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (author: Field required)", "expression": ["author"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (content: Field required)", "expression": ["content"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (context: Field required)", "expression": ["context"], }, ], } def test_update_document_reference_with_no_practiceSetting(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.context.practiceSetting = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (context.practiceSetting: Field required)", "expression": ["context.practiceSetting"], }, ], } def test_update_document_reference_no_id_in_path(): doc_ref = load_document_reference("Y05868-736253002-Valid") event = create_test_api_gateway_event( headers=create_headers(), path_parameters={}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "INVALID_PARAMETER", "display": "Invalid parameter", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid path parameter (id: Field required)", "expression": ["id"], } ], } def test_update_document_reference_id_mismatch(): doc_ref = load_document_reference("Y05868-736253002-Valid") event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "IDoNotMatch"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The document id in the path does not match the document id in the body", } ], } def test_update_document_reference_invalid_resource(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.custodian = None event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The required field 'custodian' is missing", "expression": ["custodian"], } ], } def test_update_document_reference_invalid_producer_id(): doc_ref = load_document_reference("Y05868-736253002-Valid") event = create_test_api_gateway_event( headers=create_headers(ods_code="RQI"), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "403", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The id of the provided DocumentReference does not include the expected ODS code for this organisation", } ], } @mock_aws @mock_repository def test_update_document_reference_no_existing_pointer(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "404", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "not-found", "details": { "coding": [ { "code": "NO_RECORD_FOUND", "display": "No record found", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The requested DocumentReference could not be found", } ], } @mock_aws @mock_repository def test_update_document_reference_immutable_fields(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_ref.type = CodeableConcept( coding=[ Coding( system="http://snomed.info/sct", code="861421000000109", display="End of life care coordination summary", ) ], ) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The field 'type' is immutable and cannot be updated", "expression": ["type"], } ], } @mock_aws @mock_repository def test_update_document_reference_cannot_change_status_to_not_current(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_ref.status = "somethingElse" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (status: String should match pattern '^current$')", "expression": ["status"], } ], } @mock_aws @mock_repository def test_update_document_reference_with_no_context_related_for_ssp_url(repository): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) del doc_ref.context.related event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Missing context.related. It must be provided and contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } ], } @mock_aws @mock_repository def test_create_document_reference_with_no_asid_in_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context.related = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/not-an-asid", "value": "some-other-value", } } ] event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Missing ASID identifier. context.related must contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } ], } @mock_aws @mock_repository def test_create_document_reference_with_invalid_asid_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context.related = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "not-a-valid-asid", } } ] event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid ASID value 'not-a-valid-asid'. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[0].identifier.value"], } ], } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_update_document_reference_with_meta_lastupdated_ignored( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-meta-lastupdated") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) existing_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert existing_doc_pointer is not None existing_doc_ref = DocumentReference.model_validate_json( existing_doc_pointer.document ) assert existing_doc_ref.docStatus == "final" doc_ref.docStatus = "entered-in-error" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_UPDATED", "display": "Resource updated", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The DocumentReference has been updated", } ], } updated_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert updated_doc_pointer is not None updated_doc_ref = DocumentReference.model_validate_json( updated_doc_pointer.document ) assert updated_doc_ref.docStatus == "entered-in-error" assert updated_doc_ref.meta.lastUpdated == "2024-03-21T12:34:56.789Z" assert updated_doc_pointer.updated_on == "2024-03-21T12:34:56.789Z" assert updated_doc_pointer.created_on == existing_doc_pointer.created_on @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_update_document_reference_with_invalid_date_ignored( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-date") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) existing_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert existing_doc_pointer is not None existing_doc_ref = DocumentReference.model_validate_json( existing_doc_pointer.document ) assert existing_doc_ref.docStatus == "final" doc_ref.date = "2024-05-04T11:11:10.111Z" doc_ref.docStatus = "entered-in-error" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "200", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_UPDATED", "display": "Resource updated", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The DocumentReference has been updated", } ], } updated_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert updated_doc_pointer is not None updated_doc_ref = DocumentReference.model_validate_json( updated_doc_pointer.document ) assert updated_doc_ref.docStatus == "entered-in-error" assert updated_doc_ref.date == "2024-03-20T00:00:01.000Z" @mock_aws @mock_repository def test_update_document_reference_existing_invalid_json( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) doc_pointer.document = "invalid json" repository.create(doc_pointer) event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "500", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "An error occurred whilst parsing the existing document reference", } ], } @freeze_time("2024-03-25") @mark.parametrize( "doc_ref_name", [ "Y05868-736253002-Valid-with-date", "Y05868-736253002-Valid-with-date-and-meta-lastupdated", ], ) def test__set_update_time_fields(doc_ref_name: str): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference(doc_ref_name) response = _set_update_time_fields(test_time, test_doc_ref) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": test_time, }, "date": test_doc_ref.date, } NRLF-3.0.31/api/producer/updateDocumentReference/update_document_reference.py000066400000000000000000000113741511201605300273030ustar00rootroot00000000000000import urllib.parse from pydantic import ValidationError from nrlf.core.codes import SpineErrorConcept from nrlf.core.decorators import DocumentPointerRepository, request_handler from nrlf.core.dynamodb.model import DocumentPointer from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata, UpdateDocumentReferencePathParams from nrlf.core.response import NRLResponse, Response, SpineErrorResponse from nrlf.core.utils import create_fhir_instant from nrlf.core.validators import DocumentReferenceValidator from nrlf.producer.fhir.r4.model import DocumentReference, Meta def _set_update_time_fields( update_time: str, document_reference: DocumentReference ) -> DocumentReference: """ Set the lastUpdated timestamp on the provided DocumentReference """ if not document_reference.meta: document_reference.meta = Meta() document_reference.meta.lastUpdated = update_time return document_reference @request_handler(body=DocumentReference, path=UpdateDocumentReferencePathParams) def handler( metadata: ConnectionMetadata, repository: DocumentPointerRepository, body: DocumentReference, path: UpdateDocumentReferencePathParams, ) -> Response: """ Entrypoint for the updateDocumentReference function """ logger.log(LogReference.PROUPDATE000) if body.id != path.id: logger.log(LogReference.PROUPDATE001, body_id=body.id, path_id=path.id) return SpineErrorResponse.UNPROCESSABLE_ENTITY( diagnostics="The document id in the path does not match the document id in the body" ) logger.log(LogReference.PROUPDATE002, body=body) validator = DocumentReferenceValidator() result = validator.validate(body) if not result.is_valid: logger.log(LogReference.PROUPDATE003) return Response.from_issues(statusCode="422", issues=result.issues) update_time = create_fhir_instant() document_reference = _set_update_time_fields( update_time, document_reference=result.resource ) core_model = DocumentPointer.from_document_reference(document_reference) if metadata.ods_code != core_model.producer_id: logger.log( LogReference.PROUPDATE004, metadata_ods_code=metadata.ods_code, producer_id=core_model.producer_id, ) return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR( diagnostics="The id of the provided DocumentReference does not include the expected ODS code for this organisation" ) pointer_id = urllib.parse.quote_plus(path.id) if not (existing_model := repository.get_by_id(pointer_id)): logger.log(LogReference.PROUPDATE005, pointer_id=pointer_id) return SpineErrorResponse.NO_RECORD_FOUND( diagnostics="The requested DocumentReference could not be found" ) try: existing_resource = DocumentReference.model_validate_json( existing_model.document ) except ValidationError as exc: logger.log(LogReference.PROUPDATE002, error=exc) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), diagnostics="An error occurred whilst parsing the existing document reference", ) preserved_fields = ["date"] for field in preserved_fields: provided_field = getattr(result.resource, field, None) existing_field = getattr(existing_resource, field, None) if provided_field and provided_field != existing_field: logger.log( LogReference.PROUPDATE007, field=field, provided=provided_field, ) setattr(document_reference, field, existing_field) immutable_fields = [ "masterIdentifier", "id", "identifier", "status", "type", "subject", "custodian", "relatesTo", "author", ] for field in immutable_fields: if getattr(result.resource, field) != getattr(existing_resource, field): logger.log(LogReference.PROUPDATE006, field=field) return SpineErrorResponse.UNPROCESSABLE_ENTITY( diagnostics=f"The field '{field}' is immutable and cannot be updated", expression=field, ) document_pointer_update = DocumentPointer.from_document_reference( document_reference ) document_pointer_update.created_on = existing_model.created_on document_pointer_update.updated_on = update_time repository.update(document_pointer_update) logger.log(LogReference.PROUPDATE999) return NRLResponse.RESOURCE_UPDATED() NRLF-3.0.31/api/producer/upsertDocumentReference/000077500000000000000000000000001511201605300215655ustar00rootroot00000000000000NRLF-3.0.31/api/producer/upsertDocumentReference/tests/000077500000000000000000000000001511201605300227275ustar00rootroot00000000000000NRLF-3.0.31/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py000066400000000000000000001613271511201605300316100ustar00rootroot00000000000000import json from unittest.mock import Mock, patch from freezegun import freeze_time from moto import mock_aws from pytest import mark from api.producer.upsertDocumentReference.upsert_document_reference import ( _set_upsert_time_fields, handler, ) from nrlf.core.constants import PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.producer.fhir.r4.model import ( DocumentReferenceRelatesTo, Identifier, Reference, ) from nrlf.tests.data import load_document_reference, load_document_reference_data from nrlf.tests.dynamodb import mock_repository from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_upsert_document_reference_happy_path(repository: DocumentPointerRepository): doc_ref_data = load_document_reference_data("Y05868-736253002-Valid") event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_upsert_document_reference_happy_path_with_ssp( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data( "Y05868-736253002-Valid-with-ssp-content" ) event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", } @mock_aws @mock_repository def test_upsert_document_reference_cannot_set_status_to_not_current(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_ref.status = "somethingElse" event = create_test_api_gateway_event( headers=create_headers(), path_parameters={"id": "Y05868-99999-99999-999999"}, body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Request body could not be parsed (status: String should match pattern '^current$')", "expression": ["status"], } ], } def test_upsert_document_reference_invalid_category_type(): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.category and doc_ref.category[0].coding doc_ref.category[0].coding[0].code = "1102421000000108" doc_ref.category[0].coding[0].display = "Observations" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The Category code of the provided document 'http://snomed.info/sct|1102421000000108' must match the allowed category for pointer type 'http://snomed.info/sct|736253002' with a category value of 'http://snomed.info/sct|734163000'", "expression": ["category.coding[0].code"], } ], } def test_upsert_document_reference_no_body(): event = create_test_api_gateway_event( headers=create_headers(), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "BAD_REQUEST", "display": "Bad request", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body is required", } ], } def test_upsert_document_reference_invalid_body(): event = create_test_api_gateway_event( headers=create_headers(), body="{}", ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (resourceType: Field required)", "expression": ["resourceType"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (status: Field required)", "expression": ["status"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (type: Field required)", "expression": ["type"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (category: Field required)", "expression": ["category"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (author: Field required)", "expression": ["author"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (content: Field required)", "expression": ["content"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (context: Field required)", "expression": ["context"], }, ], } def test_upsert_document_reference_invalid_resource(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.custodian = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "The required field 'custodian' is missing", "expression": ["custodian"], }, ], } def test_upsert_document_reference_with_no_practiceSetting(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.context.practiceSetting = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (context.practiceSetting: Field required)", "expression": ["context.practiceSetting"], }, ], } def test_upsert_document_reference_with_invalid_docStatus(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.docStatus = "invalid" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (docStatus: Input should be 'entered-in-error', 'amended', 'preliminary' or 'final')", "expression": ["docStatus"], }, ], } def test_upsert_document_reference_invalid_producer_id(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.id = "X26-99999-99999-999999" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The id of the provided DocumentReference does not include the expected ODS code for this organisation", } ], } def test_upsert_document_reference_with_no_custodian(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.custodian = None event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "The required field 'custodian' is missing", "expression": ["custodian"], }, ], } def test_upsert_document_reference_invalid_custodian_id(): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.custodian and doc_ref.custodian.identifier doc_ref.custodian.identifier.value = "X26" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The custodian of the provided DocumentReference does not match the expected ODS code for this organisation", "expression": ["custodian.identifier.value"], } ], } def test_upsert_document_reference_invalid_pointer_type(): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.type and doc_ref.type.coding doc_ref.type.coding[0].code = "invalid" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid type code: invalid Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)", "expression": ["type.coding[0].code"], }, ], } @mock_aws @mock_repository @patch("nrlf.core.decorators.parse_permissions_file") def test_upsert_document_reference_pointer_type_not_allowed( parse_permissions_mock, repository: DocumentPointerRepository ): doc_ref = load_document_reference("Y05868-736253002-Valid") assert doc_ref.type and doc_ref.type.coding event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) parse_permissions_mock.return_value = ["invalid"] result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "403", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The type of the provided DocumentReference is not in the list of allowed types for this organisation", "expression": ["type.coding[0].code"], } ], } def test_upsert_document_reference_no_relatesto_target(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo(code="transforms", target=Reference()) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "400", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ], }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: relatesTo[0].target)", "expression": ["DocumentReference"], } ], } def test_upsert_document_reference_invalid_relatesto_target_producer_id(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="X26-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target identifier value does not include the expected ODS code for this organisation", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_invalid_relatesto_not_exists(repository): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference( identifier=Identifier(value="Y05868-99999-99999-999999"), ), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document does not exist", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_invalid_relatesto_not_exists_still_creates_with_ignore_perm( repository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference( identifier=Identifier(value="Y05868-99999-99999-999999"), ), ) ] event = create_test_api_gateway_event( headers=create_headers( nrl_permissions=[PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL] ), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } @mock_aws @mock_repository def test_upsert_document_reference_invalid_relatesto_nhs_number( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-123456" assert doc_ref.subject and doc_ref.subject.identifier doc_ref.subject.identifier.value = "9999999999" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document NHS number does not match the NHS number in the request", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_invalid_relatesto_type( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-123456" assert doc_ref.type and doc_ref.type.coding doc_ref.type.coding[0].code = "861421000000109" doc_ref.type.coding[0].display = "End of life care coordination summary" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers( app_id="12356", ), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document type does not match the type in the request", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_with_no_context_related_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") del doc_ref.context.related event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Missing context.related. It must be provided and contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_with_no_asid_in_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context.related = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/not-an-asid", "value": "some-other-value", } } ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Missing ASID identifier. context.related must contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_with_invalid_asid_for_ssp_url( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-ssp-content") doc_ref.context.related = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "not-a-valid-asid", } } ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "Invalid ASID value 'not-a-valid-asid'. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[0].identifier.value"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_supersede_deletes_old_pointers_replace( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-111111" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-111111", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_SUPERSEDED", "display": "Resource created and resource(s) deleted", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been superseded by a new version", } ], } old_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert old_doc_pointer is None @mock_aws @mock_repository def test_upsert_document_reference_supersede_succeeds_with_toggle( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") # Add reference to a non-existing pointer doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference(identifier=Identifier(value="Y05868-99999-99999-000000")), ) ] event = create_test_api_gateway_event( headers=create_headers(nrl_permissions=["supersede-ignore-delete-fail"]), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_SUPERSEDED", "display": "Resource created and resource(s) deleted", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been superseded by a new version", } ], } non_existent_pointer = repository.get_by_id("Y05868-99999-99999-000000") assert non_existent_pointer is None @mock_aws @mock_repository def test_upsert_document_reference_supersede_fails_without_toggle( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") # Add reference to a non-existing pointer doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference(identifier=Identifier(value="Y05868-99999-99999-000000")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "422", "headers": default_response_headers(), "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", } ] }, "diagnostics": "The relatesTo target document does not exist", "expression": ["relatesTo[0].target.identifier.value"], } ], } @mock_aws @mock_repository def test_upsert_document_reference_create_relatesto_not_replaces( repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) # Change document ID and NHS number doc_ref.id = "Y05868-99999-99999-111111" doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="transforms", target=Reference(identifier=Identifier(value="Y05868-99999-99999-999999")), ) ] event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-111111", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } old_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert old_doc_pointer is not None @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_upsert_document_reference_with_date_ignored( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data("Y05868-736253002-Valid-with-date") event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_upsert_document_reference_with_date_and_meta_lastupdated_ignored( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data( "Y05868-736253002-Valid-with-date-and-meta-lastupdated" ) event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-21T12:34:56.789Z", } @mock_aws @mock_repository @freeze_time("2024-03-21T12:34:56.789") def test_upsert_document_reference_with_date_overidden( repository: DocumentPointerRepository, ): doc_ref_data = load_document_reference_data("Y05868-736253002-Valid-with-date") event = create_test_api_gateway_event( headers=create_headers(nrl_permissions=["audit-dates-from-payload"]), body=doc_ref_data, ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ], }, "diagnostics": "The document has been created", } ], } created_doc_pointer = repository.get_by_id("Y05868-99999-99999-999999") assert created_doc_pointer is not None assert created_doc_pointer.created_on == "2024-03-21T12:34:56.789Z" assert created_doc_pointer.updated_on is None assert json.loads(created_doc_pointer.document) == { **json.loads(doc_ref_data), "meta": { "lastUpdated": "2024-03-21T12:34:56.789Z", }, "date": "2024-03-20T00:00:01.000Z", } @freeze_time("2024-03-25") @mark.parametrize( "doc_ref_name", [ "Y05868-736253002-Valid", "Y05868-736253002-Valid-with-date", "Y05868-736253002-Valid-with-date-and-meta-lastupdated", ], ) def test__set_create_time_fields(doc_ref_name: str): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference(doc_ref_name) test_perms = [] response = _set_upsert_time_fields(test_time, test_doc_ref, test_perms) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": "2024-03-24T12:34:56.789Z", }, "date": "2024-03-24T12:34:56.789Z", } @freeze_time("2024-03-25") @mark.parametrize( "doc_ref_name", [ "Y05868-736253002-Valid-with-date", "Y05868-736253002-Valid-with-date-and-meta-lastupdated", ], ) def test__set_create_time_fields_when_doc_has_date_and_perms(doc_ref_name: str): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference(doc_ref_name) test_perms = ["audit-dates-from-payload"] response = _set_upsert_time_fields(test_time, test_doc_ref, test_perms) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": test_time, }, "date": test_doc_ref.date, } @freeze_time("2024-03-25") def test__set_create_time_fields_when_no_date_but_perms(): test_time = "2024-03-24T12:34:56.789Z" test_doc_ref = load_document_reference("Y05868-736253002-Valid") test_perms = ["audit-dates-from-payload"] response = _set_upsert_time_fields(test_time, test_doc_ref, test_perms) assert response.model_dump(exclude_none=True) == { **test_doc_ref.model_dump(exclude_none=True), "meta": { "lastUpdated": test_time, }, "date": test_time, } @mock_aws @mock_repository @patch("api.producer.upsertDocumentReference.upsert_document_reference.logger") def test_upsert_logs_for_unexpected_multi_pointer( mock_logger: Mock, repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-736253002-Valid-with-master-id") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_ref.id = "Y05868-99999-99999-999999-02" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999-02", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } assert any( call[0][0].name == "PROUPSERT012" for call in mock_logger.log.call_args_list ) assert { "existing_pointers_count": 1, "nhs_number": ( doc_ref.subject.identifier.value if doc_ref.subject and doc_ref.subject.identifier else None ), "pointer_type": ( f"{doc_ref.type.coding[0].system}|{doc_ref.type.coding[0].code}" if doc_ref.type and doc_ref.type.coding else None ), "custodian": ( doc_ref.custodian.identifier.value if doc_ref.custodian and doc_ref.custodian.identifier else None ), "new_pointer_id": doc_ref.id, "new_pointer_master_id": ( doc_ref.masterIdentifier.value if doc_ref.masterIdentifier else None ), } == [ call[1:][0] for call in mock_logger.log.call_args_list if call[0][0].name == "PROUPSERT012" ][ 0 ] @mock_aws @mock_repository @patch("api.producer.upsertDocumentReference.upsert_document_reference.logger") def test_upsert_logs_for_expected_multi_pointer( mock_logger: Mock, repository: DocumentPointerRepository, ): doc_ref = load_document_reference("Y05868-Appointment-Valid") doc_pointer = DocumentPointer.from_document_reference(doc_ref) repository.create(doc_pointer) doc_ref.id = "Y05868-99999-99999-999999-02" event = create_test_api_gateway_event( headers=create_headers(), body=doc_ref.model_dump_json(exclude_none=True), ) result = handler(event, create_mock_context()) body = result.pop("body") assert result == { "statusCode": "201", "headers": { "Location": "/DocumentReference/Y05868-99999-99999-999999-02", **default_response_headers(), }, "isBase64Encoded": False, } parsed_body = json.loads(body) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "informational", "details": { "coding": [ { "code": "RESOURCE_CREATED", "display": "Resource created", "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", } ] }, "diagnostics": "The document has been created", } ], } assert not any( call[0][0].name == "PROUPSERT012" for call in mock_logger.log.call_args_list ) NRLF-3.0.31/api/producer/upsertDocumentReference/upsert_document_reference.py000066400000000000000000000235061511201605300274030ustar00rootroot00000000000000from nrlf.core.codes import SpineErrorConcept from nrlf.core.constants import ( PERMISSION_AUDIT_DATES_FROM_PAYLOAD, PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL, TYPES_WITH_MULTIPLES, ) from nrlf.core.decorators import request_handler from nrlf.core.dynamodb.repository import DocumentPointer, DocumentPointerRepository from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata from nrlf.core.response import NRLResponse, Response, SpineErrorResponse from nrlf.core.utils import create_fhir_instant from nrlf.core.validators import DocumentReferenceValidator from nrlf.producer.fhir.r4.model import DocumentReference, Meta def _set_upsert_time_fields( upsert_time: str, document_reference: DocumentReference, nrl_permissions: list[str] ) -> DocumentReference: """ Set the date and lastUpdated timestamps on the provided DocumentReference """ if not document_reference.meta: document_reference.meta = Meta() document_reference.meta.lastUpdated = upsert_time if ( document_reference.date and PERMISSION_AUDIT_DATES_FROM_PAYLOAD in nrl_permissions ): # Perserving the original date if it exists and the permission is set logger.log( LogReference.PROUPSERT011, id=document_reference.id, date=document_reference.date, ) else: document_reference.date = upsert_time return document_reference def _create_core_model(resource: DocumentReference, metadata: ConnectionMetadata): """ Create the DocumentPointer model from the provided DocumentReference """ creation_time = create_fhir_instant() document_reference = _set_upsert_time_fields( creation_time, document_reference=resource, nrl_permissions=metadata.nrl_permissions, ) return DocumentPointer.from_document_reference( document_reference, created_on=creation_time ) def _check_permissions( core_model: DocumentPointer, metadata: ConnectionMetadata ) -> Response | None: """ Check the requester has permissions to create the DocumentReference """ if metadata.ods_code != core_model.custodian: logger.log( LogReference.PROUPSERT004, ods_code=metadata.ods_code, custodian=core_model.custodian, ) return SpineErrorResponse.UNPROCESSABLE_ENTITY( diagnostics="The custodian of the provided DocumentReference does not match the expected ODS code for this organisation", expression="custodian.identifier.value", ) if core_model.type not in metadata.pointer_types: logger.log( LogReference.PROUPSERT005, ods_code=metadata.ods_code, type=core_model.type, pointer_types=metadata.pointer_types, ) return SpineErrorResponse.AUTHOR_CREDENTIALS_ERROR( diagnostics="The type of the provided DocumentReference is not in the list of allowed types for this organisation", expression="type.coding[0].code", ) def _get_document_ids_to_supersede( resource: DocumentReference, core_model: DocumentPointer, metadata: ConnectionMetadata, repository: DocumentPointerRepository, can_ignore_delete_fail: bool, ): """ Get the list of document IDs to supersede based on the relatesTo field """ if not resource.relatesTo: return [] logger.log(LogReference.PROUPSERT006, relatesTo=resource.relatesTo) ids_to_delete = [] for idx, relates_to in enumerate(resource.relatesTo): identifier = _validate_identifier(relates_to, idx) _validate_producer_id(identifier, metadata, idx) if can_ignore_delete_fail: logger.log( LogReference.PROUPSERT006a, pointer_id=resource.id, relatesTo=resource.relatesTo, ) else: existing_pointer = _check_existing_pointer(identifier, repository, idx) _validate_pointer_details(existing_pointer, core_model, identifier, idx) _append_id_if_replaces(relates_to, ids_to_delete, identifier) return ids_to_delete def _validate_identifier(relates_to, idx): """ Validate that there is a identifier in relatesTo target """ identifier = getattr(relates_to.target.identifier, "value", None) if not identifier: logger.log(LogReference.PROUPSERT007a) _raise_operation_outcome_error( "No identifier value provided for relatesTo target", idx ) return identifier def _validate_producer_id(identifier, metadata, idx): """ Validate that there is an ODS code in the relatesTo target identifier """ producer_id = identifier.split("-", 1)[0] if metadata.ods_code != producer_id: logger.log( LogReference.PROUPSERT007b, related_identifier=identifier, ods_code=metadata.ods_code, ) _raise_operation_outcome_error( "The relatesTo target identifier value does not include the expected ODS code for this organisation", idx, ) def _check_existing_pointer(identifier, repository, idx): """ Check that there is an existing pointer that will be deleted when superseding """ existing_pointer = repository.get_by_id(identifier) if not existing_pointer: logger.log(LogReference.PROUPSERT007c, related_identifier=identifier) _raise_operation_outcome_error( "The relatesTo target document does not exist", idx ) return existing_pointer def _validate_pointer_details(existing_pointer, core_model, identifier, idx): """ Validate that the nhs numbers and type matches between the existing pointer and the requested one. """ if existing_pointer.nhs_number != core_model.nhs_number: logger.log(LogReference.PROUPSERT007d, related_identifier=identifier) _raise_operation_outcome_error( "The relatesTo target document NHS number does not match the NHS number in the request", idx, ) if existing_pointer.type != core_model.type: logger.log(LogReference.PROUPSERT007e, related_identifier=identifier) _raise_operation_outcome_error( "The relatesTo target document type does not match the type in the request", idx, ) def _append_id_if_replaces(relates_to, ids_to_delete, identifier): """ Append pointer ID if the if the relatesTo code is 'replaces' """ if relates_to.code == "replaces": logger.log( LogReference.PROUPSERT008, relates_to_code=relates_to.code, identifier=identifier, ) ids_to_delete.append(identifier) def _raise_operation_outcome_error(diagnostics, idx): """ General function to raise an operation outcome error """ raise OperationOutcomeError( severity="error", code="business-rule", details=SpineErrorConcept.from_code("UNPROCESSABLE_ENTITY"), diagnostics=diagnostics, expression=[f"relatesTo[{idx}].target.identifier.value"], status_code="422", ) @request_handler(body=DocumentReference) def handler( metadata: ConnectionMetadata, repository: DocumentPointerRepository, body: DocumentReference, ) -> Response: """ Entrypoint for the upsertDocumentReference function """ logger.log(LogReference.PROUPSERT000) logger.log(LogReference.PROUPSERT001, resource=body) validator = DocumentReferenceValidator() result = validator.validate(body) if not result.is_valid: logger.log(LogReference.PROUPSERT002) return Response.from_issues(issues=result.issues, statusCode="422") core_model = _create_core_model(result.resource, metadata) if metadata.ods_code != core_model.producer_id: logger.log( LogReference.PROUPSERT003, ods_code=metadata.ods_code, producer_id=core_model.producer_id, ) return SpineErrorResponse.UNPROCESSABLE_ENTITY( diagnostics="The id of the provided DocumentReference does not include the expected ODS code for this organisation" ) if error_response := _check_permissions(core_model, metadata): return error_response can_ignore_delete_fail = ( PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL in metadata.nrl_permissions ) if ids_to_delete := _get_document_ids_to_supersede( result.resource, core_model, metadata, repository, can_ignore_delete_fail ): logger.log( LogReference.PROUPSERT010, pointer_id=result.resource.id, ids_to_delete=ids_to_delete, can_ignore_delete_fail=can_ignore_delete_fail, ) saved_model = repository.supersede( core_model, ids_to_delete, can_ignore_delete_fail ) logger.log(LogReference.PROUPSERT999) return NRLResponse.RESOURCE_SUPERSEDED(resource_id=saved_model.id) pointer_type = core_model.type if pointer_type not in TYPES_WITH_MULTIPLES: nhs_number = core_model.nhs_number existing_pointers_count = repository.count_by_nhs_number( nhs_number, [pointer_type] ) if existing_pointers_count > 0: logger.log( LogReference.PROUPSERT012, new_pointer_id=core_model.id, new_pointer_master_id=core_model.master_identifier, pointer_type=pointer_type, nhs_number=nhs_number, custodian=core_model.custodian, existing_pointers_count=existing_pointers_count, ) logger.log(LogReference.PROUPSERT009, pointer_id=result.resource.id) saved_model = repository.create(core_model) logger.log(LogReference.PROUPSERT999) return NRLResponse.RESOURCE_CREATED(resource_id=saved_model.id) NRLF-3.0.31/behave.ini000066400000000000000000000002041511201605300142600ustar00rootroot00000000000000[behave] # Add the Allure formatter and output directory format = allure_behave.formatter:AllureFormatter outfiles = allure-results NRLF-3.0.31/changelog/000077500000000000000000000000001511201605300142605ustar00rootroot00000000000000NRLF-3.0.31/changelog/2023-04-25.md000066400000000000000000000001641511201605300156360ustar00rootroot00000000000000- Multiple End-User organisations support - Logging improvements - Build improvements - Authentication improvements NRLF-3.0.31/changelog/2023-04-30.md000066400000000000000000000002441511201605300156310ustar00rootroot00000000000000- Fix Count End Point has incorrect parameters - Fix URL in prod smoke tests - Create operation should fail when id(part after '-') has blank or special characters NRLF-3.0.31/changelog/2023-05-02.md000066400000000000000000000001241511201605300156260ustar00rootroot00000000000000Security enhancements: - Deletion protection on DynamoDB - Dependabot improvements NRLF-3.0.31/changelog/2023-05-03.md000066400000000000000000000001541511201605300156320ustar00rootroot00000000000000- Firehose error alerts - Superseding of created_on and when caller has permission audit-dates-from-payload NRLF-3.0.31/changelog/2023-05-10.md000066400000000000000000000000761511201605300156330ustar00rootroot00000000000000- Supersede will not fail on delete for data sync permissions NRLF-3.0.31/changelog/2023-05-11.md000066400000000000000000000001731511201605300156320ustar00rootroot00000000000000- Changes to the onboarding documents - Changed the duplicateError to return a 409 instead of 400 - Syncing supersede date NRLF-3.0.31/changelog/2023-05-15.md000066400000000000000000000000401511201605300156270ustar00rootroot00000000000000- Optimisation of status lambda NRLF-3.0.31/changelog/2023-05-30.md000066400000000000000000000002201511201605300156240ustar00rootroot00000000000000- NRLF-535 - New count endpoint - NRLF-543 - type.code feature tests - NRLF-424 - Remove ASID from swagger - NRLF-482 - Make ID immutable field NRLF-3.0.31/changelog/2023-06-13.md000066400000000000000000000000361511201605300156330ustar00rootroot00000000000000- NRLF-578-dependabot changes NRLF-3.0.31/changelog/2023-06-14.md000066400000000000000000000003051511201605300156330ustar00rootroot00000000000000- NRLF-505 - RDS instance, cluster and other terraform and lambda changes for MI/BI - NRLF-517 - smoke tests that cover the NRL sync functionality - NRLF-550 - Corrections to the ASID system value NRLF-3.0.31/changelog/2023-06-20.md000066400000000000000000000001531511201605300156310ustar00rootroot00000000000000- NRLF-522 - errors section in narrative - NRLF-584 - dependabot changes - NRLF-564 - strip empty elements NRLF-3.0.31/changelog/2023-06-23.md000066400000000000000000000006551511201605300156430ustar00rootroot00000000000000- Authoriser parses headers for authorization into the "request context" to be used by API lambdas - S3 bucket implemented for authorization lookup where nrl.enable-authorisation-lookup has been set - All API lambdas read the authorisation from the event "request context" instead of the event headers - (in nrl-producer-api repo) Update producer apigee proxy to optionally use enable-authorisation-lookup instead of nrl-ods-XXX NRLF-3.0.31/changelog/2023-06-29.md000066400000000000000000000000551511201605300156430ustar00rootroot00000000000000- Remove double hyphen from RDS cluster name NRLF-3.0.31/changelog/2023-06-30.md000066400000000000000000000003051511201605300156310ustar00rootroot00000000000000- Fix Count End Point has incorrect parameters (NRLF-577) - Fix URL in prod smoke tests (NRLF-614) - Create operation should fail when id(part after '-') has blank or special characters (NRLF-494) NRLF-3.0.31/changelog/2023-07-06.md000066400000000000000000000003161511201605300156370ustar00rootroot00000000000000- NRLF 559 - author is included in set of immutable fields - NRLF 492 - Use latest change log for release tag - NRLF 610 - dependabot changes - NRLF 616 - Added feature test for fully populated NRL pointer NRLF-3.0.31/changelog/2023-07-11a.md000066400000000000000000000001161511201605300157720ustar00rootroot00000000000000- NRLF-605 - Update Readme - NRLF-506 - [MI/BI] DB schema and querying the DB NRLF-3.0.31/changelog/2023-07-19.md000066400000000000000000000006241511201605300156450ustar00rootroot00000000000000- NRLF-586 - Consolidate and publish CHANGELOG.md - NRLF-460 - Merge steps for search, searchPost and count - NRLF-599 - SSO - NRLF-620 - Update the IAM-developer role for mgmt to allow them to call test secrets (done within NRLF-599 branch) - NRLF-624 - Dependabot part 4 - More updates from the dependabot sorting and merging - NRLF-627 - The release tag creation mechanism needs to use changelog file NRLF-3.0.31/changelog/2023-07-27.md000066400000000000000000000003061511201605300156410ustar00rootroot00000000000000- NRLF-526 - CIS2 - NRLF-560 - JSON Schema / Data contracts - NRLF-640 - Add changelog details to narrative - NRLF-650 - Dependabot updates - NRLF-651 - Converter tests - NRLF-655 - Tag/release fix NRLF-3.0.31/changelog/2023-08-03a.md000066400000000000000000000004051511201605300157750ustar00rootroot00000000000000- NRLF-491 - Implement int-sandbox splunk environment - NRLF-525 - Add versioning to firehose S3 bucket - NRLF-529 - ASDF Tool manager - NRLF-613 - Increase lambda memory size - NRLF-638 - Can create documents with contact details - NRLF-658 - Consumer S3 Auth NRLF-3.0.31/changelog/2023-08-14.md000066400000000000000000000011711511201605300156370ustar00rootroot00000000000000- NRLF-533 - 409 Conflict error not thrown on duplicate supersede request - NRLF-585 - Add Live URLs to API Catalogue - NRLF-652 - Producer MI - Add infrastructure for dynamodb streams - NRLF-561 - Build an ASID specific document contract - NRLF-634 - Helper script to create Data Contracts - NRLF-642 - Update converter to v0.0.8 in NRLF repository - NRLF-652 - Fix forward: Remove tags from security groups associations - NRLF-561 - Fix forward: Fix ASID url - NRLF-634 - Fix forward: Fix intermittent deploy contract test - NRLF-494 - Fix forward: Revert changes introduced by NRLF-494, due to being too restrictive for converter NRLF-3.0.31/changelog/2023-08-16.md000066400000000000000000000001101511201605300156310ustar00rootroot00000000000000- NRLF-561 - Fix forward: Add missing NEWS2 document type data contract NRLF-3.0.31/changelog/2023-08-21.md000066400000000000000000000002751511201605300156410ustar00rootroot00000000000000- NRLF-669 - Changelog now uses rendered markdown - NRLF-653 - Producer MI - Create data model and insert into database - NRLF-583 - Remove 'newman' from APIGEE proxies (APIGEE repos only) NRLF-3.0.31/changelog/2023-08-29.md000066400000000000000000000011031511201605300156400ustar00rootroot00000000000000- NRLF-563 - 64L Sort fields that should be treated as Sets, not ordered Lists - NRLF-675 - MI dead letters, resubmission and alerting - NRLF-683 - MI Documentation and reports - NRLF-689 - Update NRLF 1D Converter to v0.0.9 - Dependabot updates: - pydantic (1.10.10 -> 1.10.12) - boto3 (1.26.165 -> 1.28.30) - cryptography (41.0.1 -> 41.0.3) - awscli (1.27.165 -> 1.29.30) - datamodel-code-generator (0.21.2 -> 0.21.4) - cookiecutter (2.2.3 -> 2.3.0) - atlassian-python-api (3.39.0 -> 3.41.0) - hypothesis (6.82.0 -> 6.82.6) - more-itertools (9.1.0 -> 10.1.0) NRLF-3.0.31/changelog/2023-09-06.md000066400000000000000000000006751511201605300156510ustar00rootroot00000000000000- NRLF-644 - Add missing "Errors" to swagger response in Consumer. - NRLF-646 - Add missing "Errors" to swagger response in Producer. - NRLF-663 - Add Open Source section to Producer/Consumer Narrative - NRLF-693 - Sonarcube Fixes - NRLF-682 - Remove documentation from CI - NRLF-698 - Fix Forward: 4XX isn’t valid in API Gateway - NRLF-582 - (APIGEE) 64L CORS issue with "TRY" Section in API Catalogue - NRLF-690 - (APIGEE) Update dependency NRLF-3.0.31/changelog/2023-09-13.md000066400000000000000000000002021511201605300156310ustar00rootroot00000000000000- NRLF-696 - BUG: MI report date range - NRLF-697 - Enhancement: MI Max Year - NRLF-702 - Add Postman Collection to API Catalogue NRLF-3.0.31/changelog/2023-09-21.md000066400000000000000000000003551511201605300156410ustar00rootroot00000000000000- SPINECLI-1190 - Add link to postman collection in narrative - NRLF-691 - Amend Document Type used in NRLF Smoke Test to clearly identify as Test-Only in MI Reports - SPINECLI-1043 - 403 when x-correlation-id or x-request-id is missing NRLF-3.0.31/changelog/2023-10-09.md000066400000000000000000000002361511201605300156350ustar00rootroot00000000000000- SPINECLI-1090 - Update NRLF Readme with WSL and Powershell Instructions - SPINECLI-1619 - Change the readme - updated section on Reporting to add more info NRLF-3.0.31/changelog/2023-10-26.md000066400000000000000000000001241511201605300156300ustar00rootroot00000000000000- SPINECLI-1611 - Create sonar-project.properties file for SonarCloud configuration NRLF-3.0.31/changelog/2024-01-09.md000066400000000000000000000005611511201605300156370ustar00rootroot00000000000000- NRLF-657 Add workspace destroy and unlock commands - SPINECLI-1665 Add asid-check data contract for the new pointer type Lloyd george - NRLF-708 Fix sonarcloud security hotspot changes - SPINECLI-1704 add checks and cleanup to contract integration tests - NRL-445 Add Allure reports - SPINECLI-1666 Documentation Updates - SPINECLI-1774 Fix integration test failures NRLF-3.0.31/changelog/2024-02-08.md000066400000000000000000000000671511201605300156400ustar00rootroot00000000000000- SPINECLI-1795 Add open source links to documentation NRLF-3.0.31/changelog/2024-03-14.md000066400000000000000000000002171511201605300156330ustar00rootroot00000000000000- NRL-511 - Capability statements - NRL-496 - Update Format code system URL - NRL-521 - Port (duplicate) POST functionality to PUT Interaction NRLF-3.0.31/changelog/scripts/000077500000000000000000000000001511201605300157475ustar00rootroot00000000000000NRLF-3.0.31/changelog/scripts/changelog-pre-commit.sh000077500000000000000000000010521511201605300223050ustar00rootroot00000000000000#!/bin/bash branch=$(git symbolic-ref --short HEAD) if [[ "${branch}" == *"release/"* ]]; then result=`python ./changelog/scripts/changelog.py $branch` if [[ "${result}" == "CHANGELOG.md updated." ]]; then echo "SUCCESS: CHANGELOG.md was out of date and has now been updated. Please re-commit." exit 1 elif [[ "${result}" == "No matching changelog for release branch." ]]; then echo "FAILURE: You must create a change log to match the release branch." exit 1 else exit 0 fi else exit 0 fi NRLF-3.0.31/changelog/scripts/changelog.py000066400000000000000000000026251511201605300202550ustar00rootroot00000000000000import sys from os import listdir from os.path import getsize, isfile, join def main(argv): if "release/" in argv[0]: file_list = sorted( [f for f in listdir("./changelog") if isfile(join("./changelog", f))] ) file_list.reverse() latest_file = file_list[0].replace(".md", "") release_date = argv[0].replace("release/", "") if latest_file != release_date: print("No matching changelog for release branch.") sys.exit(0) else: data = "# Changelog\n\n" for i, v in enumerate(file_list): data = data + "## " + v.replace(".md", "") + "\n\n" with open(f"./changelog/{v}", "r") as f: data = data + f.read() if i != (len(file_list) - 1): data = data + "\n" try: original_size = getsize("./CHANGELOG.md") except OSError: original_size = 0 with open("./CHANGELOG.md", "w") as f: f.write(data) new_size = getsize("./CHANGELOG.md") if new_size != original_size: print("CHANGELOG.md updated.") sys.exit(0) print("CHANGELOG.md, No changes.") sys.exit(0) print("Not a release branch") sys.exit(0) if __name__ == "__main__": main(sys.argv[1:]) NRLF-3.0.31/layer/000077500000000000000000000000001511201605300134455ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/000077500000000000000000000000001511201605300144065ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/__init__.py000066400000000000000000000000001511201605300165050ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/consumer/000077500000000000000000000000001511201605300162415ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/consumer/fhir/000077500000000000000000000000001511201605300171715ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/consumer/fhir/r4/000077500000000000000000000000001511201605300175165ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/consumer/fhir/r4/model.py000066400000000000000000001300311511201605300211660ustar00rootroot00000000000000# generated by datamodel-codegen: # filename: swagger.yaml # timestamp: 2025-09-12T10:25:30+00:00 from __future__ import annotations from typing import Annotated, List, Literal, Optional, Union from pydantic import Field, RootModel from nrlf.core.parent_model import Parent class LocationItem(RootModel[str]): root: Annotated[ str, Field( description='This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.', pattern="[ \\r\\n\\t\\S]+", ), ] class ExpressionItem(RootModel[str]): root: Annotated[ str, Field( description="A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.", pattern="[ \\r\\n\\t\\S]+", ), ] class BundleEntryRequest(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None method: Annotated[ str, Field( description="In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] url: Annotated[ str, Field( description="The URL for this entry, relative to the root (the address to which the request is posted).", pattern="\\S*", ), ] ifNoneMatch: Annotated[ Optional[str], Field( description='If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).', pattern="[ \\r\\n\\t\\S]+", ), ] = None ifModifiedSince: Annotated[ Optional[str], Field( description='Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).', pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None ifMatch: Annotated[ Optional[str], Field( description='Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).', pattern="[ \\r\\n\\t\\S]+", ), ] = None ifNoneExist: Annotated[ Optional[str], Field( description='Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL – what follows the "?" (not including the "?").', pattern="[ \\r\\n\\t\\S]+", ), ] = None class BundleEntrySearch(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None mode: Annotated[ Optional[str], Field( description="Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None score: Annotated[ Optional[float], Field( description="When searching, the server's search ranking score for the entry." ), ] = None class BundleLink(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None relation: Annotated[ str, Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1).", pattern="[ \\r\\n\\t\\S]+", ), ] url: Annotated[ str, Field(description="The reference details for the link.", pattern="\\S*") ] class Attachment(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None contentType: Annotated[ str, Field( description="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] language: Annotated[ Optional[str], Field( description="The human language of the content. The value can be any valid value according to BCP 47.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None data: Annotated[ Optional[str], Field( description="The actual data of the attachment – a sequence of bytes, base64 encoded.", pattern="(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+", ), ] = None url: Annotated[ str, Field(description="A location where the data can be accessed.", pattern="\\S*"), ] size: Annotated[ Optional[int], Field( description="The number of bytes of data that make up this attachment (before base64 encoding, if that is done)." ), ] = None hash: Annotated[ Optional[str], Field( description="The calculated hash of the data using SHA–1. Represented using base64.", pattern="(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+", ), ] = None title: Annotated[ Optional[str], Field( description="A label or set of text to display in place of the data.", pattern="[ \\r\\n\\t\\S]+", ), ] = None creation: Annotated[ Optional[str], Field( description="The date that the attachment was first created.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", ), ] = None class Coding(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None system: Annotated[ Optional[str], Field( description="The identification of the code system that defines the meaning of the symbol in the code.", pattern="\\S*", ), ] = None version: Annotated[ Optional[str], Field( description="The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", pattern="[ \\r\\n\\t\\S]+", ), ] = None code: Annotated[ Optional[str], Field( description="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination).", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None display: Annotated[ Optional[str], Field( description="A representation of the meaning of the code in the system, following the rules of the system.", pattern="[ \\r\\n\\t\\S]+", ), ] = None userSelected: Annotated[ Optional[bool], Field( description="Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)." ), ] = None class ContentStabilityExtensionCoding(Coding): system: Literal[ "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability" ] code: Literal["static", "dynamic"] display: Literal["Static", "Dynamic"] class NRLRetrievalMechanismExtensionCoding(Coding): system: Literal[ "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism" ] code: Literal["SSP", "Direct", "LDR", "InContext"] display: Literal[ "Spine Secure Proxy", "Direct", "Large Document Retrieval", "Direct using In-Context", ] class NRLFormatCode(Coding): system: Annotated[ Literal["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"], Field(description="The system URL for the NRLF Format Code."), ] code: Annotated[ Literal[ "urn:nhs-ic:record-contact", "urn:nhs-ic:unstructured", "urn:nhs-ic:structured", ], Field(description="The code representing the format of the document."), ] display: Annotated[ Literal[ "Contact details (HTTP Unsecured)", "Unstructured Document", "Structured Document", ], Field(description="The display text for the code."), ] class Period(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None start: Annotated[ Optional[str], Field( description="The start of the period. The boundary is inclusive.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", ), ] = None end: Annotated[ Optional[str], Field( description="The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", ), ] = None class Quantity(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None value: Annotated[ Optional[float], Field( description="The value of the measured amount. The value includes an implicit precision in the presentation of the value." ), ] = None comparator: Annotated[ Optional[str], Field( description='How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.', pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None unit: Annotated[ Optional[str], Field( description="A human–readable form of the unit.", pattern="[ \\r\\n\\t\\S]+", ), ] = None system: Annotated[ Optional[str], Field( description="The identification of the system that provides the coded form of the unit.", pattern="\\S*", ), ] = None code: Annotated[ Optional[str], Field( description="A computer processable form of the unit in some unit representation system.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None class ProfileItem(RootModel[str]): root: Annotated[ str, Field( description="A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url).", pattern="\\S*", ), ] class Meta(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None versionId: Annotated[ Optional[str], Field( description="The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None lastUpdated: Annotated[ Optional[str], Field( description="When the resource last changed – e.g. when the version changed.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None source: Annotated[ Optional[str], Field( description="A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.", pattern="\\S*", ), ] = None profile: Optional[List[ProfileItem]] = None security: Optional[List[Coding]] = None tag: Optional[List[Coding]] = None class Narrative(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None status: Annotated[ str, Field( description="The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] div: Annotated[ str, Field( description="The actual narrative content, a stripped down version of XHTML." ), ] class DocumentId(RootModel[str]): root: Annotated[str, Field(pattern="[A-Za-z0-9\\-\\.]{1,64}")] class RequestPathParams(Parent): id: DocumentId class RequestQuerySubject(RootModel[str]): root: Annotated[ str, Field( examples=["https://fhir.nhs.uk/Id/nhs-number|4409815415"], pattern="^https\\:\\/\\/fhir\\.nhs\\.uk\\/Id\\/nhs-number\\|(\\d+)$", ), ] class RequestQueryCustodian(RootModel[str]): root: Annotated[ str, Field( examples=["https://fhir.nhs.uk/Id/ods-organization-code|Y05868"], pattern="^https\\:\\/\\/fhir\\.nhs\\.uk\\/Id\\/ods-organization-code\\|(\\w+)$", ), ] class RequestQueryType(RootModel[str]): root: Annotated[str, Field(examples=["http://snomed.info/sct|736253002"])] class RequestQueryCategory(RootModel[str]): root: Annotated[str, Field(examples=["http://snomed.info/sct|103693007"])] class RequestQuerySummary(RootModel[str]): root: Annotated[str, Field(examples=["count"])] class NextPageToken(RootModel[str]): root: str class RequestHeaderOdsCode(RootModel[str]): root: str class RequestHeaderOrganisationExtensionCode(RootModel[str]): root: str class RequestHeaderRequestId(RootModel[str]): root: Annotated[ str, Field( examples=["60E0B220-8136-4CA5-AE46-1D97EF59D068"], pattern="^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", ), ] class RequestHeaderCorrelationId(RootModel[str]): root: Annotated[str, Field(examples=["11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"])] class CodeableConcept(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None coding: Optional[List[Coding]] = None text: Annotated[ Optional[str], Field( description="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", pattern="[ \\r\\n\\t\\S]+", ), ] = None class Extension(Parent): valueCodeableConcept: Annotated[ Optional[CodeableConcept], Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1)." ), ] = None url: Annotated[ Optional[str], Field(description="The reference details for the link.", pattern="\\S*"), ] = None class ContentStabilityExtensionValueCodeableConcept(CodeableConcept): coding: Annotated[ List[ContentStabilityExtensionCoding], Field(max_length=1, min_length=1) ] class NRLRetrievalMechanismExtensionValueCodeableConcept(CodeableConcept): coding: Annotated[ List[NRLRetrievalMechanismExtensionCoding], Field(max_length=1, min_length=1) ] class RequestHeader(Parent): odsCode: RequestHeaderOdsCode class RequestParams(Parent): subject_identifier: Annotated[ RequestQuerySubject, Field(alias="subject:identifier") ] custodian_identifier: Annotated[ Optional[RequestQueryCustodian], Field(alias="custodian:identifier") ] = None type: Optional[RequestQueryType] = None category: Optional[RequestQueryCategory] = None field_summary: Annotated[Optional[RequestQuerySummary], Field(alias="_summary")] = ( None ) next_page_token: Annotated[ Optional[NextPageToken], Field(alias="next-page-token") ] = None class CountRequestParams(Parent): subject_identifier: Annotated[ RequestQuerySubject, Field(alias="subject:identifier") ] class OperationOutcomeIssue(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None severity: Annotated[ str, Field( description="Indicates whether the issue indicates a variation from successful processing.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] code: Annotated[ str, Field( description="Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] details: Annotated[ Optional[CodeableConcept], Field( description="Additional details about the error. This may be a text description of the error or a system code that identifies the error." ), ] = None diagnostics: Annotated[ Optional[str], Field( description="Additional diagnostic information about the issue.", pattern="[ \\r\\n\\t\\S]+", ), ] = None location: Optional[List[LocationItem]] = None expression: Optional[List[ExpressionItem]] = None class ContentStabilityExtension(Extension): url: Literal[ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" ] valueCodeableConcept: ContentStabilityExtensionValueCodeableConcept class NRLRetrievalMechanismExtension(Extension): url: Literal[ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" ] valueCodeableConcept: NRLRetrievalMechanismExtensionValueCodeableConcept class OperationOutcome(Parent): resourceType: Literal["OperationOutcome"] id: Annotated[ Optional[str], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[str], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", pattern="\\S*", ), ] = None language: Annotated[ Optional[str], Field( description="The base language in which the resource is written.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None text: Annotated[ Optional[Narrative], Field( description='A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' ), ] = None issue: Annotated[List[OperationOutcomeIssue], Field(min_length=1)] class DocumentReferenceContent(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None attachment: Annotated[ Attachment, Field( description="The document or URL of the document along with critical metadata to prove content has integrity." ), ] format: Annotated[ NRLFormatCode, Field( description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." ), ] extension: Annotated[ List[ Union[ContentStabilityExtension, NRLRetrievalMechanismExtension, Extension] ], Field(min_length=1), ] class DocumentReference(Parent): resourceType: Literal["DocumentReference"] id: Annotated[ Optional[str], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[str], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", pattern="\\S*", ), ] = None language: Annotated[ Optional[str], Field( description="The base language in which the resource is written.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None text: Annotated[ Optional[Narrative], Field( description='A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' ), ] = None masterIdentifier: Annotated[ Optional[Identifier], Field( description="Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document." ), ] = None identifier: Optional[List[Identifier]] = None status: Annotated[ str, Field( description="The status of this document reference.", pattern="^current$" ), ] docStatus: Annotated[ Optional[Literal["entered-in-error", "amended", "preliminary", "final"]], Field(description="The status of the underlying document."), ] = None type: Annotated[ Optional[CodeableConcept], Field( description="Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced." ), ] = None category: Optional[List[CodeableConcept]] = None subject: Annotated[ Optional[Reference], Field( description="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)." ), ] = None date: Annotated[ Optional[str], Field( description="When the document reference was created.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None author: Optional[List[Reference]] = None authenticator: Annotated[ Optional[Reference], Field( description="Which person or organization authenticates that this document is valid." ), ] = None custodian: Annotated[ Optional[Reference], Field( description="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document." ), ] = None relatesTo: Optional[List[DocumentReferenceRelatesTo]] = None description: Annotated[ Optional[str], Field( description="Human–readable description of the source document.", pattern="[ \\r\\n\\t\\S]+", ), ] = None securityLabel: Optional[List[CodeableConcept]] = None content: Annotated[List[DocumentReferenceContent], Field(min_length=1)] context: Annotated[ Optional[DocumentReferenceContext], Field(description="The clinical context in which the document was prepared."), ] = None class Bundle(Parent): resourceType: Literal["Bundle"] id: Annotated[ Optional[str], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[str], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", pattern="\\S*", ), ] = None language: Annotated[ Optional[str], Field( description="The base language in which the resource is written.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None identifier: Annotated[ Optional[Identifier], Field( description="A persistent identifier for the bundle that won't change as a bundle is copied from server to server." ), ] = None type: Annotated[ str, Field( description="Indicates the purpose of this bundle – how it is intended to be used.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] timestamp: Annotated[ Optional[str], Field( description="The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None total: Annotated[ Optional[int], Field( description="If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle." ), ] = None link: Optional[List[BundleLink]] = None entry: Optional[List[BundleEntry]] = None signature: Annotated[ Optional[Signature], Field( description="Digital Signature – base64 encoded. XML–DSig or a JWT." ), ] = None class BundleEntry(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None link: Optional[List[BundleLink]] = None fullUrl: Annotated[ Optional[str], Field( description="The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", pattern="\\S*", ), ] = None resource: Annotated[ Optional[Union[DocumentReference, OperationOutcome]], Field( description="The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type." ), ] = None search: Annotated[ Optional[BundleEntrySearch], Field( description="Information about the search process that lead to the creation of this entry." ), ] = None request: Annotated[ Optional[BundleEntryRequest], Field( description="Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry." ), ] = None response: Annotated[ Optional[BundleEntryResponse], Field( description="Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history." ), ] = None class BundleEntryResponse(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None status: Annotated[ str, Field( description="The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", pattern="[ \\r\\n\\t\\S]+", ), ] location: Annotated[ Optional[str], Field( description="The location header created by processing this operation, populated if the operation returns a location.", pattern="\\S*", ), ] = None etag: Annotated[ Optional[str], Field( description="The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", pattern="[ \\r\\n\\t\\S]+", ), ] = None lastModified: Annotated[ Optional[str], Field( description="The date/time that the resource was modified on the server.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None outcome: Annotated[ Optional[DocumentReference], Field( description="An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction." ), ] = None class DocumentReferenceContext(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None encounter: Optional[List[Reference]] = None event: Optional[List[CodeableConcept]] = None period: Annotated[ Optional[Period], Field( description="The time period over which the service that is described by the document was provided." ), ] = None facilityType: Annotated[ Optional[CodeableConcept], Field(description="The kind of facility where the patient was seen."), ] = None practiceSetting: Annotated[ CodeableConcept, Field( description="This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty." ), ] sourcePatientInfo: Annotated[ Optional[Reference], Field( description="The Patient Information as known when the document was published. May be a reference to a version specific, or contained." ), ] = None related: Optional[List[Reference]] = None class DocumentReferenceRelatesTo(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None code: Annotated[ str, Field( description="The type of relationship that this document has with anther document.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] target: Annotated[ Reference, Field(description="The target document of this relationship.") ] class Identifier(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None use: Annotated[ Optional[str], Field( description="The purpose of this identifier.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None type: Annotated[ Optional[CodeableConcept], Field( description="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." ), ] = None system: Annotated[ Optional[str], Field( description="Establishes the namespace for the value – that is, a URL that describes a set values that are unique.", pattern="\\S*", ), ] = None value: Annotated[ Optional[str], Field( description="The portion of the identifier typically relevant to the user and which is unique within the context of the system.", pattern="[ \\r\\n\\t\\S]+", ), ] = None period: Annotated[ Optional[Period], Field(description="Time period during which identifier is/was valid for use."), ] = None assigner: Annotated[ Optional[Reference], Field(description="Organization that issued/manages the identifier."), ] = None class Reference(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None reference: Annotated[ Optional[str], Field( description="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", pattern="[ \\r\\n\\t\\S]+", ), ] = None type: Annotated[ Optional[str], Field( description='The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).', pattern="\\S*", ), ] = None identifier: Annotated[ Optional[Identifier], Field( description="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." ), ] = None display: Annotated[ Optional[str], Field( description="Plain text narrative that identifies the resource in addition to the resource reference.", pattern="[ \\r\\n\\t\\S]+", ), ] = None class Signature(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None type: Annotated[List[Coding], Field(min_length=1)] when: Annotated[ str, Field( description="When the digital signature was signed.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] who: Annotated[ Reference, Field( description="A reference to an application–usable description of the identity that signed (e.g. the signature used their private key)." ), ] onBehalfOf: Annotated[ Optional[Reference], Field( description="A reference to an application–usable description of the identity that is represented by the signature." ), ] = None targetFormat: Annotated[ Optional[str], Field( description="A mime type that indicates the technical format of the target resources signed by the signature.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None sigFormat: Annotated[ Optional[str], Field( description="A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None data: Annotated[ Optional[str], Field( description="The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.", pattern="(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+", ), ] = None DocumentReference.model_rebuild() Bundle.model_rebuild() BundleEntry.model_rebuild() DocumentReferenceContext.model_rebuild() DocumentReferenceRelatesTo.model_rebuild() Identifier.model_rebuild() NRLF-3.0.31/layer/nrlf/core/000077500000000000000000000000001511201605300153365ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/core/authoriser.py000066400000000000000000000043371511201605300201040ustar00rootroot00000000000000import json import sys from os import path from botocore.exceptions import ClientError from nrlf.core.boto import get_s3_client from nrlf.core.config import Config from nrlf.core.logger import LogReference, logger from nrlf.core.model import ConnectionMetadata def get_pointer_types( connection_metadata: ConnectionMetadata, config: Config ) -> list[str]: ods_code = ".".join(connection_metadata.ods_code) app_id = connection_metadata.nrl_app_id ods_code = connection_metadata.ods_code key = f"{app_id}/{ods_code}.json" logger.log(LogReference.S3PERMISSIONS001, bucket=config.AUTH_STORE, key=key) s3_client = get_s3_client() try: response = s3_client.get_object(Bucket=config.AUTH_STORE, Key=key) pointer_types = json.loads(response["Body"].read()) logger.log(LogReference.S3PERMISSIONS002, pointer_types=pointer_types) return pointer_types except ClientError as exc: if exc.response.get("Error", {}).get("Code") == "NoSuchKey": logger.log(LogReference.S3PERMISSIONS003, error=str(exc)) return [] logger.log( LogReference.S3PERMISSIONS004, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise exc except Exception as exc: logger.log( LogReference.S3PERMISSIONS004, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise exc def parse_permissions_file( connection_metadata: ConnectionMetadata, ) -> list[str]: ods_code = ".".join(connection_metadata.ods_code) app_id = connection_metadata.nrl_app_id ods_code = connection_metadata.ods_code key = f"{app_id}/{ods_code}.json" file_path = f"/opt/python/nrlf_permissions/{key}" if connection_metadata.is_test_event: file_path = path.abspath(f"layer/test_permissions/{key}") pointer_types = [] try: with open(file_path) as file: pointer_types = json.load(file) except Exception as exc: logger.log( LogReference.S3PERMISSIONS005, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) return pointer_types NRLF-3.0.31/layer/nrlf/core/boto.py000066400000000000000000000011401511201605300166470ustar00rootroot00000000000000import functools import boto3 from nrlf.core.types import DynamoDBServiceResource, S3Client @functools.cache def get_boto3_client(service_name: str): return boto3.client(service_name) # type: ignore @functools.cache def get_boto3_resource(service_name: str): return boto3.resource(service_name) # type: ignore def get_dynamodb_resource() -> DynamoDBServiceResource: return get_boto3_resource("dynamodb") @functools.cache def get_dynamodb_table(table_name: str): return get_dynamodb_resource().Table(table_name) def get_s3_client() -> S3Client: return get_boto3_client("s3") NRLF-3.0.31/layer/nrlf/core/codes.py000066400000000000000000000042421511201605300170070ustar00rootroot00000000000000from typing import ClassVar from nrlf.consumer.fhir.r4 import model as consumer_model from nrlf.producer.fhir.r4 import model as producer_model class _CodeableConcept(producer_model.CodeableConcept, consumer_model.CodeableConcept): # type: ignore """ Represents a codeable concept with a mapping of codes to text values. """ _TEXT_MAP: ClassVar[dict[str, str]] = {} _SYSTEM: ClassVar[str] = "" @classmethod def from_code(cls, code: str) -> "_CodeableConcept": """ Creates a CodeableConcept instance from a given code. """ if code not in cls._TEXT_MAP: raise ValueError(f"Unknown code: {code}") return cls( coding=[ producer_model.Coding( system=cls._SYSTEM, code=code, display=cls._TEXT_MAP[code], ) ] ) class NRLResponseConcept(_CodeableConcept): _SYSTEM = "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode" _TEXT_MAP = { "RESOURCE_CREATED": "Resource created", "RESOURCE_SUPERSEDED": "Resource created and resource(s) deleted", "RESOURCE_UPDATED": "Resource updated", "RESOURCE_DELETED": "Resource deleted", } class SpineErrorConcept(_CodeableConcept): _SYSTEM = "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode" _TEXT_MAP = { "ACCESS DENIED": "Access has been denied to process this request", "NO_RECORD_FOUND": "No record found", "INVALID_NHS_NUMBER": "Invalid NHS number", "INVALID_CODE_SYSTEM": "Invalid code system", "INTERNAL_SERVER_ERROR": "Unexpected internal server error", "BAD_REQUEST": "Bad request", "AUTHOR_CREDENTIALS_ERROR": "Author credentials error", "DUPLICATE_REJECTED": "Create would lead to creation of a duplicate resource", "INVALID_PARAMETER": "Invalid parameter", "MESSAGE_NOT_WELL_FORMED": "Message not well formed", "MISSING_OR_INVALID_HEADER": "There is a required header missing or invalid", "INVALID_IDENTIFIER_VALUE": "Invalid identifier value", "UNPROCESSABLE_ENTITY": "Unprocessable Entity", } NRLF-3.0.31/layer/nrlf/core/config.py000066400000000000000000000015051511201605300171560ustar00rootroot00000000000000from pydantic import Field from pydantic_settings import BaseSettings class Config(BaseSettings): """ The Config class defines all the Environment Variables that are needed for the business logic to execute successfully. All Environment Variables are validated using pydantic, and will result in a 500 Internal Server Error if validation fails. To add a new Environment Variable simply add a new pydantic compatible definition below, and pydantic should allow for even complex validation logic to be supported. """ AWS_REGION: str = Field(default=...) PREFIX: str = Field(default=...) ENVIRONMENT: str = Field(default=...) SPLUNK_INDEX: str = Field(default=...) SOURCE: str = Field(default=...) AUTH_STORE: str = Field(default=...) TABLE_NAME: str = Field(default=...) NRLF-3.0.31/layer/nrlf/core/constants.py000066400000000000000000000771271511201605300177420ustar00rootroot00000000000000from enum import Enum class Source(Enum): NRLF = "NRLF" LEGACY = "NRL" VALID_SOURCES = frozenset(item.value for item in Source.__members__.values()) EMPTY_VALUES = ("", None, [], {}) REQUIRED_CREATE_FIELDS = [ "custodian", "id", "type", "status", "subject", "category", "author", ] JSON_TYPES = {dict, list} NHS_NUMBER_INDEX = "idx_nhs_number_by_id" ID_SEPARATOR = "-" CUSTODIAN_SEPARATOR = "." TYPE_SEPARATOR = "|" KEY_SEPARATOR = "#" ODS_SYSTEM = "https://fhir.nhs.uk/Id/ods-organization-code" NHS_NUMBER_SYSTEM_URL = "https://fhir.nhs.uk/Id/nhs-number" SNOMED_SYSTEM_URL = "http://snomed.info/sct" RELATES_TO_REPLACES = "replaces" ALLOWED_RELATES_TO_CODES = { RELATES_TO_REPLACES, "transforms", "signs", "appends", "incorporates", "summarizes", } CLIENT_RP_DETAILS = "nhsd-client-rp-details" CONNECTION_METADATA = "nhsd-connection-metadata" PERMISSION_AUDIT_DATES_FROM_PAYLOAD = "audit-dates-from-payload" PERMISSION_SUPERSEDE_IGNORE_DELETE_FAIL = "supersede-ignore-delete-fail" PERMISSION_ALLOW_ALL_POINTER_TYPES = "allow-all-pointer-types" NHSD_REQUEST_ID_HEADER = "NHSD-Request-Id" NHSD_CORRELATION_ID_HEADER = "NHSD-Correlation-Id" X_REQUEST_ID_HEADER = "X-Request-Id" X_CORRELATION_ID_HEADER = "X-Correlation-Id" PRODUCER_URL_PATH = "/DocumentReference" class PointerTypes(Enum): MENTAL_HEALTH_PLAN = "http://snomed.info/sct|736253002" EMERGENCY_HEALTHCARE_PLAN = "http://snomed.info/sct|887701000000100" EOL_COORDINATION_SUMMARY = "http://snomed.info/sct|861421000000109" RESPECT_FORM = "http://snomed.info/sct|1382601000000107" NEWS2_CHART = "http://snomed.info/sct|1363501000000100" CONTINGENCY_PLAN = "http://snomed.info/sct|325691000000100" EOL_CARE_PLAN = "http://snomed.info/sct|736373009" LLOYD_GEORGE_FOLDER = "http://snomed.info/sct|16521000000101" ADVANCE_CARE_PLAN = "http://snomed.info/sct|736366004" TREATMENT_ESCALATION_PLAN = "http://snomed.info/sct|735324008" SUMMARY_RECORD = "http://snomed.info/sct|824321000000109" PERSONALISED_CARE_AND_SUPPORT_PLAN = "http://snomed.info/sct|2181441000000107" MRA_UPPER_LIMB_ARTERY = "https://nicip.nhs.uk|MAULR" MRI_AXILLA_BOTH = "https://nicip.nhs.uk|MAXIB" APPOINTMENT = "http://snomed.info/sct|749001000000101" SHARED_CARE_RECORD = "http://snomed.info/sct|887181000000106" @staticmethod def list(): return list(map(lambda type: type.value, PointerTypes)) def coding_system(self): return self.value.split(TYPE_SEPARATOR)[0] def coding_value(self): return self.value.split(TYPE_SEPARATOR)[1] class Categories(Enum): CARE_PLAN = "http://snomed.info/sct|734163000" OBSERVATIONS = "http://snomed.info/sct|1102421000000108" CLINICAL_NOTE = "http://snomed.info/sct|823651000000106" DIAGNOSTIC_STUDIES_REPORT = "http://snomed.info/sct|721981007" DIAGNOSTIC_PROCEDURE = "http://snomed.info/sct|103693007" RECORD_ARTIFACT = "http://snomed.info/sct|419891008" RECORD_HEADINGS = "http://snomed.info/sct|716931000000107" @staticmethod def list(): return list(map(lambda category: category.value, Categories)) def coding_system(self): return self.value.split(TYPE_SEPARATOR)[0] def coding_value(self): return self.value.split(TYPE_SEPARATOR)[1] CATEGORY_ATTRIBUTES = { Categories.CARE_PLAN.value: { "display": "Care plan", }, Categories.OBSERVATIONS.value: { "display": "Observations", }, Categories.CLINICAL_NOTE.value: { "display": "Clinical note", }, Categories.DIAGNOSTIC_STUDIES_REPORT.value: { "display": "Diagnostic studies report", }, Categories.DIAGNOSTIC_PROCEDURE.value: { "display": "Diagnostic procedure", }, Categories.RECORD_ARTIFACT.value: {"display": "Record artifact"}, Categories.RECORD_HEADINGS.value: {"display": "Record headings"}, } TYPE_ATTRIBUTES = { PointerTypes.MENTAL_HEALTH_PLAN.value: { "display": "Mental health crisis plan", }, PointerTypes.EMERGENCY_HEALTHCARE_PLAN.value: { "display": "Emergency health care plan", }, PointerTypes.EOL_COORDINATION_SUMMARY.value: { "display": "End of life care coordination summary", }, PointerTypes.RESPECT_FORM.value: { "display": "ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form", }, PointerTypes.NEWS2_CHART.value: { "display": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart", }, PointerTypes.CONTINGENCY_PLAN.value: { "display": "Contingency plan", }, PointerTypes.EOL_CARE_PLAN.value: { "display": "End of life care plan", }, PointerTypes.LLOYD_GEORGE_FOLDER.value: { "display": "Lloyd George record folder", }, PointerTypes.ADVANCE_CARE_PLAN.value: { "display": "Advance care plan", }, PointerTypes.TREATMENT_ESCALATION_PLAN.value: { "display": "Treatment escalation plan", }, PointerTypes.SUMMARY_RECORD.value: { "display": "Summary record", }, PointerTypes.PERSONALISED_CARE_AND_SUPPORT_PLAN.value: { "display": "Personalised Care and Support Plan", }, PointerTypes.MRA_UPPER_LIMB_ARTERY.value: { "display": "MRA Upper Limb Rt", }, PointerTypes.MRI_AXILLA_BOTH.value: { "display": "MRI Axilla Both", }, PointerTypes.APPOINTMENT.value: { "display": "Appointment", }, PointerTypes.SHARED_CARE_RECORD.value: {"display": "Clinical summary"}, } TYPE_CATEGORIES = { # # Care plans PointerTypes.MENTAL_HEALTH_PLAN.value: Categories.CARE_PLAN.value, PointerTypes.EMERGENCY_HEALTHCARE_PLAN.value: Categories.CARE_PLAN.value, PointerTypes.EOL_COORDINATION_SUMMARY.value: Categories.CARE_PLAN.value, PointerTypes.RESPECT_FORM.value: Categories.CARE_PLAN.value, PointerTypes.CONTINGENCY_PLAN.value: Categories.CARE_PLAN.value, PointerTypes.EOL_CARE_PLAN.value: Categories.CARE_PLAN.value, PointerTypes.LLOYD_GEORGE_FOLDER.value: Categories.CARE_PLAN.value, PointerTypes.ADVANCE_CARE_PLAN.value: Categories.CARE_PLAN.value, PointerTypes.TREATMENT_ESCALATION_PLAN.value: Categories.CARE_PLAN.value, PointerTypes.PERSONALISED_CARE_AND_SUPPORT_PLAN.value: Categories.CARE_PLAN.value, # # Observations PointerTypes.NEWS2_CHART.value: Categories.OBSERVATIONS.value, # # Clinical notes PointerTypes.SUMMARY_RECORD.value: Categories.CLINICAL_NOTE.value, # # Imaging PointerTypes.MRA_UPPER_LIMB_ARTERY.value: Categories.DIAGNOSTIC_STUDIES_REPORT.value, PointerTypes.MRI_AXILLA_BOTH.value: Categories.DIAGNOSTIC_PROCEDURE.value, # # Bookings and Referrals PointerTypes.APPOINTMENT.value: Categories.RECORD_ARTIFACT.value, # # Shared Care Records PointerTypes.SHARED_CARE_RECORD.value: Categories.RECORD_HEADINGS.value, } # # Pointer types that can have multiple pointers for a single patient TYPES_WITH_MULTIPLES = [ PointerTypes.MRA_UPPER_LIMB_ARTERY.value, PointerTypes.MRI_AXILLA_BOTH.value, PointerTypes.APPOINTMENT.value, ] PRACTICE_SETTING_VALUE_SET_URL = ( "https://fhir.nhs.uk/England/ValueSet/England-PracticeSetting" ) SNOMED_PRACTICE_SETTINGS = { "2471000175109": "Employee health service", "828331000000102": "Homeopathy service", "893041000000108": "Transient ischaemic attack service", "893391000000101": "Adult cystic fibrosis service", "828811000000104": "Child psychiatry service", "741073001": "Neonatal intensive care service", "3801000175108": "Pediatric pulmonology service", "893521000000108": "Respiratory physiology service", "892801000000107": "Audiological medicine service", "892571000000101": "Medical oncology service", "893421000000107": "Tropical medicine service", "1060971000000108": "General practice service", "907271000000106": "Genetics laboratory service", "224891009": "Healthcare services", "893771000000104": "Paediatric respiratory medicine service", "893591000000106": "Paediatric metabolic disease service", "892771000000109": "Cardiothoracic transplantation service", "92151000000102": "Mental health crisis resolution team", "893141000000109": "Nephrology service", "829981000000108": "Community child health service", "733459009": "Cardiac rehabilitation service", "893971000000101": "Paediatric burns care service", "931851000000100": "Oral pathology service", "3771000175106": "Pediatric gastroenterology service", "893621000000109": "Paediatric ear nose and throat service", "828281000000107": "Eating disorders service", "893121000000102": "Spinal surgery service", "892751000000100": "Clinical immunology and allergy service", "893601000000100": "Paediatric medical oncology service", "3751000175100": "Pediatric emergency medical service", "893951000000105": "Paediatric cardiology service", "931831000000107": "Oral medicine service", "829961000000104": "Out of hours service", "911381000000108": "Telehealthcare service", "828181000000101": "Community sexual and reproductive health", "2451000175103": "Perinatology service", "893851000000100": "Paediatric neurosurgery service", "109201000000109": "Substance misuse team", "893671000000108": "Paediatric urology service", "932271000000104": "Oral and maxillofacial surgery service", "444933003": "Home hospice service", "444913002": "Diabetes mellitus service", "892601000000108": "Intermediate care service", "893801000000101": "Paediatric ophthalmology service", "911231000000103": "Remote health monitoring service", "893091000000103": "Infectious diseases service", "893221000000106": "Specialist rehabilitation service", "828381000000103": "Well woman service", "907301000000109": "National Health Service 111 service", "828511000000102": "National Health Service 24", "893701000000107": "Paediatric thoracic surgery service", "828861000000102": "Programmed pulmonary rehabilitation service", "931781000000102": "Acute medicine service", "827641000000101": "Anticoagulant service", "893201000000102": "Sport and exercise medicine service", "278032008": "Preventive service", "892731000000107": "Dental medicine service", "893451000000102": "Respite care service", "2351000175106": "Sports medicine service", "893271000000105": "Medical virology service", "708168004": "Mental health service", "708169007": "Respiratory therapy service", "708171007": "Vascular ultrasound service", "708170008": "Nursing service", "708173005": "Obstetric ultrasound service", "708172000": "Cardiac ultrasound service", "708175003": "Diagnostic imaging service", "708178001": "Cytogenetics service", "708174004": "Interventional radiology service", "708179009": "Molecular pathology service", "708183009": "Anatomic pathology service", "708182004": "Histology service", "708180007": "Dermatopathology service", "708187005": "Surgical pathology service", "708185002": "Virology service", "708184003": "Clinical pathology service", "708188000": "Serology service", "708194008": "Blood bank service", "708196005": "Hematology service", "708191000": "Toxicology service", "708190004": "Immunology service", "708193002": "Coagulation service", "89301000000108": "Community mental health team", "893301000000108": "Local specialist rehabilitation service", "893651000000104": "Paediatric clinical immunology and allergy service", "893171000000103": "Clinical neurophysiology service", "711332004": "Allergy service", "893151000000107": "Nuclear medicine service", "894001000000107": "Paediatric audiological medicine service", "892781000000106": "Burns care service", "3781000175109": "Pediatric infectious disease service", "893631000000106": "Paediatric diabetic medicine service", "827621000000108": "Addiction service", "893531000000105": "Psychiatric intensive care service", "893881000000106": "Paediatric maxillofacial surgery service", "893051000000106": "Clinical allergy service", "893351000000109": "Complex specialised rehabilitation service", "893001000000105": "Clinical genetics service", "908981000000101": "Remote triage and advice service", "931811000000104": "Histopathology service", "1079481000000104": "Perinatal psychiatry service", "893251000000101": "Mental health recovery and rehabilitation service", "3531000175102": "Geriatric service", "736622005": "Aboriginal health service", "983641000000106": "Fracture liaison service", "893711000000109": "Neonatal critical care service", "828521000000108": "National Health Service Direct", "892761000000102": "Clinical haematology service", "901221000000102": "Perinatal mental health service", "706902008": "Mycology service", "706901001": "Bacteriology service", "706903003": "Mycobacteriology service", "706900000": "Parasitology service", "893131000000100": "Genitourinary medicine service", "413294000": "Community health services", "413299005": "Early years services", "828291000000109": "Dispensing optometry service", "413331009": "Voluntary services", "61831000000105": "Periodontics service", "893231000000108": "Podiatric surgery service", "893581000000109": "Well baby service", "893911000000106": "Paediatric gastrointestinal surgery service", "395104009": "Cancer primary healthcare multidisciplinary team", "892711000000104": "Gynaecological oncology service", "893331000000102": "Dementia assessment service", "892611000000105": "Hepatology service", "893681000000105": "Paediatric trauma and orthopaedics service", "395086005": "Community specialist palliative care", "395092004": "Specialist palliative care", "710028007": "Maxillofacial surgery service", "892811000000109": "Adult mental health service", "828821000000105": "Adolescent psychiatry service", "983341000000102": "Pharmacy First service", "893431000000109": "Trauma and orthopaedics service", "893781000000102": "Paediatric plastic surgery service", "892581000000104": "Learning disability service", "893661000000101": "Paediatric clinical haematology service", "893311000000105": "Haemophilia service", "373654008": "Medical referral service", "893081000000100": "Respiratory medicine service", "911221000000100": "Remote care environment monitoring service", "409971007": "Emergency medical services", "828371000000100": "Well man service", "963151000000104": "Diabetic medicine service", "893761000000106": "Paediatric rheumatology service", "932841000000106": "Public health dentistry service", "893861000000102": "Paediatric neurodisability service", "92191000000105": "Early intervention in psychosis team", "722424008": "Physical medicine and rehabilitation service", "89311000000105": "Crisis prevention assessment and treatment team", "722393008": "Legal medicine service", "722352000": "Vascular medicine service", "722170006": "Chiropractic service", "722174002": "Pulmonary medicine service", "722175001": "Psychosomatic medicine service", "722176000": "Dentistry service", "722140001": "Physiotherapy service", "892561000000108": "Medical ophthalmology service", "714088003": "Midwifery service", "714089006": "Community midwifery service", "3761000175103": "Pediatric endocrinology service", "893611000000103": "Paediatric epilepsy service", "893961000000108": "Paediatric cardiac surgery service", "931841000000103": "Oral microbiology service", "91901000000109": "Assertive outreach team", "828191000000104": "Dental hygiene service", "893031000000104": "Clinical immunology service", "893381000000103": "Clinical psychology service", "2461000175101": "Pulmonary rehabilitation service", "893161000000105": "Neurology service", "828201000000102": "Dental surgery assistance service", "1079491000000102": "Paediatric diabetes service", "893261000000103": "Mental health dual diagnosis service", "310031001": "Family planning service", "310032008": "Intensive care service", "310030000": "Endoscopy service", "310034009": "Pediatric intensive care service", "310033003": "Adult intensive care service", "310025004": "Complementary therapy service", "310024000": "Colposcopy service", "310027007": "Mental health counseling service", "310026003": "Counseling service", "310029005": "Domiciliary visit service", "310028002": "Diagnostic investigation service", "310020009": "Hearing therapy service", "310022001": "Clinical oncology service", "310021008": "Assistive listening device service", "310023006": "Radiotherapy service", "310017001": "Pediatric hearing aid service", "310016005": "Adult hearing aid service", "310015009": "Hearing aid service", "310014008": "Pediatric cochlear implant service", "310013002": "Adult cochlear implant service", "310012007": "Cochlear implant service", "310011000": "Aural rehabilitation service", "310010004": "Distraction test audiological screening service", "310019003": "Tinnitus management service", "310018006": "Speech-reading training service", "310001007": "Anesthetic service", "310000008": "Accident and Emergency service", "310003005": "Child assessment service", "310002000": "Assessment service", "310008001": "Audiological screening service", "310009009": "Neonatal audiological screening service", "310005003": "Diagnostic audiology service", "310004004": "Audiological service", "310007006": "Pediatric diagnostic audiology service", "310006002": "Adult diagnostic audiology service", "310085001": "Drama therapy service", "310086000": "Music therapy service", "310083008": "Art therapy service", "310082003": "Arts therapy services", "310084002": "Dance therapy service", "310089007": "Hospital-based podiatry service", "310087009": "Podiatry service", "310088004": "Community-based podiatry service", "310080006": "Pharmacy service", "310081005": "Professional allied to medicine service", "310079008": "Neuropathology service", "310078000": "Medical microbiology service", "310071006": "Pain management service", "310070007": "Special care baby service", "310072004": "Acute pain service", "310073009": "Palliative care service", "310076001": "Clinical biochemistry service", "310074003": "Pathology service", "310064001": "Occupational health service", "310063007": "Obstetrics service", "310066004": "Pediatric service", "310065000": "Open access service", "310068003": "Pediatric neurology service", "310067008": "Community pediatric service", "310069006": "Pediatric oncology service", "310061009": "Gynecology service", "310062002": "Pregnancy termination service", "310060005": "Obstetrics and gynecology service", "310099002": "Child physiotherapy service", "310098005": "Hospital-based physiotherapy service", "310091004": "Community-based dietetics service", "310090003": "Dietetics service", "310096009": "Hospital-based occupational therapy service", "310094007": "Community-based occupational therapy service", "310095008": "Social services occupational therapy service", "310093001": "Occupational therapy service", "310092006": "Hospital-based dietetics service", "310120006": "Mental handicap psychiatry service", "310121005": "Psychogeriatric service", "310126000": "Breast screening service", "310128004": "Computerized tomography service", "310127009": "Magnetic resonance imaging service", "310129007": "Rehabilitation service", "310122003": "Rehabilitation psychiatry service", "310123008": "Psychology service", "310124002": "Psychotherapy service", "310125001": "Radiology service", "310117003": "Child and adolescent psychiatry service", "310116007": "Psychiatry service", "310119000": "Liaison psychiatry service", "310118008": "Forensic psychiatry service", "310114005": "Community surgical fitting service", "310112009": "Surgical fitting service", "310115006": "Public health service", "310113004": "Hospital surgical fitting service", "310110001": "Hospital orthotics service", "310111002": "Community orthotics service", "310109006": "Orthotics service", "310108003": "Community orthoptics service", "310105000": "Optometry service", "310107008": "Hospital orthoptics service", "310106004": "Orthoptics service", "310104001": "Child speech and language therapy service", "310103007": "Hospital-based speech and language therapy service", "310102002": "Community-based speech and language therapy service", "310141000": "Thoracic surgery service", "310143002": "Dental surgery service", "310142007": "Cardiac surgery service", "310144008": "General dental surgery service", "310145009": "Oral surgery service", "310146005": "Orthodontics service", "310147001": "Pediatric dentistry service", "310148006": "Restorative dentistry service", "310149003": "Ear, nose and throat service", "310140004": "Cardiothoracic surgery service", "310131003": "Community rehabilitation service", "310130002": "Head injury rehabilitation service", "310134006": "Social services", "310135007": "Social services department customer services", "310132005": "Young disabled service", "310133000": "Swallow clinic", "310139001": "Breast surgery service", "310138009": "Surgical service", "310136008": "Social services department duty team", "310137004": "Stroke service", "310101009": "Speech and language therapy service", "310100005": "Play therapy service", "734862008": "Endodontic service", "734863003": "Prosthodontic service", "310168000": "Vascular surgery service", "310169008": "Ultrasonography service", "310165002": "Transplant surgery service", "310167005": "Urology service", "310166001": "Trauma surgery service", "310163009": "Pediatric surgical service", "310164003": "Plastic surgery service", "310161006": "Orthopedic service", "310162004": "Pancreatic surgery service", "310160007": "Ophthalmology service", "310151004": "Gastrointestinal surgery service", "310152006": "General gastrointestinal surgery service", "310153001": "Upper gastrointestinal surgery service", "310155008": "Colorectal surgery service", "310150003": "Endocrine surgery service", "310157000": "Hand surgery service", "310156009": "General surgical service", "310159002": "Neurosurgical service", "310158005": "Hepatobiliary surgical service", "828301000000108": "Electrocardiography service", "310200001": "Cytology service", "734920002": "Diabetes mellitus education service", "829951000000102": "Industrial therapy service", "931821000000105": "School nursing service", "893941000000107": "Paediatric dermatology service", "892741000000103": "Clinical microbiology service", "893211000000100": "Spinal injuries service", "92221000000103": "Mental health home treatment team", "3621000175101": "Rheumatology service", "408451000": "Community learning disabilities team", "408452007": "Behavioral intervention team", "408458006": "Specialist multidisciplinary team", "893341000000106": "Congenital heart disease service", "445449000": "Acute care hospice service", "1078501000000104": "Health visiting service", "893691000000107": "Paediatric transplantation surgery service", "892621000000104": "Hepatobiliary and pancreatic surgery service", "2421000175108": "Acute care inpatient service", "931801000000101": "Community nursing service", "699478002": "Surgical oncology service", "893791000000100": "Paediatric pain management service", "893541000000101": "Prosthetics service", "699650006": "Community based physiotherapy service", "893891000000108": "Paediatric interventional radiology service", "827631000000105": "Emergency ambulance service", "827981000000103": "Paediatric cystic fibrosis service", "892821000000103": "Critical care medicine service", "700435004": "Clinical physiology service", "700436003": "Clinical pharmacology service", "700434000": "Endocrinology service", "700221004": "Care of elderly service", "700433006": "Gastroenterology service", "700231006": "Critical care physician service", "700232004": "General medical service", "700241009": "Dermatology service", "893061000000109": "Cardiology service", "705150003": "Domiciliary physiotherapy service", "932241000000105": "Blood banking and transfusion service", "3791000175107": "Pediatric nephrology service", "892791000000108": "Blood and marrow transplantation service", "893641000000102": "Palliative medicine service", "431051000124102": "Dialysis service", "23951000087100": "Opioid dependence service", "1323651000000109": "Cardiac physiology service", "788126001": "Prosthetic service", "788124003": "Histopathology service", "788125002": "Addiction service", "788123009": "Radiation oncology service", "788122004": "Sexual health service", "788128000": "Critical care medicine service", "788127005": "Child health service", "788121006": "Clinical immunology and allergy service", "733921009": "Transplant medicine service", "788001008": "Infectious disease service", "788002001": "Adult mental health service", "788003006": "Nephrology service", "788009005": "Nuclear medicine service", "788006003": "Genetic laboratory service", "788004000": "Clinical genetics service", "788005004": "Neurology service", "788008002": "Oral and maxillofacial surgery service", "788007007": "General practice service", "1326391000000100": "FNP (Family Nurse Partnership) service", "1186717003": "Intellectual disability psychiatry service", "830149003": "Clinical neurophysiology service", "224930009": "Services", "830039004": "Genitourinary medicine service", "830038007": "Clinical allergy service", "830037002": "Clinical immunology service", "1326421000000106": "Safeguarding children team", "1323551000000105": "Inherited metabolic medicine service", "28541000087101": "Musculoskeletal service", "24271000087103": "Adult chronic pain management service", "1240241000000109": "Community sexual and reproductive health service", "897188002": "Pediatric hematology service", "1323631000000102": "Aviation and space medicine service", "1325831000000100": "Post-COVID-19 syndrome service", "1323431000000104": "Fetal medicine service", "24001000087103": "Paediatric plastic surgery service", "24351000087104": "Paediatric chronic pain management service", "1323881000000102": "Stroke medicine service", "1323531000000103": "Urological physiology service", "148621000000100": "School aged immunisation service", "24101000087102": "HIV (human immunodeficiency virus) social work service", "23911000087104": "Medication review service", "1148679005": "Specialist palliative care service", "773558007": "Physical medicine service", "24051000087102": "Breast surgical oncology service", "896974005": "Transgender health service", "1323611000000105": "Paediatric inherited metabolic medicine service", "1323661000000107": "Paediatric audiovestibular medicine service", "24331000087108": "Narcotic addiction service with chronic pain management", "1323561000000108": "Gastrointestinal physiology service", "34911000087100": "Amputation care service", "1231786003": "Refugee healthcare service", "1163002007": "Electrocardiography service", "1163004008": "Hyperbaric medicine service", "1163003002": "Colorectal cancer screening service", "1323841000000105": "Paediatric palliative medicine service", "1163054002": "Gastroscopy service", "1231392007": "Paediatric orthopaedic service", "1231391000": "Colonoscopy service", "1231393002": "Spirometry service", "1231390004": "Hand therapy service", "1231394008": "Paediatric urology service", "24081000087105": "HIV (human immunodeficiency virus) nurse practitioner service", "23941000087103": "Narcotic addiction service", "1323641000000106": "Audiovestibular medicine service", "840587001": "Aerospace medical service", "840586005": "Neonatal service", "840585009": "Postnatal service", "816075004": "Prosthetic and orthotic service", "1323921000000108": "Neuropsychiatry service", "24011000087101": "Vascular imaging service", "1323691000000101": "General internal medical service", "23891000087102": "Adult hematology service", "1323821000000103": "Paediatric clinical pharmacology service", "789718008": "Cardiology service", "789714005": "Pediatric rheumatology service", "789715006": "Paediatric respiratory therapy service", "789716007": "Pediatric otolaryngology service", "789717003": "Paediatric cardiology service", "148581000000100": "Personal health record provider service", "792849008": "Pediatric clinical genetics service", "792847005": "Emergency ambulance service", "792848000": "Internal medicine service", "1323621000000104": "Medical psychotherapy service", "1323871000000104": "Rehabilitation medicine service", "1230046007": "Cervical cancer screening service", "1230045006": "Cardiac diagnostic service", "1230044005": "Cardiac specialist nursing service", "1362761000000103": "Adult safeguarding team", "1323901000000104": "Rare disease service", "1136421000168109": "Sleep medicine service", "1323701000000101": "Vascular physiology service", "24141000087104": "Spine orthopedic surgery service", "1323571000000101": "Orthogeriatric medicine service", "1323801000000107": "Paediatric oral and maxillofacial surgery service", "23871000087101": "Adult dermatology service", "1323601000000108": "Ophthalmic and vision science service", "1234796008": "Community nursing service", "23901000087101": "Hepatology service", "1324191000000107": "Intensive care medicine service", "2391000175104": "Bariatric surgery service", "1323851000000108": "Paediatric hepatology service", "24291000087104": "Geriatric chronic pain management service", "1323501000000109": "Special care dentistry service", "1423561000000102": "Acute oncology service", "394802001": "General medicine", } SYSTEM_SHORT_IDS = {"http://snomed.info/sct": "SCT", "https://nicip.nhs.uk": "NICIP"} CONTENT_STABILITY_EXTENSION_URL = ( "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" ) CONTENT_RETRIEVAL_EXTENSION_URL = "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" CONTENT_STABILITY_SYSTEM_URL = ( "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability" ) CONTENT_RETRIEVAL_SYSTEM_URL = ( "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism" ) CONTENT_RETRIEVAL_CODE_MAP = { "Direct": "Direct", "SSP": "Spine Secure Proxy", "LDR": "Large Document Retrieval", "InContext": "Direct using In-Context", } CONTENT_FORMAT_CODE_URL = "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode" CONTENT_FORMAT_CODE_MAP = { "urn:nhs-ic:record-contact": "Contact details (HTTP Unsecured)", "urn:nhs-ic:unstructured": "Unstructured Document", "urn:nhs-ic:structured": "Structured Document", } ATTACHMENT_CONTENT_TYPES = { "application/pdf", "text/html", "application/json", "application/fhir+json", "application/json+fhir", } NRLF-3.0.31/layer/nrlf/core/decorators.py000066400000000000000000000264431511201605300200660ustar00rootroot00000000000000import functools import inspect import sys import warnings from typing import Any, Callable, Dict, Optional, Type, Union from aws_lambda_powertools.utilities.data_classes import ( APIGatewayProxyEvent, event_source, ) from aws_lambda_powertools.utilities.typing import LambdaContext from pydantic import BaseModel from nrlf.core.authoriser import get_pointer_types, parse_permissions_file from nrlf.core.codes import SpineErrorConcept from nrlf.core.config import Config from nrlf.core.constants import ( NHSD_CORRELATION_ID_HEADER, PERMISSION_ALLOW_ALL_POINTER_TYPES, X_CORRELATION_ID_HEADER, X_REQUEST_ID_HEADER, PointerTypes, ) from nrlf.core.dynamodb.repository import DocumentPointerRepository from nrlf.core.errors import OperationOutcomeError, ParseError from nrlf.core.logger import LogReference, logger from nrlf.core.request import parse_body, parse_headers, parse_params, parse_path from nrlf.core.response import Response RequestHandler = Callable[..., Response] def error_handler( wrapped_func: Callable[..., Dict[str, Any]], ) -> Callable[..., Dict[str, Any]]: """ Wraps the function in a try/except block and logs any unhandled exceptions """ def wrapper(*args, **kwargs) -> Dict[str, Any]: try: return wrapped_func(*args, **kwargs) except OperationOutcomeError as exc: response = exc.response.model_dump(exclude_none=True) logger.log(LogReference.ERROR001, error=str(exc), response=response) return response except ParseError as exc: response = exc.response.model_dump(exclude_none=True) logger.log(LogReference.ERROR002, error=str(exc), response=response) return response except Exception as exc: response = Response.from_exception(exc).model_dump(exclude_none=True) logger.exception( "An unhandled exception occurred whilst processing the request", exc_info=sys.exc_info(), stacklevel=5, log_reference=LogReference.ERROR000.name, response=response, ) return response return wrapper def header_handler( wrapped_func: Callable[..., Dict[str, Any]] ) -> Callable[..., Dict[str, Any]]: """ Wraps the function to set the specific headers in the request and response """ def wrapper(*args, **kwargs) -> Dict[str, Any]: event: APIGatewayProxyEvent = args[0] response = wrapped_func(*args, **kwargs) try: if "headers" not in response: response["headers"] = {} echoed_headers = { name: event.get_header_value(name) for name in [ X_REQUEST_ID_HEADER, X_CORRELATION_ID_HEADER, ] if event.get_header_value(name) } response["headers"].update(echoed_headers) except Exception: logger.exception( "An error occurred whilst setting response headers", exc_info=sys.exc_info(), stacklevel=5, log_reference=LogReference.ERROR003.name, ) logger.log( LogReference.HANDLER016, status_code=getattr(response, "statusCode", ""), headers=getattr(response, "headers", {}), ) return response return wrapper def logger_initialiser( wrapper_func: Callable[..., Dict[str, Any]] ) -> Callable[..., Dict[str, Any]]: """ Wraps the function and initialises the request logger """ def wrapper(*args, **kwargs) -> Dict[str, Any]: event: APIGatewayProxyEvent = args[0] correlation_id = event.get_header_value(NHSD_CORRELATION_ID_HEADER) if correlation_id: logger.set_correlation_id(correlation_id) else: logger.log( LogReference.HANDLER017, id_header=NHSD_CORRELATION_ID_HEADER, headers=event.headers, ) return wrapper_func(*args, **kwargs) return wrapper RepositoryType = Union[Type[DocumentPointerRepository], None] def load_connection_metadata(headers: Dict[str, str], config: Config): logger.log(LogReference.HANDLER002, headers=headers) metadata = parse_headers(headers) logger.log(LogReference.HANDLER003, metadata=metadata.model_dump()) if PERMISSION_ALLOW_ALL_POINTER_TYPES in metadata.nrl_permissions: logger.log(LogReference.HANDLER004a) metadata.pointer_types = PointerTypes.list() return metadata logger.log(LogReference.HANDLER004b) pointer_types = parse_permissions_file(metadata) if not pointer_types and not metadata.is_test_event: logger.log(LogReference.HANDLER004) pointer_types = get_pointer_types(metadata, config) metadata.pointer_types = pointer_types logger.log(LogReference.HANDLER004c, pointer_types=pointer_types) return metadata def filter_kwargs(handler_func: RequestHandler, kwargs: Dict[str, Any]): function_kwargs = {} signature = inspect.signature(handler_func) for parameter in signature.parameters.values(): if parameter.name in kwargs: function_kwargs[parameter.name] = kwargs[parameter.name] logger.log( LogReference.HANDLER012, original_kwargs_keys=kwargs.keys(), filtered_kwargs_keys=function_kwargs.keys(), ) return function_kwargs def verify_request_ids(event: APIGatewayProxyEvent): caller_request_id = event.get_header_value(X_REQUEST_ID_HEADER) if not caller_request_id: logger.log(LogReference.HANDLER014, headers=event.headers) raise OperationOutcomeError( status_code="400", severity="error", code="invalid", details=SpineErrorConcept.from_code("MISSING_OR_INVALID_HEADER"), diagnostics="The X-Request-Id header is missing or invalid", ) caller_correlation_id = event.get_header_value(NHSD_CORRELATION_ID_HEADER) if not caller_correlation_id: logger.log(LogReference.HANDLER015, headers=event.headers) raise OperationOutcomeError( status_code="400", severity="error", code="invalid", details=SpineErrorConcept.from_code("MISSING_OR_INVALID_HEADER"), diagnostics="The NHSD-Correlation-Id header is missing or invalid", ) def basic_handler( event: APIGatewayProxyEvent, context: LambdaContext, func: RequestHandler, ) -> Dict[str, str]: """ Request handler without any parsing or authorisation checks. """ logger.log(LogReference.HANDLER013) response = func(event, context) logger.log( LogReference.HANDLER999, status_code=response.statusCode, response=response.model_dump(), ) return response.model_dump() def request_handler( params: Optional[Type[BaseModel]] = None, body: Optional[Type[BaseModel]] = None, path: Optional[Type[BaseModel]] = None, repository: RepositoryType = DocumentPointerRepository, skip_request_verification: bool = False, ) -> Callable[[RequestHandler], Callable[..., Dict[str, str]]]: """ Decorator for request handlers. Args: params (Optional[Type[BaseModel]]): The parameter model to parse query string parameters. body (Optional[Type[BaseModel]]): The body model to parse request body. skip_parse_headers (bool): Flag to skip parsing request headers. Defaults to False. repository (Union[Type[DocumentPointerRepository], None]): The repository class to use. Returns: Callable[[RequestHandler], RequestHandler]: The decorated request handler function. """ def wrapped_func(func: RequestHandler): def wrapper(event: APIGatewayProxyEvent, context: LambdaContext, **kwargs): client_cert = event.request_context.identity.client_cert if client_cert: client_cert_info = { "subject_dn": client_cert.subject_dn, "issuer_dn": client_cert.issuer_dn, "serial_number": client_cert.serial_number, } else: client_cert_info = "No client certificate provided" logger.log( code=LogReference.HANDLER000, method=event.http_method, path=event.path, headers=event.headers, client_cert_info=client_cert_info, ) if skip_request_verification: return basic_handler(event, context, func, **kwargs) verify_request_ids(event) config = Config() logger.log(LogReference.HANDLER001, config=config.model_dump()) metadata = load_connection_metadata(event.headers, config) if metadata.pointer_types == []: logger.log( LogReference.HANDLER005, ods_code=metadata.ods_code, pointer_types=metadata.pointer_types, ) raise OperationOutcomeError( status_code="403", severity="error", code="forbidden", details=SpineErrorConcept.from_code("ACCESS DENIED"), diagnostics=f"Your organisation '{metadata.ods_code}' does not have permission to access this resource. Contact the onboarding team.", ) kwargs = { "event": event, "context": context, "config": metadata, "metadata": metadata, "params": parse_params(params, event.query_string_parameters), "body": parse_body(body, event.body), "path": parse_path(path, event.path_parameters), } if repository is not None: kwargs["repository"] = repository(table_name=config.TABLE_NAME) function_kwargs = filter_kwargs(func, kwargs) logger.log(LogReference.HANDLER013) response = func(**function_kwargs) logger.log( LogReference.HANDLER999, status_code=response.statusCode, response=response.model_dump(), ) return response.model_dump() decorators = [ functools.wraps(func), error_handler, header_handler, logger_initialiser, logger.inject_lambda_context, event_source(data_class=APIGatewayProxyEvent), ] return functools.reduce( lambda func, decorator: decorator(func), decorators, wrapper ) return wrapped_func def deprecated(message: str): def decorator(func): """ This decorator will result in a warning appearing when used """ @functools.wraps(func) def new_func(*args, **kwargs): warnings.simplefilter("always", DeprecationWarning) # turn off filter warnings.warn( f"Call to deprecated function {func.__name__}. {message}", category=DeprecationWarning, stacklevel=2, ) warnings.simplefilter("default", DeprecationWarning) # reset filter return func(*args, **kwargs) return new_func return decorator NRLF-3.0.31/layer/nrlf/core/dynamodb/000077500000000000000000000000001511201605300171335ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/core/dynamodb/model.py000066400000000000000000000263221511201605300206120ustar00rootroot00000000000000import re from datetime import datetime from enum import Enum from typing import Any, Dict, Optional from nhs_number import is_valid as is_valid_nhs_number from pydantic import ( BaseModel, Field, PrivateAttr, ValidationInfo, field_validator, model_validator, ) from nrlf.core.constants import SYSTEM_SHORT_IDS, VALID_SOURCES from nrlf.core.logger import LogReference, logger from nrlf.core.types import DocumentReference from nrlf.core.utils import create_fhir_instant class DBPrefix(str, Enum): DocumentPointer = "D" Patient = "P" CreatedOn = "CO" Organisation = "O" Category = "C" Type = "T" MasterIdentifier = "MI" def get_id_for_system(system: str, attr_placement: str) -> str | None: """ Get the id for a given system """ if system not in SYSTEM_SHORT_IDS: logger.log( LogReference.DOCPOINTER006, system=system, attr_placement=attr_placement ) raise ValueError(f"Unsupported system defined in {attr_placement}") return SYSTEM_SHORT_IDS.get(system) class DynamoDBModel(BaseModel): _from_dynamo: bool = PrivateAttr(default=False) def __init__(self, **data): super().__init__(**data) self._from_dynamo = data.get("_from_dynamo", False) @classmethod def public_alias(cls) -> str: return cls.__name__ class DocumentPointer(DynamoDBModel): id: str nhs_number: str custodian: str producer_id: str category_id: str category: str type_id: str type: str master_identifier: Optional[str] = None author: str source: str version: int document: str created_on: str updated_on: Optional[str] = None document_id: str = Field(exclude=True) schemas: list = Field(default_factory=list) def model_dump(self, **kwargs) -> dict[str, Any]: """ Override model_dump() to include partition and sort keys """ default_dict = super().model_dump(**kwargs) return { **default_dict, **self.indexes, } def dict(self, **kwargs) -> dict[str, Any]: """ Define dict() to do same as model_dump """ return self.model_dump(**kwargs) @classmethod def from_document_reference( cls, resource: DocumentReference, created_on: Optional[str] = None ) -> "DocumentPointer": resource_id = getattr(resource, "id") # Get identifiers subject_identifier = getattr(resource.subject, "identifier") custodian_identifier = getattr(resource.custodian, "identifier") if not resource.author or len(resource.author) != 1: raise ValueError("DocumentReference.author must have exactly one item") author_identifier = getattr(resource.author[0], "identifier") # Get identifier values nhs_number = getattr(subject_identifier, "value") custodian = getattr(custodian_identifier, "value") author = getattr(author_identifier, "value") master_identifier = getattr(resource.masterIdentifier, "value", None) # Get type fields type_coding = getattr(resource.type, "coding") if not type_coding or len(type_coding) != 1: raise ValueError("DocumentReference.type.coding must have exactly one item") pointer_type = f"{type_coding[0].system}|{type_coding[0].code}" type_system_id = get_id_for_system( type_coding[0].system, "DocumentReference.type.coding[0].system" ) type_id = f"{type_system_id}-{type_coding[0].code}" # Get category fields if not resource.category or len(resource.category) != 1: raise ValueError("DocumentReference.category must have exactly one item") category_coding = getattr(resource.category[0], "coding") if not category_coding or len(category_coding) != 1: raise ValueError( "DocumentReference.category.coding must have exactly one item" ) pointer_category = f"{category_coding[0].system}|{category_coding[0].code}" category_system_id = get_id_for_system( category_coding[0].system, "DocumentReference.category.coding[0].system" ) category_id = f"{category_system_id}-{category_coding[0].code}" core_model = cls( producer_id=None, # type: ignore - handled by validators document_id=None, # type: ignore - handled by validators id=resource_id, nhs_number=nhs_number, custodian=custodian, author=author, master_identifier=master_identifier, type=pointer_type, type_id=type_id, category=pointer_category, category_id=category_id, source="NRLF", version=1, document=resource.model_dump_json(exclude_none=True), created_on=created_on or create_fhir_instant(), ) logger.log( LogReference.DOCPOINTER005, producer_id=core_model.producer_id, document_id=core_model.document_id, type=pointer_type, ) return core_model @model_validator(mode="before") @classmethod def inject_producer_id(cls, values: Dict[str, Any]) -> Dict[str, Any]: """ Inject the producer_id into the DocumentPointer if it is not provided """ logger.log(LogReference.DOCPOINTER003) _id: str = values["id"] producer_id = values.get("producer_id") if values.get("_from_dynamo"): producer_id = None if producer_id is not None: raise ValueError( "producer_id should not be passed to DocumentPointer; " "it will be extracted from id." ) producer_id, document_id = _id.split("-", maxsplit=1) values["producer_id"] = producer_id values["document_id"] = document_id logger.log( LogReference.DOCPOINTER004, producer_id=producer_id, document_id=document_id ) return values @field_validator("id") @classmethod def validate_id(cls, id_: str) -> str: """ Validate the id of the DocumentPointer The id should be in the format - """ if not re.match( r"^(?=.{1,64}$)[A-Za-z0-9|\\.]+-[A-Za-z0-9]+[A-Za-z0-9\\_\\-]*$", id_ ): raise ValueError("id must be in the format -") return id_ @field_validator("producer_id") @classmethod def validate_producer_id( cls, producer_id: str, validation_info: ValidationInfo ) -> str: values = validation_info.data id_ = values.get("id") custodian = values.get("custodian_id") if custodian and producer_id != custodian: raise ValueError( f"Producer ID {producer_id} (extracted from '{id_}')" " does not match the Custodian ID." ) return producer_id @field_validator("type") @classmethod def validate_type(cls, type: str) -> str: """ Validate the type of the DocumentPointer The type should be in the format | """ if not re.match(r"^[A-Za-z0-9]+|[A-Za-z0-9]+$", type): raise ValueError("type must be in the format |") return type @field_validator("nhs_number") @classmethod def validate_nhs_number(cls, nhs_number: str) -> str: """ Validate the NHS number of the DocumentPointer The NHS number should be a valid NHS number """ if not is_valid_nhs_number(nhs_number): # type: ignore raise ValueError(f"Not a valid NHS number: {nhs_number}") return nhs_number @field_validator("source") @classmethod def validate_source(cls, source: str) -> str: """ Validate the source of the DocumentPointer Should be one of ["NRLF", "NRL"] """ if source not in VALID_SOURCES: raise ValueError(f"Not a source: {source}. Expected one of {VALID_SOURCES}") return source @field_validator("created_on") @classmethod def validate_created_on(cls, created_on: str) -> str: """ Validate the created_on of the DocumentPointer The created_on should be a valid date """ _date = created_on[:-1] if created_on.endswith("Z") else created_on try: datetime.fromisoformat(_date) except ValueError: raise ValueError(f"Not a valid ISO date: {created_on}") from None return created_on @field_validator("updated_on") @classmethod def validate_updated_on(cls, updated_on: Optional[str]) -> Optional[str]: """ Validate the updated_on of the DocumentPointer The updated_on should be a valid date """ if updated_on is None: return updated_on _date = updated_on[:-1] if updated_on.endswith("Z") else updated_on try: datetime.fromisoformat(_date) except ValueError: raise ValueError(f"Not a valid ISO date: {updated_on}") from None return updated_on @property def indexes(self) -> Dict[str, str]: indexes = { "pk": self.pk, "sk": self.sk, "patient_key": self.patient_key, "patient_sort": self.patient_sort, } if self.masterid_key: indexes["masterid_key"] = self.masterid_key return indexes @property def pk(self) -> str: """ Returns the pk (partition key) for the DocumentPointer """ return "#".join([DBPrefix.DocumentPointer.value, self.id]) @property def sk(self) -> str: """ Returns the sk (sort key) for the DocumentPointer """ return "#".join([DBPrefix.DocumentPointer.value, self.id]) @property def patient_key(self) -> str: """ Returns the patient gsi pk (partition key) for the DocumentPointer Example: P# """ return "#".join([DBPrefix.Patient.value, self.nhs_number]) @property def patient_sort(self) -> str: """ Returns the patient gsi sk (sort key) for the DocumentPointer Example: C##T##CO##D# """ return "#".join( [ DBPrefix.Category.value, self.category_id, DBPrefix.Type.value, self.type_id, DBPrefix.CreatedOn.value, self.created_on, DBPrefix.DocumentPointer.value, self.id, ] ) @property def masterid_key(self) -> str | None: """ Returns the doc_key for the DocumentPointer Example: O##MI# """ if not self.master_identifier: return None return "#".join( [ DBPrefix.Organisation.value, self.custodian, DBPrefix.MasterIdentifier.value, self.master_identifier, ] ) @classmethod def public_alias(cls) -> str: return "DocumentReference" NRLF-3.0.31/layer/nrlf/core/dynamodb/repository.py000066400000000000000000000363011511201605300217270ustar00rootroot00000000000000import sys from abc import ABC from typing import Generic, Iterator, List, Optional, Type, TypeVar from botocore.exceptions import ClientError from pydantic import ValidationError from nrlf.core.boto import get_dynamodb_resource, get_dynamodb_table from nrlf.core.codes import SpineErrorConcept from nrlf.core.constants import SYSTEM_SHORT_IDS, TYPE_CATEGORIES from nrlf.core.dynamodb.model import DocumentPointer, DynamoDBModel from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference, logger RepositoryModel = TypeVar("RepositoryModel", bound=DynamoDBModel) def _get_sk_ids_for_type(pointer_type: str) -> tuple: if pointer_type not in TYPE_CATEGORIES: raise ValueError(f"Cannot find category for pointer type: {pointer_type}") category = TYPE_CATEGORIES[pointer_type] category_system, category_code = category.split("|") if category_system not in SYSTEM_SHORT_IDS: raise ValueError(f"Unknown system for category: {category_system}") category_id = SYSTEM_SHORT_IDS[category_system] + "-" + category_code type_system, type_code = pointer_type.split("|") if type_system not in SYSTEM_SHORT_IDS: raise ValueError(f"Unknown system for type: {type_system}") type_id = SYSTEM_SHORT_IDS[type_system] + "-" + type_code return category_id, type_id class Repository(ABC, Generic[RepositoryModel]): ITEM_TYPE: Type[RepositoryModel] def __init__(self, table_name: str): self.dynamodb = get_dynamodb_resource() self.table_name = table_name self.table = get_dynamodb_table(self.table_name) logger.log( LogReference.REPOSITORY001, table_name=self.table_name, item_type=self.ITEM_TYPE.__name__, ) class DocumentPointerRepository(Repository[DocumentPointer]): ITEM_TYPE = DocumentPointer def create(self, item: DocumentPointer) -> DocumentPointer: """ Create a DocumentPointer resource """ logger.log( LogReference.REPOSITORY002, indexes=item.indexes, type=item.type, source=item.source, version=item.version, ) try: result = self.table.put_item( Item=item.model_dump(), ConditionExpression="attribute_not_exists(pk) AND attribute_not_exists(sk)", ReturnConsumedCapacity="INDEXES", ) logger.log(LogReference.REPOSITORY003, result=result) except ClientError as exc: if ( exc.response.get("Error", {}).get("Code") == "ConditionalCheckFailedException" ): logger.log(LogReference.REPOSITORY004) raise OperationOutcomeError( status_code="409", severity="error", code="conflict", details=SpineErrorConcept.from_code("DUPLICATE_REJECTED"), ) from None logger.log( LogReference.REPOSITORY005, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise exc return item def get_by_id(self, id: str) -> Optional[DocumentPointer]: """ Get a DocumentPointer resource by ID """ doc_key = f"D#{id}" try: result = self.table.get_item( Key={"pk": doc_key, "sk": doc_key}, ReturnConsumedCapacity="INDEXES", ) except ClientError as exc: logger.log( LogReference.REPOSITORY007, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise exc if "Item" not in result: logger.log(LogReference.REPOSITORY012) return None item = result["Item"] try: parsed_item = self.ITEM_TYPE.model_validate({"_from_dynamo": True, **item}) logger.log(LogReference.REPOSITORY011) logger.log(LogReference.REPOSITORY011a, result=parsed_item.model_dump()) return parsed_item except ValidationError as exc: logger.log( LogReference.REPOSITORY010, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), ) from exc def count_by_nhs_number( self, nhs_number: str, pointer_types: Optional[List[str]] = None, ) -> int: """ Count all DocumentPointer records by NHS number """ logger.log( LogReference.REPOSITORY013, nhs_number=nhs_number, pointer_types=pointer_types, ) key_conditions = ["patient_key = :patient_key"] filter_expressions = [] expression_names = {} expression_values = {":patient_key": f"P#{nhs_number}"} if len(pointer_types) == 1: # Optimisation for single pointer type category_id, type_id = _get_sk_ids_for_type(pointer_types[0]) patient_sort = f"C#{category_id}#T#{type_id}" key_conditions.append("begins_with(patient_sort, :patient_sort)") expression_values[":patient_sort"] = patient_sort # Handle multiple categories and pointer types with filter expressions if len(pointer_types) > 1: expression_names["#pointer_type"] = "type" types_filters = [ f"#pointer_type = :type_{i}" for i in range(len(pointer_types)) ] types_filter_values = { f":type_{i}": pointer_types[i] for i in range(len(pointer_types)) } filter_expressions.append(f"({' OR '.join(types_filters)})") expression_values.update(types_filter_values) query = { "IndexName": "patient_gsi", "KeyConditionExpression": " AND ".join(key_conditions), "ExpressionAttributeValues": expression_values, "Select": "COUNT", "ReturnConsumedCapacity": "INDEXES", } if filter_expressions: query["FilterExpression"] = " AND ".join(filter_expressions) if expression_names: query["ExpressionAttributeNames"] = expression_names logger.log(LogReference.REPOSITORY017, query=query) try: result = self.table.query(**query) except ClientError as exc: logger.log( LogReference.REPOSITORY019, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), ) from exc logger.log(LogReference.REPOSITORY018, count=result["Count"]) logger.log(LogReference.REPOSITORY018a, result=result) return result["Count"] def search( self, nhs_number: str, custodian: Optional[str] = None, pointer_types: Optional[List[str]] = [], categories: Optional[List[str]] = [], ) -> Iterator[DocumentPointer]: """""" logger.log( LogReference.REPOSITORY020, nhs_number=nhs_number, custodian=custodian, pointer_types=pointer_types, categories=categories, ) key_conditions = ["patient_key = :patient_key"] filter_expressions = [] expression_names = {} expression_values = {":patient_key": f"P#{nhs_number}"} # Add pointer_types filter if provided if pointer_types: if len(pointer_types) == 1: # Optimisation for single pointer type category_id, type_id = _get_sk_ids_for_type(pointer_types[0]) patient_sort = f"C#{category_id}#T#{type_id}" key_conditions.append("begins_with(patient_sort, :patient_sort)") expression_values[":patient_sort"] = patient_sort else: expression_names["#pointer_type"] = "type" types_filters = [ f"#pointer_type = :type_{i}" for i in range(len(pointer_types)) ] types_filter_values = { f":type_{i}": pointer_types[i] for i in range(len(pointer_types)) } filter_expressions.append(f"({' OR '.join(types_filters)})") expression_values.update(types_filter_values) # Add categories filter if provided if categories: expression_names["#category"] = "category" category_filters = [ f"#category = :category_{i}" for i in range(len(categories)) ] category_filter_values = { f":category_{i}": categories[i] for i in range(len(categories)) } filter_expressions.append(f"({' OR '.join(category_filters)})") expression_values.update(category_filter_values) if custodian: logger.log( LogReference.REPOSITORY016, expression="custodian = :custodian", values=["custodian"], ) filter_expressions.append("custodian = :custodian") expression_values[":custodian"] = custodian query = { "IndexName": "patient_gsi", "KeyConditionExpression": " AND ".join(key_conditions), "ExpressionAttributeValues": expression_values, "ReturnConsumedCapacity": "INDEXES", } if filter_expressions: query["FilterExpression"] = " AND ".join(filter_expressions) if expression_names: query["ExpressionAttributeNames"] = expression_names yield from self._query(**query) def save(self, item: DocumentPointer) -> DocumentPointer: """ Save a DocumentPointer resource """ if not item._from_dynamo: logger.log(LogReference.REPOSITORY023) return self.create(item) logger.log(LogReference.REPOSITORY024) return self.update(item) def supersede( self, item: DocumentPointer, ids_to_delete: List[str], can_ignore_delete_fail: bool = False, ) -> DocumentPointer: """ """ saved_item = self.create(item) for id_ in ids_to_delete: self.delete_by_id(id_, can_ignore_delete_fail) return saved_item def delete(self, item: DocumentPointer) -> None: """ Delete a DocumentPointer """ logger.log(LogReference.REPOSITORY025, partition_key=item.pk, sort_key=item.sk) try: result = self.table.delete_item( Key={"pk": item.pk, "sk": item.sk}, ConditionExpression="attribute_exists(pk) AND attribute_exists(sk)", ReturnConsumedCapacity="INDEXES", ) logger.log(LogReference.REPOSITORY027, result=result) except ClientError as exc: logger.log( LogReference.REPOSITORY026, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), ) from exc def delete_by_id(self, id_: str, can_ignore_delete_fail: bool = False): """ """ key = f"D#{id_}" try: self.table.delete_item(Key={"pk": key, "sk": key}) except Exception as exc: if can_ignore_delete_fail: logger.log( LogReference.REPOSITORY026a, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) def _query(self, **kwargs) -> Iterator[DocumentPointer]: """ Wrapper around DynamoDB query method to handle pagination Returns an iterator of DocumentPointer objects """ # Remove empty fields from the search query query = {key: value for key, value in kwargs.items() if value} logger.log(LogReference.REPOSITORY021, query=query, table=self.table_name) try: paginator = self.dynamodb.meta.client.get_paginator("query") response_iterator = paginator.paginate(TableName=self.table_name, **query) for page in response_iterator: logger.log( LogReference.REPOSITORY028, stats={ "count": page["Count"], "scanned_count": page["ScannedCount"], "last_evaluated_key": page.get("LastEvaluatedKey"), }, ) logger.log(LogReference.REPOSITORY028a, result=page) for item in page["Items"]: try: yield self.ITEM_TYPE.model_validate( {"_from_dynamo": True, **item} ) except ValidationError as exc: logger.log( LogReference.REPOSITORY010, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code( "INTERNAL_SERVER_ERROR" ), ) from exc except ClientError as exc: logger.log( LogReference.REPOSITORY022, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise exc def update(self, item: DocumentPointer) -> DocumentPointer: """ Update a DocumentPointer resource """ try: result = self.table.put_item( Item=item.model_dump(), ConditionExpression="attribute_exists(pk) AND attribute_exists(sk)", ReturnConsumedCapacity="INDEXES", ) logger.log(LogReference.REPOSITORY029a, result=result) except ClientError as exc: logger.log( LogReference.REPOSITORY023, exc_info=sys.exc_info(), stacklevel=5, error=str(exc), ) raise OperationOutcomeError( status_code="500", severity="error", code="exception", details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), ) from exc return item NRLF-3.0.31/layer/nrlf/core/dynamodb/tests/000077500000000000000000000000001511201605300202755ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/core/dynamodb/tests/test_model.py000066400000000000000000000155321511201605300230140ustar00rootroot00000000000000import json import pytest from freezegun import freeze_time from nrlf.core.constants import PointerTypes from nrlf.core.dynamodb.model import DocumentPointer, DynamoDBModel from nrlf.core.utils import create_fhir_instant from nrlf.tests.data import load_document_reference def test_dynamodb_model_init(): model = DynamoDBModel() assert model.public_alias() == "DynamoDBModel" assert model._from_dynamo is False # Check _from_dynamo is a private attribute assert model.model_dump() == {} def test_dynamodb_model_init_from_dynamo(): model = DynamoDBModel(_from_dynamo=True) assert model.public_alias() == "DynamoDBModel" assert model._from_dynamo is True # Check _from_dynamo is a private attribute assert model.model_dump() == {} @freeze_time("2024-01-01") def test_document_pointer_init(): model = DocumentPointer( id="X26-999999-999999-99999999", nhs_number="9999999999", custodian="X26", author="X26", master_identifier="1111-11111-111111", producer_id=None, # type: ignore type="http://snomed.info/sct|123456789", type_id="SCT-123456789", category="http://snomed.info/sct|987654321", category_id="SCT-987654321", source="NRLF", version=1, document="document", created_on=create_fhir_instant(), document_id="document_id", ) assert model.public_alias() == "DocumentReference" assert model._from_dynamo is False assert model.model_dump() == { "id": "X26-999999-999999-99999999", "nhs_number": "9999999999", "custodian": "X26", "author": "X26", "producer_id": "X26", "type": "http://snomed.info/sct|123456789", "type_id": "SCT-123456789", "category": "http://snomed.info/sct|987654321", "category_id": "SCT-987654321", "master_identifier": "1111-11111-111111", "source": "NRLF", "version": 1, "document": "document", "created_on": "2024-01-01T00:00:00.000Z", "pk": "D#X26-999999-999999-99999999", "sk": "D#X26-999999-999999-99999999", "patient_key": "P#9999999999", "patient_sort": "C#SCT-987654321#T#SCT-123456789#CO#2024-01-01T00:00:00.000Z#D#X26-999999-999999-99999999", "masterid_key": "O#X26#MI#1111-11111-111111", "schemas": [], "updated_on": None, } @freeze_time("2024-01-01") def test_document_pointer_from_document_reference_valid(): doc_ref = load_document_reference("Y05868-736253002-Valid") model = DocumentPointer.from_document_reference(doc_ref) model_data = model.model_dump() document = model_data.pop("document") assert model_data == { "created_on": "2024-01-01T00:00:00.000Z", "custodian": "Y05868", "author": "Y05868", "id": "Y05868-99999-99999-999999", "master_identifier": None, "nhs_number": "6700028191", "producer_id": "Y05868", "schemas": [], "source": "NRLF", "type": PointerTypes.MENTAL_HEALTH_PLAN.value, "type_id": "SCT-736253002", "category": "http://snomed.info/sct|734163000", "category_id": "SCT-734163000", "updated_on": None, "version": 1, "pk": "D#Y05868-99999-99999-999999", "sk": "D#Y05868-99999-99999-999999", "patient_key": "P#6700028191", "patient_sort": "C#SCT-734163000#T#SCT-736253002#CO#2024-01-01T00:00:00.000Z#D#Y05868-99999-99999-999999", } assert json.loads(document) == doc_ref.model_dump(exclude_none=True) def test_document_pointer_from_document_reference_valid_with_created_on(): doc_ref = load_document_reference("Y05868-736253002-Valid") model = DocumentPointer.from_document_reference( doc_ref, created_on="2024-02-02T12:34:56.000Z" ) model_data = model.model_dump() document = model_data.pop("document") assert model_data == { "created_on": "2024-02-02T12:34:56.000Z", "custodian": "Y05868", "author": "Y05868", "id": "Y05868-99999-99999-999999", "master_identifier": None, "nhs_number": "6700028191", "producer_id": "Y05868", "schemas": [], "source": "NRLF", "type": PointerTypes.MENTAL_HEALTH_PLAN.value, "type_id": "SCT-736253002", "category": "http://snomed.info/sct|734163000", "category_id": "SCT-734163000", "updated_on": None, "version": 1, "pk": "D#Y05868-99999-99999-999999", "sk": "D#Y05868-99999-99999-999999", "patient_key": "P#6700028191", "patient_sort": "C#SCT-734163000#T#SCT-736253002#CO#2024-02-02T12:34:56.000Z#D#Y05868-99999-99999-999999", } assert json.loads(document) == doc_ref.model_dump(exclude_none=True) def test_document_pointer_from_document_reference_invalid(): doc_ref = load_document_reference("Y05868-736253002-Valid") doc_ref.type = None # We should have already validated these fields are present by this point, # so allow directly raising the AttributeError to cause an error. with pytest.raises(AttributeError) as error: DocumentPointer.from_document_reference(doc_ref) assert str(error.value) == "'NoneType' object has no attribute 'coding'" def test_document_pointer_inject_producer_id(): values = {"id": "X26-999999-999999-99999999", "producer_id": None} assert DocumentPointer.inject_producer_id(values) == { "id": "X26-999999-999999-99999999", "producer_id": "X26", "document_id": "999999-999999-99999999", } def test_document_pointer_inject_producer_id_existing_producer_id(): values = {"id": "X26-999999-999999-99999999", "producer_id": "X26"} with pytest.raises(ValueError) as error: DocumentPointer.inject_producer_id(values) assert ( str(error.value) == "producer_id should not be passed to DocumentPointer; it will be extracted from id." ) def test_document_pointer_inject_producer_id_existing_producer_id_from_dynamo(): values = { "_from_dynamo": True, "id": "X26-999999-999999-9999999", "producer_id": "X26", } assert DocumentPointer.inject_producer_id(values) == { "_from_dynamo": True, "id": "X26-999999-999999-9999999", "producer_id": "X26", "document_id": "999999-999999-9999999", } @pytest.mark.parametrize( "id_", [ "X26-999999-999999-99999999", "X26.001-999999-999999-99999999", "Y05868-99999-99999-999999", "ABC-123", "123-ABC", "abc-def", "x-y-z", ], ) def test_validate_id(id_): assert DocumentPointer.validate_id(id_) == id_ @pytest.mark.parametrize( "id_", [ "-X26-999999-999999-99999999", "X26_999999_999999_99999999", ], ) def test_validate_id_invalid(id_): with pytest.raises(ValueError): DocumentPointer.validate_id(id_) NRLF-3.0.31/layer/nrlf/core/dynamodb/tests/test_repository.py000066400000000000000000000020771511201605300241330ustar00rootroot00000000000000import pytest from nrlf.core.constants import PointerTypes from nrlf.core.dynamodb.repository import _get_sk_ids_for_type def test_get_sk_ids_for_type_exception_thrown_for_invalid_type(): with pytest.raises(ValueError) as error: _get_sk_ids_for_type("invalid_type") assert str(error.value) == "Cannot find category for pointer type: invalid_type" def test_get_sk_ids_for_type_returns_type_and_category_for_every_type(): for each in PointerTypes.list(): category, pointer_type = _get_sk_ids_for_type(each) assert category and pointer_type def test_get_sk_ids_for_type_exception_thrown_if_new_type_has_no_category(): pointer_types = PointerTypes.list() pointer_types.append("some_pointer_type") with pytest.raises(ValueError) as error: for each in pointer_types: category, pointer_type = _get_sk_ids_for_type(each) assert category and pointer_type assert ( str(error.value) == "Cannot find category for pointer type: some_pointer_type" ) # TODO: Add unit tests for Repository Class NRLF-3.0.31/layer/nrlf/core/errors.py000066400000000000000000000071211511201605300172250ustar00rootroot00000000000000from typing import List, Optional from pydantic import ValidationError from pydantic_core import ErrorDetails from nrlf.core.response import Response from nrlf.core.types import CodeableConcept from nrlf.producer.fhir.r4 import model as producer_model from nrlf.producer.fhir.r4.model import OperationOutcome, OperationOutcomeIssue def format_error_location(loc: List) -> str: formatted_loc = "" for each in loc: if isinstance(each, int): formatted_loc = f"{formatted_loc}[{each}]" else: formatted_loc = f"{formatted_loc}.{each}" if formatted_loc else str(each) return formatted_loc def diag_for_error(error: ErrorDetails, value_set: str, root_location: tuple) -> str: loc_string = format_error_location(error["loc"]) if root_location: loc_string = format_error_location(root_location) + "." + loc_string msg = f"{loc_string or 'DocumentReference'}: {error['msg']}" msg += f", see: {value_set}" if value_set else "" return msg def expression_for_error(error: ErrorDetails, root_location: tuple) -> Optional[str]: loc_string = format_error_location(error["loc"]) or "DocumentReference" if root_location and error["loc"]: loc_string = ( format_error_location(root_location) + "." + format_error_location(error["loc"]) ) return loc_string class OperationOutcomeError(Exception): """ Will instantly trigger an OperationOutcome error response when raised """ def __init__( # noqa: PLR0913 self, severity: str, code: str, details: CodeableConcept, diagnostics: Optional[str] = None, expression: Optional[list[str]] = None, status_code: str = "400", ): self.operation_outcome = OperationOutcome( resourceType="OperationOutcome", issue=[ OperationOutcomeIssue( severity=severity, code=code, details=details, # type: ignore diagnostics=diagnostics, expression=expression, ) ], ) self.status_code = status_code @property def response(self) -> Response: return Response( statusCode=self.status_code, body=self.operation_outcome.model_dump_json(exclude_none=True, indent=2), ) def __str__(self): return f"OperationOutcomeError: {self.operation_outcome}" class ParseError(Exception): issues: List[OperationOutcomeIssue] def __init__(self, issues: List[OperationOutcomeIssue]): self.issues = issues @classmethod def from_validation_error( cls, exc: ValidationError, details: CodeableConcept, msg: str = "", value_set: str = "", root_location: tuple = None, ): issues = [ producer_model.OperationOutcomeIssue( severity="error", code="invalid", details=details, # type: ignore diagnostics=f"{msg} ({diag_for_error(error, value_set, root_location)})", expression=[expression_for_error(error, root_location)], # type: ignore ) for error in exc.errors() ] return cls(issues) @property def response(self): return Response( statusCode="400", body=producer_model.OperationOutcome( resourceType="OperationOutcome", issue=self.issues, ).model_dump_json(exclude_none=True, indent=2), ) NRLF-3.0.31/layer/nrlf/core/json_duplicate_checker.py000066400000000000000000000047301511201605300224030ustar00rootroot00000000000000import json from typing import Any def check_for_duplicate_keys(pairs: list[tuple[str, Any]]) -> dict[str, Any]: """Custom JSON object_pairs_hook that checks for duplicate keys.""" keys: dict[str, Any] = {} dupes: dict[str, Any] = {} normalized_keys: list[str] = [] for key, value in pairs: normalized_key = key.lower() if normalized_key in normalized_keys: dupes.setdefault(key, []).append(value) else: keys[key] = value normalized_keys += [normalized_key] if dupes: keys["__duplicates__"] = dupes return keys def flatten_duplicates(data: dict[str, Any] | list[Any]) -> list[str]: """Flattens a JSON structure and returns a list of duplicate paths.""" duplicates: list[str] = [] items = data.items() if isinstance(data, dict) else enumerate(data) for key, value in items: if key == "__duplicates__": duplicates.extend(value.keys()) elif isinstance(value, (dict, list)): path = f"{key}" if isinstance(data, dict) else f"[{key}]" dupes = flatten_duplicates(value) duplicates.extend([f"{path}.{dupe}" for dupe in dupes]) return duplicates def format_path(path: str) -> str: """Transforms a path like key1.[2].key2 into key1[2].key2""" parts = path.split(".") formatted_parts: list[str] = [] for part in parts: if part.startswith("["): formatted_parts[-1] += part else: formatted_parts.append(part) return ".".join(formatted_parts) def check_duplicate_keys(json_content: str) -> tuple[list[str], list[str]]: """Find all duplicate keys in a JSON string. Traverses the entire JSON structure and reports: - List of keys that appear multiple times at the same level - Full paths to each duplicate key occurrkeysence A key is considered duplicate if it appears multiple times within the same object, regardless of nesting level or array position. """ try: dupe_data = json.loads(json_content, object_pairs_hook=check_for_duplicate_keys) duplicate_paths = [ f"DocumentReference.{format_path(path)}" for path in flatten_duplicates(dupe_data) ] duplicate_keys = list( dict.fromkeys([key.split(".")[-1] for key in duplicate_paths]) ) return duplicate_keys, duplicate_paths except json.JSONDecodeError: raise ValueError("Error: Invalid JSON format") NRLF-3.0.31/layer/nrlf/core/log_references.py000066400000000000000000000463101511201605300206760ustar00rootroot00000000000000from dataclasses import dataclass from enum import Enum @dataclass class _Reference: level: str message: str # WARNING: This makes all _Reference objects unequal unless they are the same instance. # It's fine for our use case, but be cautious if you compare _Reference objects. def __eq__(self, other): return self is other def __hash__(self): return id(self) class LogReference(Enum): # Request Handler Logs HANDLER000 = _Reference("INFO", "Starting execution of request handler") HANDLER001 = _Reference("DEBUG", "Loaded config from environment variables") HANDLER002 = _Reference("DEBUG", "Attempting to parse request headers") HANDLER003 = _Reference("INFO", "Parsed metadata from request headers") HANDLER004 = _Reference("INFO", "Authorisation lookup enabled") HANDLER004a = _Reference("INFO", "Authorisation lookup skipped for sync request") HANDLER004b = _Reference("INFO", "Parsing embedded permissions file from S3") HANDLER004c = _Reference("INFO", "Parsed embedded permissions file from S3") HANDLER005 = _Reference("WARN", "Rejecting request due to missing pointer types") HANDLER006 = _Reference("DEBUG", "Attempting to parse request parameters") HANDLER007 = _Reference("INFO", "Parsed request parameters") HANDLER008 = _Reference("DEBUG", "Attempting to parse request body") HANDLER009 = _Reference("INFO", "Parsed request body") HANDLER010 = _Reference("DEBUG", "Attempting to parse request path parameters") HANDLER011 = _Reference("INFO", "Parsed request path parameters") HANDLER012 = _Reference("DEBUG", "Filtered request handler function arguments") HANDLER013 = _Reference("INFO", "Calling lambda-specific request handler") HANDLER014 = _Reference( "WARN", "Rejecting request due to missing X-Request-Id header" ) HANDLER015 = _Reference( "WARN", "Rejecting request due to missing NHSD-Correlation-Id header" ) HANDLER016 = _Reference("INFO", "Set response headers") HANDLER017 = _Reference("WARN", "Correlation ID not found in request headers") HANDLER018 = _Reference("INFO", "Checking for duplicate keys in request body") HANDLER019 = _Reference("ERROR", "Duplicate keys found in the request body") HANDLER999 = _Reference("INFO", "Request handler returned successfully") # Error Logs ERROR000 = _Reference( "ERROR", "An unhandled exception occurred whilst processing the request" ) ERROR001 = _Reference( "WARN", "An OperationOutcomeError occurred whilst processing the request" ) ERROR002 = _Reference( "WARN", "An ParseError occurred whilst processing the request" ) ERROR003 = _Reference( "WARN", "An unhandler exception occurred whilst handling response headers" ) # S3 Permissions Lookup Logs S3PERMISSIONS001 = _Reference("INFO", "Retrieving pointer types from S3 bucket") S3PERMISSIONS002 = _Reference("INFO", "Retrieved list of pointer types from S3") S3PERMISSIONS003 = _Reference("WARN", "No permissions file found in S3") S3PERMISSIONS004 = _Reference( "EXCEPTION", "An error occurred whilst retrieving pointer types from S3" ) S3PERMISSIONS005 = _Reference( "EXCEPTION", "An error occurred whilst pasrsing embedded permissions files from S3", ) # Parse Logs PARSE000 = _Reference("DEBUG", "Attempting to parse data against model") PARSE001 = _Reference("INFO", "Parsed data against model") PARSE001a = _Reference("DEBUG", "Parsed data against model with result") PARSE002 = _Reference("WARN", "Failed to parse data against model") # Validator Logs VALIDATOR000 = _Reference("INFO", "Attempting to validate resource") VALIDATOR001 = _Reference("DEBUG", "Starting validation step") VALIDATOR001a = _Reference("INFO", "Skipping validation step") VALIDATOR002 = _Reference( "WARN", "An error was encountered whilst validating the resource" ) VALIDATOR003 = _Reference("INFO", "Validation was stopped early due to errors") VALIDATOR999 = _Reference("INFO", "Validation completed on resource") # Repository logs REPOSITORY001 = _Reference("INFO", "Initialised DynamoDB repository") REPOSITORY002 = _Reference("INFO", "Creating item in DynamoDB") REPOSITORY003 = _Reference("INFO", "Successfully created item in DynamoDB") REPOSITORY004 = _Reference( "WARN", "Failed to create item in DynamoDB due to existing item" ) REPOSITORY005 = _Reference("EXCEPTION", "Failed to create item in DynamoDB") REPOSITORY006 = _Reference("INFO", "Retrieving item from DynamoDB") REPOSITORY007 = _Reference("EXCEPTION", "Failed to retrieve item from DynamoDB") REPOSITORY008 = _Reference("ERROR", "Multiple items returned for partition key") REPOSITORY009 = _Reference("DEBUG", "Received query response from DynamoDB") REPOSITORY010 = _Reference( "EXCEPTION", "Existing item in datastore failed validation" ) REPOSITORY011 = _Reference("INFO", "Successfully retrieved item from DynamoDB") REPOSITORY011a = _Reference( "DEBUG", "Successfully retrieved item from DynamoDB with result" ) REPOSITORY012 = _Reference("INFO", "No item found in DynamoDB") REPOSITORY013 = _Reference("INFO", "Counting items in DynamoDB with criteria") REPOSITORY014 = _Reference("DEBUG", "Constructed base query") REPOSITORY015 = _Reference("DEBUG", "Adding key condition to query") REPOSITORY016 = _Reference("DEBUG", "Adding filter expression to query") REPOSITORY017 = _Reference("INFO", "Performing DynamoDB count query") REPOSITORY018 = _Reference("INFO", "Count query returned successfully") REPOSITORY018a = _Reference( "DEBUG", "Count query returned successfully with result" ) REPOSITORY019 = _Reference( "EXCEPTION", "An error occurred whilst performing count query" ) REPOSITORY020 = _Reference("INFO", "Searching items in DynamoDB with criteria") REPOSITORY021 = _Reference("INFO", "Performing DynamoDB query") REPOSITORY022 = _Reference("EXCEPTION", "An error occurred whilst performing query") REPOSITORY023 = _Reference("DEBUG", "Saving new resource to DynamoDB") REPOSITORY024 = _Reference("DEBUG", "Saving updated resource in DynamoDB") REPOSITORY025 = _Reference("DEBUG", "Deleting resource from DynamoDB") REPOSITORY026 = _Reference("EXCEPTION", "Failed to delete resource from DynamoDB") REPOSITORY026a = _Reference( "EXCEPTION", "Ignoring failure to delete resource from DynamoDB" ) REPOSITORY027 = _Reference("INFO", "Successfully deleted item from DynamoDB") REPOSITORY028 = _Reference("INFO", "Received page of search results") REPOSITORY028a = _Reference("DEBUG", "Received page of search results with result") REPOSITORY029a = _Reference("DEBUG", "Updated item with result") # Model logs DOCPOINTER001 = _Reference("DEBUG", "Extracting custodian suffix from custodian") DOCPOINTER002 = _Reference("DEBUG", "Extracted custodian ID and custodian suffix") DOCPOINTER003 = _Reference("DEBUG", "Extracting producer ID from the document ID") DOCPOINTER004 = _Reference("DEBUG", "Extracted producer ID and document ID") DOCPOINTER005 = _Reference( "INFO", "Constructed DocumentPointer from DocumentReference resource" ) DOCPOINTER006 = _Reference( "EXCEPTION", "Unsupported system defined for document reference" ) # Consumer - CountDocumentReference CONCOUNT000 = _Reference( "INFO", "Starting to process consumer countDocumentReference" ) CONCOUNT001 = _Reference( "INFO", "Invalid NHS number provided in the query parameters" ) CONCOUNT999 = _Reference( "INFO", "Successfully completed consumer countDocumentReference" ) # Consumer - ReadDocumentReference CONREAD000 = _Reference( "INFO", "Starting to process consumer readDocumentReference" ) CONREAD001 = _Reference("INFO", "Returning 404 DocumentReference not found") CONREAD002 = _Reference( "WARN", "Organisation does not have permissions to access resource" ) CONREAD003 = _Reference( "EXCEPTION", "The stored DocumentReference could not be parsed" ) CONREAD999 = _Reference( "INFO", "Successfully completed consumer readDocumentReference" ) # Consumer - SearchDocumentReference CONSEARCH000 = _Reference( "INFO", "Starting to process consumer searchDocumentReference" ) CONSEARCH001 = _Reference( "INFO", "Invalid NHS number provided in the query parameters" ) CONSEARCH002 = _Reference( "INFO", "Invalid document type provided in the query parameters" ) CONSEARCH002b = _Reference( "INFO", "Invalid document category provided in the query parameters" ) CONSEARCH003 = _Reference("DEBUG", "Performing search by NHS number") CONSEARCH004 = _Reference( "DEBUG", "Parsed DocumentReference and added to search results" ) CONSEARCH005 = _Reference( "EXCEPTION", "The DocumentReference resource could not be parsed" ) CONSEARCH006 = _Reference("DEBUG", "Search with summary count parameter enabled") CONSEARCH007 = _Reference( "INFO", "Search with summary count parameter returned total results" ) CONSEARCH999 = _Reference( "INFO", "Successfully completed consumer searchDocumentReference" ) # Consumer - SearchPostDocumentReference CONPOSTSEARCH000 = _Reference( "INFO", "Starting to process consumer searchPostDocumentReference" ) CONPOSTSEARCH001 = _Reference( "INFO", "Invalid NHS number provided in the request body" ) CONPOSTSEARCH002 = _Reference( "INFO", "Invalid document type provided in the request body" ) CONPOSTSEARCH002b = _Reference( "INFO", "Invalid document category provided in the request body" ) CONPOSTSEARCH003 = _Reference("DEBUG", "Performing search by NHS number") CONPOSTSEARCH004 = _Reference( "DEBUG", "Parsed DocumentReference and added to search results" ) CONPOSTSEARCH005 = _Reference( "EXCEPTION", "The DocumentReference resource could not be parsed" ) CONPOSTSEARCH006 = _Reference( "DEBUG", "Search with summary count parameter enabled" ) CONPOSTSEARCH007 = _Reference( "INFO", "Search with summary count parameter returned total results" ) CONPOSTSEARCH999 = _Reference( "INFO", "Successfully completed consumer searchPostDocumentReference" ) # Producer - CreateDocumentReference PROCREATE000 = _Reference( "INFO", "Starting to process producer createDocumentReference" ) PROCREATE001 = _Reference("DEBUG", "Validating DocumentReference resource") PROCREATE002 = _Reference("WARN", "DocumentReference resource failed validation") PROCREATE003 = _Reference( "WARN", "ODS code in headers does not match ODS code in resource ID" ) PROCREATE004 = _Reference( "WARN", "ODS code in headers does not match ODS code in resource custodian" ) PROCREATE005 = _Reference( "WARN", "Organisation is not allowed to create pointer type" ) PROCREATE006 = _Reference("DEBUG", "Performing relatesTo validation on resource") PROCREATE007a = _Reference( "WARN", "RelatesTo validation failed - no target identifier value" ) PROCREATE007b = _Reference( "WARN", "RelatesTo validation failed - invalid producer for target identifier" ) PROCREATE007c = _Reference( "WARN", "RelatesTo validation failed - no pointer exists with target identifier" ) PROCREATE007d = _Reference( "WARN", "RelatesTo validation failed - relating pointer NHS number mismatch" ) PROCREATE007e = _Reference( "WARN", "RelatesTo validation failed - relating pointer document type mismatch" ) PROCREATE008 = _Reference("INFO", "Selecting document as target to be superseded") PROCREATE009 = _Reference("INFO", "Creating new document reference") PROCREATE010 = _Reference("INFO", "Superseding document reference") PROCREATE011 = _Reference( "INFO", "Preserved .date field when creating new document reference" ) PROCREATE012 = _Reference( "WARN", "Existing pointers found for patient during create operation" ) PROCREATE999 = _Reference( "INFO", "Successfully completed producer createDocumentReference" ) # Producer - UpsertDocumentReference PROUPSERT000 = _Reference( "INFO", "Starting to process producer upsertDocumentReference" ) PROUPSERT001 = _Reference( "DEBUG", "Validating DocumentReference resource for upsert" ) PROUPSERT002 = _Reference( "WARN", "DocumentReference resource failed validation for upsert" ) PROUPSERT003 = _Reference( "WARN", "ODS code in headers does not match ODS code in resource ID for upsert" ) PROUPSERT004 = _Reference( "WARN", "ODS code in headers does not match ODS code in resource custodian for upsert", ) PROUPSERT005 = _Reference( "WARN", "Organisation is not allowed to upsert pointer type for upsert" ) # PROUPSERT005a = _Reference( "WARN", "Organisation is not allowed to upsert pointer type with incorrect category code", ) # PROUPSERT006 = _Reference( "DEBUG", "Performing relatesTo validation on resource for upsert" ) PROUPSERT006a = _Reference( "DEBUG", "Skipping relatesTo validation on resource for sync upsert request" ) PROUPSERT007a = _Reference( "WARN", "RelatesTo validation failed - no target identifier value for upsert" ) PROUPSERT007b = _Reference( "WARN", "RelatesTo validation failed - invalid producer for target identifier for upsert", ) PROUPSERT007c = _Reference( "WARN", "RelatesTo validation failed - no pointer exists with target identifier for upsert", ) PROUPSERT007d = _Reference( "WARN", "RelatesTo validation failed - relating pointer NHS number mismatch for upsert", ) PROUPSERT007e = _Reference( "WARN", "RelatesTo validation failed - relating pointer document type mismatch for upsert", ) PROUPSERT008 = _Reference("INFO", "Selecting document as target to be superseded") PROUPSERT009 = _Reference("INFO", "Upserting new document reference") PROUPSERT010 = _Reference("INFO", "Superseding document reference for upsert") PROUPSERT011 = _Reference( "INFO", "Preserved .date field when creating new document reference for upsert" ) PROUPSERT012 = _Reference( "WARN", "Existing pointers found for patient during upsert operation" ) PROUPSERT999 = _Reference( "INFO", "Successfully completed producer upsertDocumentReference" ) # Producer - DeleteDocumentReference PRODELETE000 = _Reference( "INFO", "Starting to process producer deleteDocumentReference" ) PRODELETE001 = _Reference( "WARN", "Organisation is not allowed to delete pointer as it is not the producer", ) PRODELETE002 = _Reference("WARN", "Cannot delete pointer as it does not exist") PRODELETE999 = _Reference( "INFO", "Successfully completed producer deleteDocumentReference" ) # Producer - ReadDocumentReference PROREAD000 = _Reference( "INFO", "Starting to process producer readDocumentReference" ) PROREAD001 = _Reference( "WARN", "Unable to return DocumentReference as it belongs to another organisation", ) PROREAD002 = _Reference("INFO", "Returning 404 DocumentReference not found") PROREAD003 = _Reference( "EXCEPTION", "The stored DocumentReference could not be parsed" ) PROREAD999 = _Reference( "INFO", "Successfully completed producer readDocumentReference" ) # Producer - SearchDocumentReference PROSEARCH000 = _Reference( "INFO", "Starting to process producer searchDocumentReference" ) PROSEARCH001 = _Reference( "INFO", "Invalid NHS number provided in the query parameters" ) PROSEARCH002 = _Reference( "INFO", "Invalid document type provided in the query parameters" ) PROSEARCH002b = _Reference( "INFO", "Invalid document category provided in the query parameters" ) PROSEARCH003 = _Reference("DEBUG", "Performing search by custodian") PROSEARCH004 = _Reference( "DEBUG", "Parsed DocumentReference and added to search results" ) PROSEARCH005 = _Reference( "EXCEPTION", "The DocumentReference resource could not be parsed" ) PROSEARCH006 = _Reference("DEBUG", "Search with summary count parameter enabled") PROSEARCH999 = _Reference( "INFO", "Successfully completed producer searchDocumentReference" ) # Producer - SearchPostDocumentReference PROPOSTSEARCH000 = _Reference( "INFO", "Starting to process producer searchPostDocumentReference" ) PROPOSTSEARCH001 = _Reference( "INFO", "Invalid NHS number provided in the request body" ) PROPOSTSEARCH002 = _Reference( "INFO", "Invalid document type provided in the request body" ) PROPOSTSEARCH002b = _Reference( "INFO", "Invalid document category provided in the request body" ) PROPOSTSEARCH003 = _Reference("DEBUG", "Performing search by custodian") PROPOSTSEARCH004 = _Reference( "DEBUG", "Parsed DocumentReference and added to search results" ) PROPOSTSEARCH005 = _Reference( "EXCEPTION", "The DocumentReference resource could not be parsed" ) PROPOSTSEARCH006 = _Reference( "DEBUG", "Search with summary count parameter enabled" ) PROPOSTSEARCH999 = _Reference( "INFO", "Successfully completed producer searchDocumentReference" ) # Producer - UpdateDocumentReference PROUPDATE000 = _Reference( "INFO", "Starting to process producer updateDocumentReference" ) PROUPDATE001 = _Reference( "WARN", "The ID in the path does not match the ID in the document body" ) PROUPDATE002 = _Reference("DEBUG", "Validating DocumentReference resource") PROUPDATE003 = _Reference("WARN", "DocumentReference resource failed validation") PROUPDATE004 = _Reference( "WARN", "ODS code in headers does not match ODS code in resource ID" ) PROUPDATE005 = _Reference("WARN", "No existing DocumentReference to update") PROUPDATE006 = _Reference( "WARN", "Cannot update DocumentReference as immutable fields have changed" ) PROUPDATE007 = _Reference( "WARN", "Update provided for DocumentReference with invalid preserved field, ignoring", ) PROUPDATE999 = _Reference( "INFO", "Successfully completed producer updateDocumentReference" ) # Firehose Logs FIREHOSE000 = _Reference("INFO", "Starting to process CloudWatch log records") FIREHOSE001 = _Reference("INFO", "Parsed config from event") # Status Logs STATUS000 = _Reference("INFO", "Starting to process consumer status") STATUS001 = _Reference("DEBUG", "Checking environment variables") STATUS002 = _Reference("DEBUG", "Checking database connection") STATUS003 = _Reference("EXCEPTION", "An error occurred during the status check") STATUS999 = _Reference("INFO", "Successfully completed consumer status") NRLF-3.0.31/layer/nrlf/core/logger.py000066400000000000000000000037501511201605300171740ustar00rootroot00000000000000import os from datetime import datetime from typing import Any from aws_lambda_powertools import Logger as PowertoolsLogger from aws_lambda_powertools.logging.formatter import LambdaPowertoolsFormatter from aws_lambda_powertools.logging.types import LogRecord from nrlf.core.log_references import LogReference class SplunkFormatter(LambdaPowertoolsFormatter): def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) self.splunk_index = os.getenv("SPLUNK_INDEX", "aws_recordlocator_dev") def serialize(self, log: LogRecord) -> str: """ Serialize the log record to JSON to Splunk Event format """ log_time = datetime.fromisoformat(str(log["timestamp"])).timestamp() return self.json_serializer( { "time": log_time, "index": self.splunk_index, "host": str(log.get("function_name")), "source": "lambda", "event": log, } ) class Logger(PowertoolsLogger): def log(self, code: LogReference, **kwargs: Any) -> None: kwargs["log_reference"] = code.name match code.value.level: case "DEBUG": self.debug(code.value.message, stacklevel=3, **kwargs) case "INFO": self.info(code.value.message, stacklevel=3, **kwargs) case "WARN": self.warning(code.value.message, stacklevel=3, **kwargs) case "ERROR": self.error(code.value.message, stacklevel=3, **kwargs) case "CRITICAL": self.critical(code.value.message, stacklevel=3, **kwargs) case "EXCEPTION": self.exception(code.value.message, **kwargs) case _: self.warning( f"Unhandled log level: {code.value.level} - {code.value.message}", **kwargs, ) logger = Logger(logger_formatter=SplunkFormatter()) NRLF-3.0.31/layer/nrlf/core/model.py000066400000000000000000000032241511201605300170110ustar00rootroot00000000000000from typing import Union from nhs_number import is_valid as is_valid_nhs_number from pydantic import BaseModel, Field, StrictStr import nrlf.consumer.fhir.r4.model as consumer_model import nrlf.producer.fhir.r4.model as producer_model class _NhsNumberMixin: @property def nhs_number(self) -> Union[str, None]: if self.subject_identifier is None: return None nhs_number = self.subject_identifier.root.split("|", 1)[1] if not is_valid_nhs_number(nhs_number): return None return nhs_number class ProducerRequestParams(producer_model.RequestParams, _NhsNumberMixin): model_config = {"extra": "forbid"} class ConsumerRequestParams(consumer_model.RequestParams, _NhsNumberMixin): model_config = {"extra": "forbid"} class CountRequestParams(consumer_model.CountRequestParams, _NhsNumberMixin): pass class ReadDocumentReferencePathParams(BaseModel): id: StrictStr class DeleteDocumentReferencePathParams(BaseModel): id: StrictStr class UpdateDocumentReferencePathParams(BaseModel): id: StrictStr class ClientRpDetails(BaseModel): developer_app_name: StrictStr = Field(alias="developer.app.name") developer_app_id: StrictStr = Field(alias="developer.app.id") class ConnectionMetadata(BaseModel): pointer_types: list[str] = Field(alias="nrl.pointer-types", default_factory=list) ods_code: str = Field(alias="nrl.ods-code") nrl_permissions: list[str] = Field(alias="nrl.permissions", default_factory=list) nrl_app_id: str = Field(alias="nrl.app-id") is_test_event: bool = Field(alias="nrl.test-event", default=False) client_rp_details: ClientRpDetails NRLF-3.0.31/layer/nrlf/core/parent_model.py000066400000000000000000000144131511201605300203640ustar00rootroot00000000000000from typing import Annotated, List, Optional from pydantic import BaseModel, ConfigDict, Field, model_validator class ParentCoding(BaseModel): model_config = ConfigDict(regex_engine="python-re", extra="forbid") id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None system: Annotated[ Optional[str], Field( description="The identification of the code system that defines the meaning of the symbol in the code.", pattern="\\S*", ), ] = None version: Annotated[ Optional[str], Field( description="The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", pattern="[ \\r\\n\\t\\S]+", ), ] = None code: Annotated[ Optional[str], Field( description="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination).", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None display: Annotated[ Optional[str], Field( description="A representation of the meaning of the code in the system, following the rules of the system.", pattern="[ \\r\\n\\t\\S]+", ), ] = None userSelected: Annotated[ Optional[bool], Field( description="Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)." ), ] = None class ParentCodeableConcept(BaseModel): model_config = ConfigDict(regex_engine="python-re", extra="forbid") id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None coding: Optional[List[ParentCoding]] = None text: Annotated[ Optional[str], Field( description="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", pattern="[ \\r\\n\\t\\S]+", ), ] = None class ParentExtension(BaseModel): valueCodeableConcept: Annotated[ Optional[ParentCodeableConcept], Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1)." ), ] = None url: Annotated[ Optional[str], Field(description="The reference details for the link.", pattern="\\S*"), ] = None class Parent(BaseModel): @model_validator(mode="before") @classmethod def validate_empty_fields(cls, values): """ Iteratively check every field in the model for emptiness. If a field is empty, add it to the error list with its full location. """ if cls.__name__ != "DocumentReference" or not values: return values stack = [(None, values)] empty_fields = [] while stack: path, current_value = stack.pop() if isinstance(current_value, dict): cls.handle_dict(current_value, path, stack, empty_fields) elif isinstance(current_value, list): cls.handle_list(current_value, path, stack, empty_fields) elif isinstance(current_value, Parent): cls.handle_nested_model(current_value, path, stack) else: cls.handle_scalar(current_value, path, empty_fields) if empty_fields: raise ValueError( f"The following fields are empty: {', '.join(empty_fields)}" ) return values @staticmethod def handle_dict(current_value, path, stack, empty_fields): """ Handle validation for dictionary fields. """ for key, value in current_value.items(): full_path = f"{path}.{key}" if path else key if value is None or value == "" or (isinstance(value, list) and not value): empty_fields.append(full_path) else: stack.append((full_path, value)) if not current_value: empty_fields.append(path) @staticmethod def handle_list(current_value, path, stack, empty_fields): """ Handle validation for list fields. """ for index, item in enumerate(current_value): full_path = f"{path}[{index}]" if path else f"[{index}]" if item is None or item == "" or (isinstance(item, dict) and not item): empty_fields.append(full_path) else: stack.append((full_path, item)) @staticmethod def handle_nested_model(current_value, path, stack): """ Handle validation for nested Pydantic models. """ nested_values = current_value.model_dump(exclude_none=True) for nested_field, nested_value in nested_values.items(): full_path = f"{path}.{nested_field}" if path else nested_field stack.append((full_path, nested_value)) @staticmethod def handle_scalar(current_value, path, empty_fields): """ Handle validation for scalar fields. """ if current_value is None or current_value == "": empty_fields.append(path) model_config = ConfigDict(regex_engine="python-re", extra="forbid") extension: Annotated[ Optional[List[ParentExtension]], Field(description="A list of relevant extensions"), ] = None NRLF-3.0.31/layer/nrlf/core/request.py000066400000000000000000000107211511201605300174010ustar00rootroot00000000000000import json from typing import Dict, Type from pydantic import BaseModel, ValidationError from nrlf.core.codes import SpineErrorConcept from nrlf.core.constants import CLIENT_RP_DETAILS, CONNECTION_METADATA from nrlf.core.errors import OperationOutcomeError, ParseError from nrlf.core.json_duplicate_checker import check_duplicate_keys from nrlf.core.logger import LogReference, logger from nrlf.core.model import ClientRpDetails, ConnectionMetadata def parse_headers(headers: Dict[str, str]) -> ConnectionMetadata: """ Parses the connection metadata and client rp details from the headers passed from Apigee """ case_insensitive_headers = {key.lower(): value for key, value in headers.items()} try: raw_connection_metadata = json.loads( case_insensitive_headers.get(CONNECTION_METADATA, "{}") ) raw_client_rp_details = json.loads( case_insensitive_headers.get(CLIENT_RP_DETAILS, "{}") ) client_rp_details = ClientRpDetails.model_validate(raw_client_rp_details) return ConnectionMetadata.model_validate( {**raw_connection_metadata, "client_rp_details": client_rp_details} ) except (ValidationError, json.JSONDecodeError): raise OperationOutcomeError( status_code="401", severity="error", code="invalid", details=SpineErrorConcept.from_code("MISSING_OR_INVALID_HEADER"), diagnostics=( "Unable to parse metadata about the requesting application. " "Contact the onboarding team." ), ) from None def parse_params( model: Type[BaseModel] | None, query_string_params: Dict[str, str] | None, ) -> BaseModel | None: if not model: return None logger.log( LogReference.HANDLER006, params=query_string_params, model=model.__name__, ) try: result = model.model_validate(query_string_params or {}) logger.log(LogReference.HANDLER007, parsed_params=result.model_dump()) return result except ValidationError as exc: raise ParseError.from_validation_error( exc, details=SpineErrorConcept.from_code("INVALID_PARAMETER"), msg="Invalid query parameter", ) from None def parse_body( model: Type[BaseModel] | None, body: str | None, ) -> BaseModel | None: if not model: return None logger.log(LogReference.HANDLER008, body=body, model=model.__name__) if not body: raise OperationOutcomeError( status_code="400", severity="error", code="invalid", details=SpineErrorConcept.from_code("BAD_REQUEST"), diagnostics="Request body is required", ) try: result = model.model_validate_json(body) raise_when_duplicate_keys(body) logger.log(LogReference.HANDLER009, parsed_body=result.model_dump()) return result except ValidationError as exc: raise ParseError.from_validation_error( exc, details=SpineErrorConcept.from_code("MESSAGE_NOT_WELL_FORMED"), msg="Request body could not be parsed", ) from None def raise_when_duplicate_keys(json_content: str) -> None: """ Raises an error if duplicate keys are found in the JSON content. """ logger.log(LogReference.HANDLER018) duplicates, paths = check_duplicate_keys(json_content) if duplicates: error = OperationOutcomeError( severity="error", code="invalid", details=SpineErrorConcept.from_code("MESSAGE_NOT_WELL_FORMED"), diagnostics=f"Duplicate keys found in FHIR document: {duplicates}", expression=paths, ) logger.log(LogReference.HANDLER019, error=str(error)) raise error def parse_path( model: Type[BaseModel] | None, path_params: Dict[str, str] | None, ) -> BaseModel | None: if not model: return None logger.log( LogReference.HANDLER010, path=path_params, model=model.__name__, ) try: result = model.model_validate(path_params or {}) logger.log(LogReference.HANDLER011, parsed_path=result.model_dump()) return result except ValidationError as exc: raise ParseError.from_validation_error( exc, details=SpineErrorConcept.from_code("INVALID_PARAMETER"), msg="Invalid path parameter", ) from None NRLF-3.0.31/layer/nrlf/core/response.py000066400000000000000000000231761511201605300175570ustar00rootroot00000000000000# ruff: noqa: N803, N815 from typing import List from pydantic import BaseModel, Field from nrlf.core.codes import NRLResponseConcept, SpineErrorConcept from nrlf.core.constants import PRODUCER_URL_PATH from nrlf.producer.fhir.r4 import model as producer_model class Response(BaseModel): """ Represents an API Gateway HTTP response. """ statusCode: str body: str headers: dict[str, str] = Field(default_factory=dict[str, str]) isBase64Encoded: bool = Field(default=False) @classmethod def from_resource(cls, resource: BaseModel, **kwargs) -> "Response": status_code = kwargs.pop("statusCode", "200") return cls( statusCode=status_code, body=resource.model_dump_json( indent=2, exclude_none=True, exclude_defaults=True ), **kwargs, ) @classmethod def from_issues(cls, issues: List[BaseModel], **kwargs) -> "Response": return cls( body=producer_model.OperationOutcome( resourceType="OperationOutcome", issue=issues, # type: ignore ).model_dump_json(exclude_none=True, indent=2), **kwargs, ) @classmethod def from_exception(cls, exc: Exception) -> "Response": return cls( statusCode="500", body=producer_model.OperationOutcome( resourceType="OperationOutcome", issue=[ producer_model.OperationOutcomeIssue( severity="error", code="exception", diagnostics=str(exc), details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"), ) ], ).model_dump_json(exclude_none=True, indent=2), ) class NRLResponse(Response): @classmethod def RESOURCE_CREATED(cls, resource_id: str): return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="information", code="informational", details=NRLResponseConcept.from_code("RESOURCE_CREATED"), diagnostics="The document has been created", ) ], statusCode="201", headers={"Location": f"{PRODUCER_URL_PATH}/{resource_id}"}, ) @classmethod def RESOURCE_SUPERSEDED(cls, resource_id: str): return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="information", code="informational", details=NRLResponseConcept.from_code("RESOURCE_SUPERSEDED"), diagnostics="The document has been superseded by a new version", ) ], statusCode="201", headers={"Location": f"{PRODUCER_URL_PATH}/{resource_id}"}, ) @classmethod def RESOURCE_UPDATED(cls): return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="information", code="informational", details=NRLResponseConcept.from_code("RESOURCE_UPDATED"), diagnostics="The DocumentReference has been updated", ) ], statusCode="200", ) @classmethod def RESOURCE_DELETED(cls): return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="information", code="informational", details=NRLResponseConcept.from_code("RESOURCE_DELETED"), diagnostics="The requested DocumentReference has been deleted", ) ], statusCode="200", ) @classmethod def RESOURCE_DOES_NOT_EXIST_DELETE(cls): return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="information", code="informational", details=NRLResponseConcept.from_code("RESOURCE_DELETED"), diagnostics="The requested DocumentReference could not be found", ) ], statusCode="200", ) class SpineErrorResponse(Response): @classmethod def NO_RECORD_FOUND( cls, diagnostics: str = "The requested resource could not be found" ) -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="not-found", details=SpineErrorConcept.from_code("NO_RECORD_FOUND"), diagnostics=diagnostics, ) ], statusCode="404", ) @classmethod def ACCESS_DENIED(cls, diagnostics: str = "Access denied") -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="forbidden", details=SpineErrorConcept.from_code("ACCESS DENIED"), diagnostics=diagnostics, ) ], statusCode="403", ) @classmethod def INVALID_IDENTIFIER_VALUE( cls, diagnostics: str = "Invalid identifier value", expression: str | None = None, ): return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="invalid", details=SpineErrorConcept.from_code("INVALID_IDENTIFIER_VALUE"), diagnostics=diagnostics, expression=( [producer_model.ExpressionItem(root=expression)] if expression else None ), ) ], statusCode="400", ) @classmethod def INVALID_NHS_NUMBER( cls, diagnostics: str = "Invalid NHS number", expression: str | None = None ) -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="invalid", details=SpineErrorConcept.from_code("INVALID_NHS_NUMBER"), diagnostics=diagnostics, expression=( [producer_model.ExpressionItem(root=expression)] if expression else None ), ) ], statusCode="400", ) @classmethod def INVALID_CODE_SYSTEM( cls, diagnostics: str = "Invalid code system", expression: str | None = None ) -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="code-invalid", details=SpineErrorConcept.from_code("INVALID_CODE_SYSTEM"), diagnostics=diagnostics, expression=( [producer_model.ExpressionItem(root=expression)] if expression else None ), ) ], statusCode="400", ) @classmethod def BAD_REQUEST( cls, diagnostics: str = "Bad request", expression: str | None = None ) -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="invalid", details=SpineErrorConcept.from_code("BAD_REQUEST"), diagnostics=diagnostics, expression=( [producer_model.ExpressionItem(root=expression)] if expression else None ), ) ], statusCode="400", ) @classmethod def UNPROCESSABLE_ENTITY( cls, diagnostics: str = "Unprocessable Entity", expression: str | None = None ) -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="business-rule", details=SpineErrorConcept.from_code("UNPROCESSABLE_ENTITY"), diagnostics=diagnostics, expression=( [producer_model.ExpressionItem(root=expression)] if expression else None ), ) ], statusCode="422", ) @classmethod def AUTHOR_CREDENTIALS_ERROR( cls, diagnostics: str, expression: str | None = None ) -> "Response": return cls.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="forbidden", details=SpineErrorConcept.from_code("AUTHOR_CREDENTIALS_ERROR"), diagnostics=diagnostics, expression=( [producer_model.ExpressionItem(root=expression)] if expression else None ), ) ], statusCode="403", ) NRLF-3.0.31/layer/nrlf/core/tests/000077500000000000000000000000001511201605300165005ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/core/tests/__init__.py000066400000000000000000000000001511201605300205770ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/core/tests/test_codes.py000066400000000000000000000047701511201605300212160ustar00rootroot00000000000000import pytest from nrlf.core.codes import NRLResponseConcept, SpineErrorConcept, _CodeableConcept # TODO-NOW Fix up these codes impls to work better in test cases def test_from_code_known_code(): # Arrange code = "ABC" expected_text = "ABC Text" _CodeableConcept._TEXT_MAP = {"ABC": expected_text} _CodeableConcept._SYSTEM = "http://example.com" # Act result = _CodeableConcept.from_code(code) # Assert assert result.coding is not None assert len(result.coding) == 1 assert result.coding[0].system == _CodeableConcept._SYSTEM assert result.coding[0].code == code assert result.coding[0].display == expected_text def test_from_code_unknown_code(): # Arrange code = "XYZ" _CodeableConcept._TEXT_MAP = {"ABC": "ABC Text"} _CodeableConcept._SYSTEM = "http://example.com" # Act & Assert with pytest.raises(ValueError, match="Unknown code: XYZ"): _CodeableConcept.from_code(code) @pytest.mark.parametrize( ("code", "expected_text"), [ ("RESOURCE_CREATED", "Resource created"), ("RESOURCE_SUPERSEDED", "Resource created and resource(s) deleted"), ("RESOURCE_UPDATED", "Resource updated"), ("RESOURCE_DELETED", "Resource deleted"), ], ) def test_nrl_response_concept_from_code(code, expected_text): # Act result = NRLResponseConcept.from_code(code) # Assert assert result.coding is not None assert len(result.coding) == 1 assert result.coding[0].system == NRLResponseConcept._SYSTEM assert result.coding[0].code == code assert result.coding[0].display == expected_text @pytest.mark.parametrize( ("code", "expected_text"), [ ("NO_RECORD_FOUND", "No record found"), ("INVALID_NHS_NUMBER", "Invalid NHS number"), ("INVALID_CODE_SYSTEM", "Invalid code system"), ("INTERNAL_SERVER_ERROR", "Unexpected internal server error"), ("BAD_REQUEST", "Bad request"), ("AUTHOR_CREDENTIALS_ERROR", "Author credentials error"), ("DUPLICATE_REJECTED", "Create would lead to creation of a duplicate resource"), ("UNPROCESSABLE_ENTITY", "Unprocessable Entity"), ], ) def test_spine_error_concept_from_code(code, expected_text): # Act result = SpineErrorConcept.from_code(code) # Assert assert result.coding is not None assert len(result.coding) == 1 assert result.coding[0].system == SpineErrorConcept._SYSTEM assert result.coding[0].code == code assert result.coding[0].display == expected_text NRLF-3.0.31/layer/nrlf/core/tests/test_config.py000066400000000000000000000043231511201605300213600ustar00rootroot00000000000000import os import pytest from pydantic import ValidationError from nrlf.core.config import Config def test_config_valid(): # Arrange env_vars = { "AUTH_STORE": "auth-store", "AWS_REGION": "eu-west-2", "PREFIX": "nrlf", "ENVIRONMENT": "production", "SPLUNK_INDEX": "logs", "SOURCE": "app", } # Act config = Config(**env_vars) # Assert assert env_vars["AUTH_STORE"] == config.AUTH_STORE assert env_vars["AWS_REGION"] == config.AWS_REGION assert env_vars["PREFIX"] == config.PREFIX assert env_vars["ENVIRONMENT"] == config.ENVIRONMENT assert env_vars["SPLUNK_INDEX"] == config.SPLUNK_INDEX assert env_vars["SOURCE"] == config.SOURCE def test_config_missing_env_vars(): # Arrange env_vars = {} _current_env_vars = os.environ.copy() os.environ.clear() # Act & Assert with pytest.raises(ValidationError): Config(**env_vars) os.environ.update(_current_env_vars) def test_config_invalid_env_vars(): # Arrange env_vars = { "AUTH_STORE": "auth-store", "AWS_REGION": "eu-west-2", "PREFIX": "nrlf", "ENVIRONMENT": "production", "SOURCE": "app", } # Missing SPLUNK_INDEX _current_env_vars = os.environ.copy() os.environ.clear() # Act & Assert with pytest.raises(ValidationError) as e: Config(**env_vars) assert "SPLUNK_INDEX" in str(e.value) assert "Field required" in str(e.value) os.environ.update(_current_env_vars) def test_config_reads_from_env_variables(): # Arrange env_vars = { "AUTH_STORE": "auth-store", "AWS_REGION": "eu-west-2", "PREFIX": "nrlf", "ENVIRONMENT": "production", "SPLUNK_INDEX": "logs", "SOURCE": "app", } current_env = os.environ.copy() os.environ.update(env_vars) # Act config = Config() # Assert assert env_vars["AWS_REGION"] == config.AWS_REGION assert env_vars["PREFIX"] == config.PREFIX assert env_vars["ENVIRONMENT"] == config.ENVIRONMENT assert env_vars["SPLUNK_INDEX"] == config.SPLUNK_INDEX assert env_vars["SOURCE"] == config.SOURCE os.environ.clear() os.environ.update(current_env) NRLF-3.0.31/layer/nrlf/core/tests/test_decorators.py000066400000000000000000000653431511201605300222710ustar00rootroot00000000000000import json import warnings from typing import Any import pytest from aws_lambda_powertools.utilities.data_classes import APIGatewayProxyEvent from pydantic import BaseModel from pytest_mock import MockerFixture from nrlf.core.authoriser import parse_permissions_file from nrlf.core.codes import SpineErrorConcept from nrlf.core.config import Config from nrlf.core.constants import ( PERMISSION_ALLOW_ALL_POINTER_TYPES, X_REQUEST_ID_HEADER, PointerTypes, ) from nrlf.core.decorators import ( deprecated, error_handler, header_handler, load_connection_metadata, logger_initialiser, request_handler, verify_request_ids, ) from nrlf.core.errors import OperationOutcomeError from nrlf.core.logger import LogReference from nrlf.core.request import parse_headers from nrlf.core.response import Response from nrlf.tests.events import ( create_headers, create_mock_context, create_test_api_gateway_event, default_response_headers, ) def test_error_handler_decorator(): @error_handler def decorated_function(): return {"message": "Hello, World!"} result = decorated_function() assert result == {"message": "Hello, World!"} def test_operation_outcome_error(): @error_handler def decorated_function(): raise OperationOutcomeError( status_code="401", severity="error", code="unauthorized", details=SpineErrorConcept.from_code("AUTHOR_CREDENTIALS_ERROR"), diagnostics="The requested DocumentReference cannot be read because it belongs to another organisation", ) result = decorated_function() assert result["statusCode"] == "401" assert result["headers"] == {} assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "unauthorized", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error", } ] }, "diagnostics": "The requested DocumentReference cannot be read because it belongs to another organisation", } ], } def test_error_handler_decorator_error_handling(): @error_handler def decorated_function(): raise Exception("Something went wrong") result = decorated_function() assert result["statusCode"] == "500" assert result["headers"] == {} assert result["isBase64Encoded"] is False # The body is a JSON string, so we need to parse it to compare the contents parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", } ] }, "diagnostics": "Something went wrong", } ], } def test_header_handler_happy_path(): @header_handler def decorated_function(event): return { "headers": { "Content-Type": "application/json", } } test_event = create_test_api_gateway_event() event = APIGatewayProxyEvent(test_event) response = decorated_function(event) assert response["headers"] == { **default_response_headers(), "Content-Type": "application/json", } def test_header_handler_when_correlation_id_is_also_present(): @header_handler def decorated_function(event): return { "headers": { "Content-Type": "application/json", } } test_event = create_test_api_gateway_event( headers={ **create_headers(), "X-Correlation-Id": "test_correlation_id", } ) event = APIGatewayProxyEvent(test_event) response = decorated_function(event) assert response["headers"] == { **default_response_headers(), "Content-Type": "application/json", "X-Correlation-Id": "test_correlation_id", } def test_header_handler_when_no_response_headers(): @header_handler def decorated_function(event): return {} test_event = create_test_api_gateway_event() event = APIGatewayProxyEvent(test_event) response = decorated_function(event) assert response["headers"] == default_response_headers() def test_header_handler_when_no_echoed_headers(): @header_handler def decorated_function(event): return { "headers": { "Content-Type": "application/json", } } test_event = create_test_api_gateway_event(headers={"X-None-Echoed-Header": "test"}) event = APIGatewayProxyEvent(test_event) response = decorated_function(event) assert response["headers"] == { "Content-Type": "application/json", } def test_header_handler_with_overwritten_response_headers(): @header_handler def decorated_function(event): return { "headers": { "Content-Type": "application/json", "X-Request-Id": "test_request_id_overwrite_me", "X-Correlation-Id": "test_correlation_id_overwrite_me", } } test_event = create_test_api_gateway_event( headers={ **create_headers(), "X-Correlation-Id": "test_correlation_id", } ) event = APIGatewayProxyEvent(test_event) response = decorated_function(event) assert response["headers"] == { "Content-Type": "application/json", "X-Request-Id": "test_request_id", "X-Correlation-Id": "test_correlation_id", } def test_header_handler_when_response_header_checks_fail(mocker: MockerFixture): @header_handler def decorated_function(event): return { "headers": { "Content-Type": "application/json", "X-Request-Id": "test_request_id_not_overwritten", "X-Correlation-Id": "test_correlation_id_not_overwritten", } } event = mocker.MagicMock() event.get_header_value.side_effect = Exception("Test exception") response = decorated_function(event) assert response["headers"] == { "Content-Type": "application/json", "X-Request-Id": "test_request_id_not_overwritten", "X-Correlation-Id": "test_correlation_id_not_overwritten", } def test_logger_initialiser_happy_path(mocker: MockerFixture): mock_logger = mocker.patch("nrlf.core.decorators.logger") @logger_initialiser def decorated_function(event): return {} test_event = create_test_api_gateway_event() event = APIGatewayProxyEvent(test_event) decorated_function(event) mock_logger.set_correlation_id.assert_called_once_with("test_correlation_id") def test_logger_initialiser_no_correlation_id(mocker: MockerFixture): mock_logger = mocker.patch("nrlf.core.decorators.logger") @logger_initialiser def decorated_function(event): return {} test_event = create_test_api_gateway_event( headers={ **create_headers(), "NHSD-Correlation-Id": None, } ) event = APIGatewayProxyEvent(test_event) decorated_function(event) mock_logger.set_correlation_id.assert_not_called() mock_logger.log.assert_called_once_with( LogReference.HANDLER017, id_header="NHSD-Correlation-Id", headers=test_event["headers"], ) def test_log_includes_client_cert_details(mocker: MockerFixture): @request_handler() def decorated_function() -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) test_event = create_test_api_gateway_event() event = APIGatewayProxyEvent(test_event) mock_logger = mocker.patch("nrlf.core.decorators.logger") decorated_function(event, create_mock_context()) assert any( call[1]["code"].name == "HANDLER000" for call in mock_logger.log.call_args_list if call[1] ) logged_cert_info: dict[str, Any] = [ call[1:][0] for call in mock_logger.log.call_args_list if call[1] and "code" in call[1] and call[1]["code"].name == "HANDLER000" ][0]["client_cert_info"] client_cert = event.request_context.identity.client_cert assert logged_cert_info == { "subject_dn": client_cert.subject_dn, "issuer_dn": client_cert.issuer_dn, "serial_number": client_cert.serial_number, } def test_log_includes_client_cert_details_when_no_cert(mocker: MockerFixture): @request_handler() def decorated_function() -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) test_event = create_test_api_gateway_event() test_event["requestContext"]["identity"]["clientCert"] = None event = APIGatewayProxyEvent(test_event) mock_logger = mocker.patch("nrlf.core.decorators.logger") decorated_function(event, create_mock_context()) assert any( call[1]["code"].name == "HANDLER000" for call in mock_logger.log.call_args_list if call[1] ) logged_cert_info: dict[str, Any] = [ call[1:][0] for call in mock_logger.log.call_args_list if call[1] and "code" in call[1] and call[1]["code"].name == "HANDLER000" ][0]["client_cert_info"] assert logged_cert_info == "No client certificate provided" def test_verify_request_id_happy_path(): test_event = create_test_api_gateway_event() event = APIGatewayProxyEvent(test_event) verify_request_ids(event) def test_verify_request_id_no_request_id(): test_event = create_test_api_gateway_event() test_event["headers"].pop(X_REQUEST_ID_HEADER) event = APIGatewayProxyEvent(test_event) with pytest.raises(OperationOutcomeError) as err: verify_request_ids(event) assert err.value.status_code == "400" assert err.value.operation_outcome.resourceType == "OperationOutcome" assert err.value.operation_outcome.issue[0].severity == "error" assert err.value.operation_outcome.issue[0].code == "invalid" assert err.value.operation_outcome.issue[0].details == SpineErrorConcept.from_code( "MISSING_OR_INVALID_HEADER" ) assert ( err.value.operation_outcome.issue[0].diagnostics == "The X-Request-Id header is missing or invalid" ) assert err.value.operation_outcome.issue[0].expression == None def test_verify_request_id_no_correlation_id(): test_event = create_test_api_gateway_event() test_event["headers"].pop("NHSD-Correlation-Id") event = APIGatewayProxyEvent(test_event) with pytest.raises(OperationOutcomeError) as err: verify_request_ids(event) assert err.value.status_code == "400" assert err.value.operation_outcome.resourceType == "OperationOutcome" assert err.value.operation_outcome.issue[0].severity == "error" assert err.value.operation_outcome.issue[0].code == "invalid" assert err.value.operation_outcome.issue[0].details == SpineErrorConcept.from_code( "MISSING_OR_INVALID_HEADER" ) assert ( err.value.operation_outcome.issue[0].diagnostics == "The NHSD-Correlation-Id header is missing or invalid" ) assert err.value.operation_outcome.issue[0].expression == None def test_request_handler_defaults(): @request_handler() def decorated_function() -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event(headers=create_headers()) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "200" assert result["headers"] == { "Content-Type": "application/json", **default_response_headers(), } assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == {"message": "Hello, World!"} def test_request_handler_with_params(): class MockParams(BaseModel): param1: str param2: int @request_handler(params=MockParams) def decorated_function(params) -> Response: return Response( statusCode="200", body=params.model_dump_json(exclude_none=True), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters={"param1": "test", "param2": "123"}, ) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "200" assert result["headers"] == { "Content-Type": "application/json", **default_response_headers(), } assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == {"param1": "test", "param2": 123} def test_request_handler_with_params_missing_params(): class MockParams(BaseModel): param1: str param2: int @request_handler(params=MockParams) def decorated_function(params) -> Response: return Response( statusCode="200", body=params.model_dump_json(exclude_none=True), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event( headers=create_headers(), query_string_parameters=None ) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "400" assert result["headers"] == default_response_headers() assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_PARAMETER", "display": "Invalid parameter", } ] }, "diagnostics": "Invalid query parameter (param1: Field required)", "expression": ["param1"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_PARAMETER", "display": "Invalid parameter", } ] }, "diagnostics": "Invalid query parameter (param2: Field required)", "expression": ["param2"], }, ], } def test_request_handler_with_body(): class MockBody(BaseModel): param1: str param2: int @request_handler(body=MockBody) def decorated_function(event, context, config, metadata, body) -> Response: return Response( statusCode="200", body=body.model_dump_json(exclude_none=True), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps({"param1": "test", "param2": 123}) ) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "200" assert result["headers"] == { "Content-Type": "application/json", **default_response_headers(), } assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == {"param1": "test", "param2": 123} def test_request_handler_with_body_missing_body(): class MockBody(BaseModel): param1: str param2: int @request_handler(body=MockBody) def decorated_function(event, context, config, metadata, body) -> Response: return Response( statusCode="200", body=body.model_dump_json(exclude_none=True), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event(headers=create_headers(), body=None) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "400" assert result["headers"] == default_response_headers() assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Request body is required", } ], } def test_request_handler_with_body_invalid_body(): class MockBody(BaseModel): param1: str param2: int @request_handler(body=MockBody) def decorated_function(event, context, config, metadata, body) -> Response: return Response( statusCode="200", body=body.model_dump_json(exclude_none=True), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event( headers=create_headers(), body=json.dumps({"param1": {"invalid": "value"}, "param2": "invalid"}), ) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "400" assert result["headers"] == default_response_headers() assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (param1: Input should be a valid string)", "expression": ["param1"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ], }, "diagnostics": "Request body could not be parsed (param2: Input should be a valid integer, unable to parse string as an integer)", "expression": ["param2"], }, ], } def test_request_handler_with_request_verification(mocker: MockerFixture): parse_headers_mock = mocker.patch("nrlf.core.decorators.parse_headers") @request_handler(skip_request_verification=True) def decorated_function(event, context) -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event() context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "200" assert result["headers"] == { "Content-Type": "application/json", **default_response_headers(), } assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == {"message": "Hello, World!"} assert parse_headers_mock.called is False def test_request_handler_with_missing_request_id(mocker: MockerFixture): parse_headers_mock = mocker.patch("nrlf.core.decorators.parse_headers") @request_handler(skip_request_verification=False) def decorated_function(event, context) -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event() context = create_mock_context() event["headers"].pop(X_REQUEST_ID_HEADER) result = decorated_function(event, context) assert result["statusCode"] == "400" assert result["headers"] == {} assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MISSING_OR_INVALID_HEADER", "display": "There is a required header missing or invalid", } ] }, "diagnostics": "The X-Request-Id header is missing or invalid", } ], } assert parse_headers_mock.called is False def test_request_handler_with_invalid_headers(): @request_handler() def decorated_function(event, context, config, metadata) -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event( headers={ **create_headers(), "nhsd-connection-metadata": "invalid", "nhsd-client-rp-details": "invalid", } ) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "401" assert result["headers"] == default_response_headers() assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MISSING_OR_INVALID_HEADER", "display": "There is a required header missing or invalid", } ] }, "diagnostics": "Unable to parse metadata about the requesting application. Contact the onboarding team.", } ], } def test_request_load_connection_metadata_with_permission_headers(): expected_metadata = load_connection_metadata( headers=create_headers(nrl_permissions=[PERMISSION_ALLOW_ALL_POINTER_TYPES]), config=Config(), ) assert expected_metadata.pointer_types == PointerTypes.list() def test_request_load_connection_metadata_with_no_permission_lookup_or_file(): expected_metadata = load_connection_metadata( headers=create_headers(nrl_app_id="someId"), config=Config() ) assert expected_metadata.pointer_types == [] def test_request_parse_permission_file_with_no_permission_file(): expected_metadata = parse_permissions_file( connection_metadata=parse_headers(create_headers(ods_code="SomeCode")), ) assert expected_metadata == [] def test_request_parse_permission_file_with_permission_file(): expected_metadata = parse_permissions_file( connection_metadata=parse_headers(create_headers(ods_code="TestCode")), ) assert expected_metadata == ["http://snomed.info/sct|736253001"] def test_request_handler_with_custom_repository(mocker: MockerFixture): repository_mock = mocker.Mock() @request_handler(repository=repository_mock) def decorated_function(event, context, config, metadata, repository) -> Response: return Response( statusCode="200", body=json.dumps({"message": "Hello, World!"}), headers={"Content-Type": "application/json"}, ) event = create_test_api_gateway_event(headers=create_headers()) context = create_mock_context() result = decorated_function(event, context) assert result["statusCode"] == "200" assert result["headers"] == { "Content-Type": "application/json", **default_response_headers(), } assert result["isBase64Encoded"] is False parsed_body = json.loads(result["body"]) assert parsed_body == {"message": "Hello, World!"} repository_mock.assert_called_once() assert repository_mock.call_args.kwargs == { "table_name": "unit-test-document-pointer", } def test_deprecated_decorator(): @deprecated("This function is deprecated.") def deprecated_function(): """This function is deprecated.""" with warnings.catch_warnings(record=True) as warning_list: deprecated_function() assert len(warning_list) == 1 assert issubclass(warning_list[0].category, DeprecationWarning) assert ( str(warning_list[0].message) == "Call to deprecated function deprecated_function. This function is deprecated." ) NRLF-3.0.31/layer/nrlf/core/tests/test_errors.py000066400000000000000000000072421511201605300214320ustar00rootroot00000000000000import json import pytest from pydantic import BaseModel, ValidationError from nrlf.core.errors import OperationOutcomeError, ParseError from nrlf.core.response import Response from nrlf.producer.fhir.r4.model import CodeableConcept, OperationOutcomeIssue def test_operation_outcome_error(): severity = "error" code = "invalid" details = CodeableConcept(text="Invalid input") diagnostics = "Invalid input provided" expression = ["expression"] status_code = "400" error = OperationOutcomeError( severity, code, details, diagnostics, expression, status_code ) assert isinstance(error, Exception) assert error.status_code == status_code assert error.operation_outcome.model_dump(exclude_none=True) == { "resourceType": "OperationOutcome", "issue": [ { "severity": severity, "code": code, "details": {"text": "Invalid input"}, "diagnostics": diagnostics, "expression": expression, } ], } response = error.response assert isinstance(response, Response) assert response.model_dump() == { "statusCode": status_code, "body": error.operation_outcome.model_dump_json(exclude_none=True, indent=2), "headers": {}, "isBase64Encoded": False, } def test_parse_error(): issues = [ OperationOutcomeIssue( severity="error", code="invalid", details=CodeableConcept(text="Invalid input"), ) ] error = ParseError(issues) assert isinstance(error, Exception) assert error.issues == issues response = error.response assert isinstance(response, Response) assert error.response.model_dump() == { "statusCode": "400", "body": json.dumps( { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": {"text": "Invalid input"}, } ], }, indent=2, ), "headers": {}, "isBase64Encoded": False, } def test_parse_error_from_validation_error(): class TestModel(BaseModel): test_field: str with pytest.raises(ValidationError) as error: TestModel.model_validate({}) exc = error.value details = CodeableConcept(text="Invalid input") msg = "Validation failed" error = ParseError.from_validation_error(exc, details, msg) assert isinstance(error, Exception) assert [issue.model_dump(exclude_none=True) for issue in error.issues] == [ { "severity": "error", "code": "invalid", "details": {"text": "Invalid input"}, "diagnostics": "Validation failed (test_field: Field required)", "expression": ["test_field"], } ] response = error.response assert isinstance(response, Response) assert response.model_dump() == { "statusCode": "400", "body": json.dumps( { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": {"text": "Invalid input"}, "diagnostics": "Validation failed (test_field: Field required)", "expression": ["test_field"], } ], }, indent=2, ), "headers": {}, "isBase64Encoded": False, } NRLF-3.0.31/layer/nrlf/core/tests/test_json_duplicate_checker.py000066400000000000000000000271071511201605300246070ustar00rootroot00000000000000import unittest from json_duplicate_checker import check_duplicate_keys class TestJsonDuplicateChecker(unittest.TestCase): def test_no_duplicates(self): json_content = '{"a": 1, "b": 2, "c": {"d": 3, "e": 4}}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, []) self.assertEqual(paths, []) def test_simple_duplicates(self): json_content = '{"a": 1, "b": 2, "a": 3}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, ["a"]) self.assertEqual(paths, ["DocumentReference.a"]) def test_nested_duplicates(self): # This JSON has no duplicates because the 'b' keys are at different levels json_content = '{"a": {"b": 1}, "c": {"b": 2}, "d": {"e": {"b": 3}}}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, []) self.assertEqual(paths, []) def test_same_level_duplicates(self): # This JSON has duplicates because there are two 'b' keys at the same level json_content = '{"a": {"b": 1, "b": 2}, "c": {"d": 3}}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, ["b"]) self.assertEqual(paths, ["DocumentReference.a.b"]) def test_same_level_duplicates_objects(self): # This JSON has duplicates because there are two 'b' keys at the same level # The difference with above is that the 'b' keys are objects and every element in the object is the same json_content = ( '{"a": {"b": { "f": 4, "g": 5 }, "b": { "f": 4, "g": 5 } }, "c": {"d": 3}}' ) duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, ["b"]) self.assertEqual(paths, ["DocumentReference.a.b"]) def test_multiple_level_duplicates(self): # This JSON has duplicates at multiple levels json_content = '{"a": 1, "b": {"c": 2, "c": 3}, "a": 4}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(sorted(duplicates), sorted(["a", "c"])) self.assertEqual( sorted(paths), sorted(["DocumentReference.a", "DocumentReference.b.c"]) ) def test_invalid_json(self): json_content = "{invalid json}" with self.assertRaises(ValueError): check_duplicate_keys(json_content) def test_complex_nested_duplicates(self): json_content = '{"a": {"b": 1, "c": {"d": 2, "c": 3}}, "a": {"e": 4}}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(sorted(duplicates), sorted(["a"])) self.assertEqual(sorted(paths), sorted(["DocumentReference.a"])) def test_multiple_duplicates_same_path(self): json_content = """ { "a": 1, "b": { "c": 2, "c": 3, "d": { "e": 4, "e": 5, "f": { "g": 6, "g": 7 } } }, "b": { "h": 8 } } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(sorted(duplicates), sorted(["b", "c", "e", "g"])) self.assertEqual( sorted(paths), sorted( [ "DocumentReference.b", "DocumentReference.b.c", "DocumentReference.b.d.e", "DocumentReference.b.d.f.g", ] ), ) def test_no_duplicates_deeply_nested(self): json_content = """ { "a": { "b": { "c": 1 }, "d": { "e": 2 } }, "f": { "g": { "h": 3 } } } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, []) self.assertEqual(paths, []) def test_duplicates_with_arrays(self): json_content = """ { "a": [ {"b": 1, "b": 2}, {"c": 3, "c": 4} ], "d": 5 } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(sorted(duplicates), sorted(["b", "c"])) self.assertEqual( sorted(paths), sorted(["DocumentReference.a[0].b", "DocumentReference.a[1].c"]), ) def test_large_json_with_mixed_duplicates(self): json_content = """ { "a": 1, "b": { "c": 2, "d": 3, "c": 4, "e": { "f": 5, "f": 6, "g": { "h": 7, "h": 8 } } }, "i": { "j": 10, "j": 11 } } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(sorted(duplicates), sorted(["c", "f", "h", "j"])) self.assertEqual( sorted(paths), sorted( [ "DocumentReference.b.c", "DocumentReference.b.e.f", "DocumentReference.b.e.g.h", "DocumentReference.i.j", ] ), ) def test_complex_nested_arrays_with_duplicates(self): json_content = """ { "level1": { "arrays": [ { "a": 1, "a": 2, "nested": { "b": [ {"c": 3, "c": 4}, {"d": 5} ], "b": "duplicate" } }, { "mixed": [ {"e": 6}, {"e": 7, "f": [ {"g": 8, "g": 9}, {"h": {"i": 10, "i": 11}} ]} ], "mixed": "duplicate" } ], "arrays": "duplicate_at_parent" } } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual( sorted(duplicates), sorted(["a", "b", "c", "g", "i", "mixed", "arrays"]) ) self.assertEqual( sorted(paths), sorted( [ "DocumentReference.level1.arrays", "DocumentReference.level1.arrays[0].a", "DocumentReference.level1.arrays[0].nested.b", "DocumentReference.level1.arrays[0].nested.b[0].c", "DocumentReference.level1.arrays[1].mixed", "DocumentReference.level1.arrays[1].mixed[1].f[0].g", "DocumentReference.level1.arrays[1].mixed[1].f[1].h.i", ] ), ) def test_deep_nested_array_object_duplicates(self): json_content = """ { "root": { "level1": [ { "level2": [ [ { "data": 1, "data": 2, "unique": 3 } ], [ { "other": 4, "other": 5 } ] ] } ] } } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(sorted(duplicates), sorted(["data", "other"])) self.assertEqual( sorted(paths), sorted( [ "DocumentReference.root.level1[0].level2[0][0].data", "DocumentReference.root.level1[0].level2[1][0].other", ] ), ) def generate_nested_json(self, depth, current_level=0): """Helper function to generate nested JSON with duplicates at each level.""" if depth == 0: return '{"key": 1, "key": 2}' next_json = self.generate_nested_json(depth - 1, current_level + 1) return f"""{{ "level{current_level}": [ {{ "array_obj": {next_json}, "array_obj": "duplicate_at_depth_{current_level}" }} ] }}""" def get_expected_duplicates(self, max_depth): """Helper function to get expected duplicate keys.""" duplicates = ["array_obj"] # array_obj appears at each level duplicates.extend(["key"]) # key appears at the innermost level return sorted(list(set(duplicates))) def get_expected_paths(self, max_depth): """Helper function to get expected duplicate paths.""" paths = [] current_path = "DocumentReference" # Start from level0 and increment for i in range(max_depth): current_path += f".level{i}[0]" paths.append(f"{current_path}.array_obj") if i < max_depth - 1: # If not at the last level current_path += ".array_obj" # Navigate into the nested object # Add the key duplicate at the innermost level if max_depth > 0: paths.append(f"{current_path}.array_obj.key") return sorted(paths) def test_parametrized_nested_arrays(self): """Test different depths of nested arrays with duplicates at each level.""" for depth in range(1, 11): # Test depths 1 through 10 with self.subTest(depth=depth): json_content = self.generate_nested_json(depth) duplicates, paths = check_duplicate_keys(json_content) expected_duplicates = self.get_expected_duplicates(depth) expected_paths = self.get_expected_paths(depth) self.assertEqual( sorted(duplicates), sorted(expected_duplicates), f"Failed for depth {depth} - duplicates mismatch", ) self.assertEqual( sorted(paths), sorted(expected_paths), f"Failed for depth {depth} - paths mismatch", ) def test_array_edge_case_duplicate(self): json_content = """ { "array": [ 1, "string", {"key": "value"}, [1, 2, 3] ], "array": "duplicate" } """ duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, ["array"]) self.assertEqual(paths, ["DocumentReference.array"]) def test_case_sensitive_keys(self): json_content = '{"a": 1, "A": 2, "aA": 3, "Aa": 4}' duplicates, paths = check_duplicate_keys(json_content) self.assertEqual(duplicates, ["A", "Aa"]) self.assertEqual(paths, ["DocumentReference.A", "DocumentReference.Aa"]) NRLF-3.0.31/layer/nrlf/core/tests/test_json_duplicate_checker_nrlf.py000066400000000000000000000041051511201605300256210ustar00rootroot00000000000000import json import pytest from json_duplicate_checker import check_duplicate_keys from layer.nrlf.tests.data import load_document_reference_data def get_all_fields_from_json(json_str): def extract_fields(data, parent_key=""): fields = [] if isinstance(data, dict): for k, v in data.items(): full_key = f"{parent_key}.{k}" if parent_key else k fields.append(full_key) fields.extend(extract_fields(v, full_key)) elif isinstance(data, list): for i, item in enumerate(data): full_key = f"{parent_key}[{i}]" fields.extend(extract_fields(item, full_key)) return fields data = json.loads(json_str) return extract_fields(data) def duplicate_field_in_json(json_str, field_path): data = json.loads(json_str) path = field_path.replace("]", "").replace("[", ".").split(".") current = data for key in path[:-1]: current = current[int(key) if key.isdigit() else key] field = path[-1] if field in current: duplicate_field = f"{field}_duplicate" current[duplicate_field] = current[field] modified_json_str = json.dumps(data) # Replace the duplicate field name with the original field name to simulate duplication duplicated_json_str = modified_json_str.replace( f'"{duplicate_field}":', f'"{field}":', 1 ) return duplicated_json_str return json_str def load_document_reference_data_with_all_fields(): docref_body = load_document_reference_data("Y05868-736253002-Valid") return get_all_fields_from_json(docref_body) @pytest.mark.parametrize("field", load_document_reference_data_with_all_fields()) def test_parse_body_valid_docref_with_duplicate_keys(field): docref_body = load_document_reference_data("Y05868-736253002-Valid") docref_body = duplicate_field_in_json(docref_body, field) result = check_duplicate_keys(docref_body) node = field.split(".")[-1] assert result[0] == [node] assert result[1] == [f"DocumentReference.{field}"] NRLF-3.0.31/layer/nrlf/core/tests/test_model.py000066400000000000000000000073631511201605300212220ustar00rootroot00000000000000import pytest from pydantic import ValidationError from nrlf.core.model import ( ConnectionMetadata, ConsumerRequestParams, CountRequestParams, ProducerRequestParams, ) def test_connection_metadata(): metadata = ConnectionMetadata.model_validate( { "nrl.pointer-types": ["test"], "nrl.ods-code": "test", "nrl.permissions": ["test"], "nrl.app-id": "test-nrl", "client_rp_details": { "developer.app.name": "test", "developer.app.id": "test", }, } ) assert isinstance(metadata, ConnectionMetadata) assert metadata.pointer_types == ["test"] assert metadata.ods_code == "test" assert metadata.nrl_permissions == ["test"] assert metadata.nrl_app_id == "test-nrl" assert metadata.client_rp_details.developer_app_name == "test" assert metadata.client_rp_details.developer_app_id == "test" def test_producer_request_params(): params = ProducerRequestParams.model_validate( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|9999999999", "type": "test-type", "next-page-token": "page-token", } ) assert isinstance(params, ProducerRequestParams) assert params.subject_identifier is not None assert ( params.subject_identifier.root == "https://fhir.nhs.uk/Id/nhs-number|9999999999" ) assert params.type is not None assert params.type.root == "test-type" assert params.next_page_token is not None assert params.next_page_token.root == "page-token" assert params.nhs_number == "9999999999" def test_consumer_request_params(): params = ConsumerRequestParams.model_validate( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|9999999999", "custodian:identifier": "https://fhir.nhs.uk/Id/ods-organization-code|test", "type": "test-type", "category": "test-category", "next-page-token": "page-token", } ) assert isinstance(params, ConsumerRequestParams) assert params.subject_identifier is not None assert ( params.subject_identifier.root == "https://fhir.nhs.uk/Id/nhs-number|9999999999" ) assert params.custodian_identifier is not None assert ( params.custodian_identifier.root == "https://fhir.nhs.uk/Id/ods-organization-code|test" ) assert params.type is not None assert params.type.root == "test-type" assert params.next_page_token is not None assert params.next_page_token.root == "page-token" assert params.nhs_number == "9999999999" def test_producer_request_params_extra_fields(): with pytest.raises(ValidationError): ProducerRequestParams.model_validate( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|9999999999", "type": "test-type", "extra_field": "extra_value", } ) def test_consumer_request_params_extra_fields(): with pytest.raises(ValidationError): ConsumerRequestParams.model_validate( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|9999999999", "type": "test-type", "extra_field": "extra_value", } ) def test_count_request_params(): params = CountRequestParams.model_validate( { "subject:identifier": "https://fhir.nhs.uk/Id/nhs-number|9999999999", } ) assert isinstance(params, CountRequestParams) assert params.subject_identifier is not None assert ( params.subject_identifier.root == "https://fhir.nhs.uk/Id/nhs-number|9999999999" ) assert params.nhs_number == "9999999999" NRLF-3.0.31/layer/nrlf/core/tests/test_pydantic_errors.py000066400000000000000000000402051511201605300233210ustar00rootroot00000000000000import pytest from nrlf.core.constants import SNOMED_SYSTEM_URL from nrlf.core.errors import ParseError from nrlf.core.validators import DocumentReferenceValidator from nrlf.tests.data import load_document_reference_json def test_validate_content_missing_attachment(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0].pop("attachment") with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (content[0].attachment: Field required)", "expression": ["content[0].attachment"], } def test_validate_content_missing_content_type(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["attachment"].pop("contentType") with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (content[0].attachment.contentType: Field required)", "expression": ["content[0].attachment.contentType"], } def test_validate_content_missing_format(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0].pop("format") with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (content[0].format: Field required)", "expression": ["content[0].format"], } def test_validate_content_invalid_content_stability_code(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Set an invalid code for contentStability extension content_extension = document_ref_data["content"][0]["extension"][0] content_extension["valueCodeableConcept"]["coding"][0]["code"] = "invalid" with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Invalid content stability extension (content[0].extension[0].valueCodeableConcept.coding[0].code: Input should be 'static' or 'dynamic', see: https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability)", "expression": ["content[0].extension[0].valueCodeableConcept.coding[0].code"], } def test_validate_content_invalid_content_stability_display(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Set an invalid display for contentStability extension content_extension = document_ref_data["content"][0]["extension"][0] content_extension["valueCodeableConcept"]["coding"][0]["display"] = "invalid" with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Invalid content stability extension (content[0].extension[0].valueCodeableConcept.coding[0].display: Input should be 'Static' or 'Dynamic', see: https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability)", "expression": [ "content[0].extension[0].valueCodeableConcept.coding[0].display" ], } def test_validate_content_invalid_content_stability_system(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Set an invalid system for contentStability extension content_extension = document_ref_data["content"][0]["extension"][0] content_extension["valueCodeableConcept"]["coding"][0]["system"] = "invalid" with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Invalid content stability extension (content[0].extension[0].valueCodeableConcept.coding[0].system: Input should be 'https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability', see: https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability)", "expression": ["content[0].extension[0].valueCodeableConcept.coding[0].system"], } def test_validate_content_invalid_content_stability_url(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Set an invalid URL for contentStability extension document_ref_data["content"][0]["extension"][0]["url"] = "invalid" with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Invalid content stability extension (content[0].extension[0].url: Input should be 'https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability', see: https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability)", "expression": ["content[0].extension[0].url"], } def test_validate_multiple_codings(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["category"][0] = { "coding": [ { "system": SNOMED_SYSTEM_URL, "code": "734163000", "display": "Care plan", }, { "system": SNOMED_SYSTEM_URL, "code": "734163000", "display": "Care plan", }, { "system": SNOMED_SYSTEM_URL, "code": "734163000", "display": "Care plan", }, ] } with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (category[0].coding: List should have at most 1 item after validation, not 3)", "expression": ["category[0].coding"], } def test_validate_whitespace_strings(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["category"][0] = { "coding": [ { "system": SNOMED_SYSTEM_URL, "code": "734163000", "display": " ", } ] } with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (category[0].coding[0].display: String should match pattern '[\\S]+[ \\r\\n\\t\\S]*')", "expression": ["category[0].coding[0].display"], } def test_validate_no_coding_where_mandatory(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "text": "Description of the clinic in text" } with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (context.practiceSetting.coding: Field required)", "expression": ["context.practiceSetting.coding"], } def test_validate_no_coding_where_optional(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["facilityType"] = { "text": "Description of the facility type in text" } result = validator.validate(document_ref_data) assert result.is_valid def test_validate_missing_system_from_coding_where_mandatory(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "coding": [ { "code": "734163000", "display": "Valid display string", } ] } with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (context.practiceSetting.coding[0].system: Field required)", "expression": ["context.practiceSetting.coding[0].system"], } def test_validate_missing_code_from_coding_where_mandatory(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "coding": [ { "system": SNOMED_SYSTEM_URL, "display": "Valid display string", } ] } with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (context.practiceSetting.coding[0].code: Field required)", "expression": ["context.practiceSetting.coding[0].code"], } def test_validate_missing_display_from_coding_where_mandatory(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "coding": [ { "system": SNOMED_SYSTEM_URL, "code": "788002001", } ] } with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (context.practiceSetting.coding[0].display: Field required)", "expression": ["context.practiceSetting.coding[0].display"], } def test_validate_content_no_content_extension(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0].pop("extension") with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (content[0].extension: Field required)", "expression": ["content[0].extension"], } NRLF-3.0.31/layer/nrlf/core/tests/test_request.py000066400000000000000000000330321511201605300216020ustar00rootroot00000000000000import json import pytest from nrlf.core.errors import OperationOutcomeError, ParseError from nrlf.core.request import parse_body, parse_headers from nrlf.producer.fhir.r4.model import DocumentReference from nrlf.tests.data import load_document_reference_data def test_parse_headers_empty_headers(): headers = {} with pytest.raises(OperationOutcomeError) as error: parse_headers(headers) exc = error.value assert exc.status_code == "401" assert exc.operation_outcome.model_dump(exclude_none=True) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MISSING_OR_INVALID_HEADER", "display": "There is a required header missing or invalid", } ] }, "diagnostics": "Unable to parse metadata about the requesting application. Contact the onboarding team.", } ], } def test_parse_headers_valid_headers(): headers = { "nhsd-connection-metadata": json.dumps( { "nrl.pointer-types": ["pointer_type"], "nrl.ods-code": "X26", "nrl.permissions": ["permission1", "permission2"], "nrl.app-id": "X26-TestApp-12345", } ), "nhsd-client-rp-details": json.dumps( { "developer.app.name": "TestApp", "developer.app.id": "12345", } ), } metadata = parse_headers(headers) assert metadata.pointer_types == ["pointer_type"] assert metadata.ods_code == "X26" assert metadata.nrl_app_id == "X26-TestApp-12345" assert metadata.nrl_permissions == ["permission1", "permission2"] assert metadata.client_rp_details.developer_app_name == "TestApp" assert metadata.client_rp_details.developer_app_id == "12345" def test_parse_headers_invalid_headers(): headers = { "nhsd-connection-metadata": "invalid", "nhsd-client-rp-details": "invalid", } with pytest.raises(OperationOutcomeError) as error: parse_headers(headers) exc = error.value assert exc.status_code == "401" assert exc.operation_outcome.model_dump(exclude_none=True) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MISSING_OR_INVALID_HEADER", "display": "There is a required header missing or invalid", } ], }, "diagnostics": "Unable to parse metadata about the requesting application. Contact the onboarding team.", } ], } def test_parse_headers_case_insensitive(): headers = { "NHSD-Connection-Metadata": json.dumps( { "nrl.pointer-types": ["pointer_type"], "nrl.ods-code": "X26", "nrl.permissions": ["permission1", "permission2"], "nrl.app-id": "X26-App-12345", } ), "NHSD-Client-RP-Details": json.dumps( { "developer.app.name": "TestApp", "developer.app.id": "12345", } ), } metadata = parse_headers(headers) assert metadata.pointer_types == ["pointer_type"] assert metadata.ods_code == "X26" assert metadata.nrl_app_id == "X26-App-12345" assert metadata.nrl_permissions == ["permission1", "permission2"] assert metadata.client_rp_details.developer_app_name == "TestApp" assert metadata.client_rp_details.developer_app_id == "12345" def test_parse_body_no_model_no_body(): body = None model = None result = parse_body(model, body) assert result is None def test_parse_body_valid_docref(): model = DocumentReference docref_body = load_document_reference_data("Y05868-736253002-Valid") result = parse_body(model, docref_body) assert isinstance(result, DocumentReference) # another test similar to test_parse_body_valid_docref but with a duplicate key def test_parse_body_valid_docref_with_duplicate_key(): model = DocumentReference docref_body = load_document_reference_data("Y05868-736253002-Valid") str_to_duplicate = '"docStatus": "final",' docref_body = docref_body.replace(str_to_duplicate, str_to_duplicate * 2) with pytest.raises(OperationOutcomeError) as error: parse_body(model, docref_body) response = error.value.response assert response.statusCode == "400" assert json.loads(response.body) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['docStatus']", "expression": ["DocumentReference.docStatus"], } ], } def test_parse_body_no_body(): model = DocumentReference body = None with pytest.raises(OperationOutcomeError) as error: parse_body(model, body) exc = error.value assert exc.status_code == "400" assert exc.operation_outcome.model_dump(exclude_none=True) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ], }, "diagnostics": "Request body is required", } ], } def test_parse_body_invalid_docref_json(): model = DocumentReference docref_body = load_document_reference_data("Y05868-736253002-Valid") docref_body = docref_body.replace('unstructured"', "unstructured") with pytest.raises(ParseError) as error: parse_body(model, docref_body) response = error.value.response.model_dump() assert response["statusCode"] == "400" assert json.loads(response["body"]) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ], }, "diagnostics": "Request body could not be parsed (DocumentReference: Invalid JSON: control character (\\u0000-\\u001F) found while parsing a string at line 72 column 0)", "expression": ["DocumentReference"], } ], } def test_parse_body_invalid_json(): model = DocumentReference body = '{ "type": "is-not-a-docref" }' with pytest.raises(ParseError) as error: parse_body(model, body) response = error.value.response.model_dump() assert response["statusCode"] == "400" assert json.loads(response["body"]) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (resourceType: Field required)", "expression": ["resourceType"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (status: Field required)", "expression": ["status"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (type: Input should be an object)", "expression": ["type"], }, { "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", }, ], }, "diagnostics": "Request body could not be parsed (category: Field required)", "expression": [ "category", ], "severity": "error", }, { "code": "invalid", "details": { "coding": [ { "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", }, ], }, "diagnostics": "Request body could not be parsed (author: Field required)", "expression": [ "author", ], "severity": "error", }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (content: Field required)", "expression": ["content"], }, { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (context: Field required)", "expression": ["context"], }, ], } def test_parse_body_not_json(): model = DocumentReference body = "is not json" with pytest.raises(ParseError) as error: parse_body(model, body) response = error.value.response assert response.statusCode == "400" assert json.loads(response.body) == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed", } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Invalid JSON: expected value at line 1 column 1)", "expression": ["DocumentReference"], } ], } NRLF-3.0.31/layer/nrlf/core/tests/test_response.py000066400000000000000000000047701511201605300217570ustar00rootroot00000000000000import json from nrlf.core.response import Response from nrlf.producer.fhir.r4 import model as producer_model def test_from_resource(): resource = producer_model.DocumentReference.model_construct(id="test-doc-ref") response = Response.from_resource( resource, statusCode="201", headers={"Content-Type": "application/json"}, isBase64Encoded=True, ) assert isinstance(response, Response) assert response.statusCode == "201" assert response.headers == {"Content-Type": "application/json"} assert response.isBase64Encoded is True parsed_body = json.loads(response.body) assert parsed_body == {"id": "test-doc-ref"} def test_from_issues(): response = Response.from_issues( issues=[ producer_model.OperationOutcomeIssue( severity="error", code="invalid", details=producer_model.CodeableConcept(text="Invalid input"), ) ], statusCode="400", headers={"Content-Type": "application/json"}, isBase64Encoded=False, ) assert isinstance(response, Response) assert response.statusCode == "400" assert response.headers == {"Content-Type": "application/json"} assert response.isBase64Encoded is False body = json.loads(response.body) assert body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": {"text": "Invalid input"}, } ], } def test_from_exception(): exc = Exception("Something went wrong") response = Response.from_exception(exc) assert isinstance(response, Response) assert response.statusCode == "500" assert response.headers == {} assert response.isBase64Encoded is False body = json.loads(response.body) assert body == { "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "exception", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INTERNAL_SERVER_ERROR", "display": "Unexpected internal server error", } ] }, "diagnostics": "Something went wrong", } ], } NRLF-3.0.31/layer/nrlf/core/tests/test_sample_pointers.py000066400000000000000000000024201511201605300233130ustar00rootroot00000000000000import os import pytest from nrlf.consumer.fhir.r4.model import DocumentReference as ConsumerDocumentReference from nrlf.core.validators import DocumentReferenceValidator from nrlf.producer.fhir.r4.model import DocumentReference as ProducerDocumentReference def sample_pointer_files() -> list[str]: return [f for f in os.listdir("./tests/data/samples") if f.endswith(".json")] def load_sample_pointer_data(pointer_file: str) -> str: with open(f"./tests/data/samples/{pointer_file}", "r") as f: return f.read() @pytest.mark.parametrize("sample_pointer_file", sample_pointer_files()) def test_sample_pointer_as_consumer(sample_pointer_file: str): sample_pointer_data = load_sample_pointer_data(sample_pointer_file) docref = ConsumerDocumentReference.model_validate_json(sample_pointer_data) result = DocumentReferenceValidator().validate(data=docref) assert result.is_valid @pytest.mark.parametrize("sample_pointer_file", sample_pointer_files()) def test_sample_pointer_as_producer(sample_pointer_file: str): sample_pointer_data = load_sample_pointer_data(sample_pointer_file) docref = ProducerDocumentReference.model_validate_json(sample_pointer_data) result = DocumentReferenceValidator().validate(data=docref) assert result.is_valid NRLF-3.0.31/layer/nrlf/core/tests/test_type_categories.py000066400000000000000000000040351511201605300233010ustar00rootroot00000000000000import pytest from layer.nrlf.core.constants import ( CATEGORY_ATTRIBUTES, SYSTEM_SHORT_IDS, TYPE_CATEGORIES, Categories, PointerTypes, ) @pytest.mark.parametrize("pointer_type", PointerTypes) def test_pointer_type_has_category(pointer_type): assert ( pointer_type.value in TYPE_CATEGORIES ), f"Pointer type {pointer_type.value} has no category" @pytest.mark.parametrize("pointer_type", PointerTypes) def test_pointer_types(pointer_type): assert ( pointer_type.coding_system() in SYSTEM_SHORT_IDS ), f"Point type system {pointer_type.coding_system()} has no short id" @pytest.mark.parametrize("category", Categories) def test_pointer_category_has_types(category): assert ( category.value in TYPE_CATEGORIES.values() ), f"Pointer category {category.value} is not used by any type" @pytest.mark.parametrize("category", Categories) def test_pointer_category_has_short_code(category): assert ( category.coding_system() in SYSTEM_SHORT_IDS ), f"Pointer category system {category.coding_system()} has no short id" @pytest.mark.parametrize("type", TYPE_CATEGORIES.keys()) def test_type_category_type_is_known(type): assert type in PointerTypes.list(), f"Unknown type {type} used in TYPE_CATEGORIES" @pytest.mark.parametrize("category", TYPE_CATEGORIES.values()) def test_type_category_category_is_known(category): assert ( category in Categories.list() ), f"Unknown category {category} used in TYPE_CATEGORIES" @pytest.mark.parametrize("category", Categories) def test_category_has_attributes(category): assert ( category.value in CATEGORY_ATTRIBUTES ), f"Category {category.value} has no attributes" @pytest.mark.parametrize("category", Categories) def test_category_has_required_attributes(category): assert ( category.value in CATEGORY_ATTRIBUTES ), f"Category {category.value} has no attributes" assert ( "display" in CATEGORY_ATTRIBUTES[category.value] ), f"Category {category.value} has no display attribute" NRLF-3.0.31/layer/nrlf/core/tests/test_utils.py000066400000000000000000000016271511201605300212570ustar00rootroot00000000000000from datetime import datetime, timezone from re import match from freezegun import freeze_time from layer.nrlf.core.utils import create_fhir_instant # FHIR INSTANT refex taken from the spec: https://www.hl7.org/fhir/datatypes.html#instant SPEC_REGEX = r"([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]{1,9})?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))" @freeze_time("2021-01-01") def test_create_fhir_instant_with_time(): time = datetime(2022, 1, 1, 12, 0, 0, 0, timezone.utc) result = create_fhir_instant(time) assert result == "2022-01-01T12:00:00.000Z" assert match(SPEC_REGEX, result) != None @freeze_time("2021-01-01") def test_create_fhir_instant_no_time(): result = create_fhir_instant() assert result == "2021-01-01T00:00:00.000Z" assert match(SPEC_REGEX, result) != None NRLF-3.0.31/layer/nrlf/core/tests/test_validators.py000066400000000000000000002045631511201605300222730ustar00rootroot00000000000000from unittest.mock import Mock import pytest from nrlf.core.constants import ( CATEGORY_ATTRIBUTES, CONTENT_RETRIEVAL_CODE_MAP, ODS_SYSTEM, TYPE_ATTRIBUTES, TYPE_CATEGORIES, PointerTypes, ) from nrlf.core.errors import ParseError from nrlf.core.validators import ( DocumentReferenceValidator, ValidationResult, validate_type, ) from nrlf.producer.fhir.r4.model import ( ContentStabilityExtension, ContentStabilityExtensionCoding, ContentStabilityExtensionValueCodeableConcept, DocumentReference, NRLRetrievalMechanismExtension, NRLRetrievalMechanismExtensionCoding, NRLRetrievalMechanismExtensionValueCodeableConcept, OperationOutcomeIssue, RequestQueryType, ) from nrlf.tests.data import load_document_reference_json def test_validate_type_valid(): type_ = RequestQueryType(root=PointerTypes.MENTAL_HEALTH_PLAN.value) pointer_types = [ PointerTypes.MENTAL_HEALTH_PLAN.value, PointerTypes.EOL_CARE_PLAN.value, ] assert validate_type(type_, pointer_types) is True def test_validate_type_invalid_system(): type_ = RequestQueryType(root="http://snomed.info/invalid|736373009") pointer_types = [ PointerTypes.EOL_CARE_PLAN.value, PointerTypes.EOL_CARE_PLAN.value, ] assert validate_type(type_, pointer_types) is False def test_validate_type_invalid_code(): type_ = RequestQueryType(root=PointerTypes.MRA_UPPER_LIMB_ARTERY.value) pointer_types = [ PointerTypes.MENTAL_HEALTH_PLAN.value, PointerTypes.EOL_CARE_PLAN.value, ] assert validate_type(type_, pointer_types) is False def test_validate_type_empty(): type_ = None pointer_types: list[str] = [] assert validate_type(type_, pointer_types) is True def test_validation_result_reset(): validation_result = ValidationResult( resource=DocumentReference.model_construct(id="example_resource"), issues=[OperationOutcomeIssue.model_construct()], ) assert validation_result.resource.id == "example_resource" validation_result.reset() assert validation_result.resource.id is None assert validation_result.issues == [] def test_validation_result_add_error(): validation_result = ValidationResult( resource=DocumentReference.model_construct(), issues=[] ) issue_code = "issue_code" error_code = "BAD_REQUEST" diagnostics = "diagnostics" field = "field" validation_result.add_error(issue_code, error_code, diagnostics, field) assert len(validation_result.issues) == 1 assert validation_result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "issue_code", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ], }, "diagnostics": "diagnostics", "expression": ["field"], } def test_validation_result_add_error_no_error_code(): validation_result = ValidationResult( resource=DocumentReference.model_construct(), issues=[] ) issue_code = "issue_code" diagnostics = "diagnostics" field = "field" validation_result.add_error( issue_code=issue_code, diagnostics=diagnostics, field=field ) assert len(validation_result.issues) == 1 assert validation_result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "issue_code", "diagnostics": "diagnostics", "expression": ["field"], } def test_validation_result_is_valid(): validation_result = ValidationResult( resource=DocumentReference.model_construct(), issues=[] ) assert validation_result.is_valid is True validation_result.issues = [ OperationOutcomeIssue.model_construct(severity="information"), ] assert validation_result.is_valid is True validation_result.issues = [ OperationOutcomeIssue.model_construct(severity="error"), ] assert validation_result.is_valid is False validation_result.issues = [ OperationOutcomeIssue.model_construct(severity="fatal"), ] assert validation_result.is_valid is False def test_document_reference_validator_init(): validator = DocumentReferenceValidator() assert validator.result.resource.id is None assert validator.result.issues == [] def test_document_reference_validator_parse_valid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") result = validator.parse(document_ref_data) assert result.id == "Y05868-99999-99999-999999" assert result.status == "current" assert result.type assert result.type.coding assert result.type.coding[0].code == "736253002" def test_document_reference_validator_parse_invalid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["id"] = {"value": "invalid"} document_ref_data["type"] = "invalid" with pytest.raises(ParseError) as error: validator.parse(document_ref_data) exc = error.value assert len(exc.issues) == 2 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (id: Input should be a valid string)", "expression": ["id"], } assert exc.issues[1].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (type: Input should be a valid dictionary or instance of NRLCodeableConcept)", "expression": ["type"], } def test_validate_document_reference_valid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") result = validator.validate(document_ref_data) assert result.is_valid is True assert result.resource.id == "Y05868-99999-99999-999999" assert result.issues == [] def test_validate_document_reference_missing_fields(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") del document_ref_data["id"] del document_ref_data["custodian"] del document_ref_data["subject"] result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id is None assert len(result.issues) == 3 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "The required field 'custodian' is missing", "expression": ["custodian"], } diagnostics = [issue.diagnostics for issue in result.issues] assert diagnostics == [ "The required field 'custodian' is missing", "The required field 'id' is missing", "The required field 'subject' is missing", ] def test_validate_document_reference_missing_fields_stops_validation(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") validator._validate_no_extra_fields = Mock() validator._validate_identifiers = Mock() validator._validate_relates_to = Mock() del document_ref_data["custodian"] result = validator.validate(document_ref_data) assert result.is_valid is False assert validator._validate_no_extra_fields.call_count == 0 assert validator._validate_identifiers.call_count == 0 assert validator._validate_relates_to.call_count == 0 def test_validate_document_reference_extra_fields(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["extra_field"] = "extra_value" with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (extra_field: Extra inputs are not permitted)", "expression": ["extra_field"], } def test_validate_document_reference_extra_fields_content(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["extra_field"] = "extra_value" with pytest.raises(ParseError) as error: validator.validate(document_ref_data) exc = error.value assert len(exc.issues) == 1 assert exc.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Failed to parse DocumentReference resource (content[0].extra_field: Extra inputs are not permitted)", "expression": ["content[0].extra_field"], } def test_validate_category_too_many_category(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["category"].append( { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan", } ] } ) result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid category length: 2 Category must only contain a single value", "expression": ["category"], } @pytest.mark.parametrize( "category_code, category_display", [ (category_str.split("|")[1], display_dict["display"]) for category_str, display_dict in CATEGORY_ATTRIBUTES.items() ], ) def test_validate_category_coding_display_mismatch( category_code: str, category_display: str ): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["category"][0] = { "coding": [ { "system": "http://snomed.info/sct", "code": category_code, "display": "some random display name", } ] } # Find the type string that matches the type code to avoid that error category_str = f"http://snomed.info/sct|{category_code}" matching_type_str = next( ( type_str for type_str in TYPE_CATEGORIES if TYPE_CATEGORIES[type_str] == category_str ), None, ) if matching_type_str: type_parts = matching_type_str.split("|") type_system = type_parts[0] type_code = type_parts[1] document_ref_data["type"] = { "coding": [ { "system": type_system, "code": type_code, "display": TYPE_ATTRIBUTES[matching_type_str]["display"], } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": f"category code '{category_code}' must have a display value of '{category_display}'", "expression": ["category[0].coding[0].display"], } def test_validate_category_coding_invalid_code(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["category"][0] = { "coding": [ {"system": "http://snomed.info/sct", "code": "1234", "display": "Care plan"} ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid category code: 1234 Category must be a member of the England-NRLRecordCategory value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordCategory)", "expression": ["category[0].coding[0].code"], } def test_validate_category_coding_invalid_system(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["category"][0] = { "coding": [ { "system": "http://snoooooomed/sctfffffg", "code": "734163000", "display": "Care plan", } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid category system: http://snoooooomed/sctfffffg Category system must be 'http://snomed.info/sct'", "expression": ["category[0].coding[0].system"], } def test_validate_type_coding_invalid_code(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["type"] = { "coding": [ { "system": "http://snomed.info/sct", "code": "1234", "display": "Mental health crisis plan", } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid type code: 1234 Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)", "expression": ["type.coding[0].code"], } def test_validate_type_coding_invalid_system(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["type"] = { "coding": [ { "system": "http://snoooooomed/sctfffffg", "code": "736253002", "display": "Mental health crisis plan", } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid type system: http://snoooooomed/sctfffffg Type system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'", "expression": ["type.coding[0].system"], } @pytest.mark.parametrize( "type_str, display", [ (type_str, display_dict["display"]) for type_str, display_dict in TYPE_ATTRIBUTES.items() ], ) def test_validate_type_coding_display_mismatch(type_str: str, display: str): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") type_parts = type_str.split("|") type_system = type_parts[0] type_code = type_parts[1] document_ref_data["type"] = { "coding": [ { "system": type_system, "code": type_code, "display": "some random display name", } ] } # Find the category string that matches the category code to avoid that error category_str = TYPE_CATEGORIES[type_str] category_parts = category_str.split("|") category_system = category_parts[0] category_code = category_parts[1] document_ref_data["category"][0] = { "coding": [ { "system": category_system, "code": category_code, "display": CATEGORY_ATTRIBUTES[category_str]["display"], } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": f"type code '{type_code}' must have a display value of '{display}'", "expression": ["type.coding[0].display"], } def test_validate_author_too_many_authors(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["author"].append( { "identifier": { "system": ODS_SYSTEM, "value": "someODSCode", } } ) result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid author length: 2 Author must only contain a single value", "expression": ["author"], } def test_validate_author_system_invalid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["author"][0] = { "identifier": { "system": "some system", "value": "someODSCode", } } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": f"Invalid author system: 'some system' Author system must be 'https://fhir.nhs.uk/Id/ods-organization-code'", "expression": ["author[0].identifier.system"], } def test_validate_author_value_invalid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["author"][0] = { "identifier": { "system": ODS_SYSTEM, "value": "!!!!!!12sd", } } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": f"Invalid author value: '!!!!!!12sd' Author value must be alphanumeric", "expression": ["author[0].identifier.value"], } def test_validate_author_value_too_long(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["author"][0] = { "identifier": { "system": ODS_SYSTEM, "value": "d1111111111111111111111111111111111111111111111", } } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": f"Invalid author value: 'd1111111111111111111111111111111111111111111111' Author value must be less than 13 characters", "expression": ["author[0].identifier.value"], } def test_validate_identifiers_invalid_systems(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["custodian"]["identifier"]["system"] = "invalid" document_ref_data["subject"]["identifier"]["system"] = "invalid" result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 2 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Provided custodian identifier system is not the ODS system (expected: 'https://fhir.nhs.uk/Id/ods-organization-code')", "expression": ["custodian.identifier.system"], } assert result.issues[1].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Provided subject identifier system is not the NHS number system (expected 'https://fhir.nhs.uk/Id/nhs-number')", "expression": ["subject.identifier.system"], } def test_validate_relates_to_valid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["relatesTo"] = [ { "code": "replaces", "target": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999", } }, } ] result = validator.validate(document_ref_data) assert result.is_valid is True def test_validate_relates_to_invalid_code(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["relatesTo"] = [ { "code": "invalid", "target": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999", } }, } ] result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid relatesTo code: invalid", "expression": ["relatesTo[0].code"], } def test_validate_ssp_content_with_asid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json( "Y05868-736253002-Valid-with-ssp-content" ) result = validator.validate(document_ref_data) assert result.is_valid is True def test_validate_with_context_related_but_no_asid(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["related"] = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868", } } ] result = validator.validate(document_ref_data) assert result.is_valid is True def test_validate_ssp_content_without_any_context_related(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json( "Y05868-736253002-Valid-with-ssp-content" ) del document_ref_data["context"]["related"] result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Missing context.related. It must be provided and contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } def test_validate_asid_with_no_ssp_content(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["related"] = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "1234", } } ] result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid ASID value '1234'. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[0].identifier.value"], } def test_validate_ssp_content_without_asid_in_context_related(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json( "Y05868-736253002-Valid-with-ssp-content" ) document_ref_data["context"]["related"] = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868", } } ] result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Missing ASID identifier. context.related must contain a single valid ASID identifier when content contains an SSP URL", "expression": ["context.related"], } def test_validate_ssp_content_with_invalid_asid_value(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json( "Y05868-736253002-Valid-with-ssp-content" ) document_ref_data["context"]["related"][0]["identifier"][ "value" ] = "TEST_INVALID_ASID" result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid ASID value 'TEST_INVALID_ASID'. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[0].identifier.value"], } def test_validate_ssp_content_with_invalid_asid_value_and_multiple_related(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json( "Y05868-736253002-Valid-with-ssp-content" ) document_ref_data["context"]["related"] = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868", } } ] document_ref_data["context"]["related"].append( { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y09999", } } ) document_ref_data["context"]["related"].append( { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "TEST_INVALID_ASID", } } ) result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid ASID value 'TEST_INVALID_ASID'. A single ASID consisting of 12 digits can be provided in the context.related field.", "expression": ["context.related[2].identifier.value"], } def test_validate_ssp_content_with_multiple_asids(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json( "Y05868-736253002-Valid-with-ssp-content" ) document_ref_data["context"]["related"][0]["identifier"][ "value" ] = "TEST_INVALID_ASID" document_ref_data["context"]["related"].append( { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "09876543210", } } ) result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Multiple ASID identifiers provided. Only a single valid ASID identifier can be provided in the context.related.", "expression": ["context.related"], } def test_validate_content_format_invalid_code_for_unstructured_document(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["format"] = { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)", } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content format code: urn:nhs-ic:record-contact format code must be 'urn:nhs-ic:unstructured' for Unstructured Document attachments.", "expression": ["content[0].format.code"], } def test_validate_content_format_invalid_code_for_structured_document(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["attachment"]["contentType"] = "application/json" document_ref_data["content"][0]["format"] = { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)", } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content format code: urn:nhs-ic:record-contact format code must be 'urn:nhs-ic:structured' for Structured Document attachments.", "expression": ["content[0].format.code"], } def test_validate_content_format_invalid_code_for_contact_details(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["attachment"]["contentType"] = "text/html" result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content format code: urn:nhs-ic:unstructured format code must be 'urn:nhs-ic:record-contact' for Contact details attachments.", "expression": ["content[0].format.code"], } def test_validate_practiceSetting_coding_invalid_system(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "coding": [ { "system": "http://snoooooomed/sctfffffg", "code": "788002001", "display": "Adult mental health service", } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid practice setting system: http://snoooooomed/sctfffffg Practice Setting system must be 'http://snomed.info/sct'", "expression": ["context.practiceSetting.coding[0].system"], } def test_validate_practiceSetting_coding_invalid_code(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "coding": [ { "system": "http://snomed.info/sct", "code": "123", "display": "Adult mental health service", } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid practice setting code: 123 Practice Setting coding must be a member of value set https://fhir.nhs.uk/England/ValueSet/England-PracticeSetting", "expression": ["context.practiceSetting.coding[0].code"], } def test_validate_practiceSetting_coding_mismatch_code_and_display(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["context"]["practiceSetting"] = { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Nephrology service", } ] } result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid practice setting coding: display Nephrology service does not match the expected display for 788002001 Practice Setting coding is bound to value set https://fhir.nhs.uk/England/ValueSet/England-PracticeSetting", "expression": ["context.practiceSetting.coding[0]"], } def test_validate_content_extension_invalid_code_and_display_mismatch(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["extension"][0] = { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Dynamic", } ] }, } result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content extension display: Dynamic Extension display must be the same as code either 'Static' or 'Dynamic'", "expression": [ "content[0].extension[0].valueCodeableConcept.coding[0].display" ], } def test_validate_content_extension_missing_content_stability(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Remove all ContentStability extensions document_ref_data["content"][0]["extension"] = [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct", } ] }, } ] result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content extension: Extension must have one content stability extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability')", "expression": ["content[0].extension"], } def test_validate_content_extension_mismatch_between_retrieval_mechanism_display_and_code(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Add a retrieval mechanism extension with a valid code but wrong display document_ref_data["content"][0]["extension"].append( { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Spine Secure Proxy", } ] }, } ) result = validator.validate(document_ref_data) assert result.is_valid is False assert result.resource.id == "Y05868-99999-99999-999999" assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content extension display: Spine Secure Proxy Expected display is 'Direct'", "expression": [ "content[0].extension[1].valueCodeableConcept.coding[0].display" ], } def test_validate_content_invalid_content_type(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["attachment"]["contentType"] = "invalid/type" result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid contentType: invalid/type. Must be 'application/pdf', 'text/html' or 'application/fhir+json'", "expression": ["content[0].attachment.contentType"], } @pytest.mark.parametrize( "content_type, format_code, format_display", [ ("text/html", "urn:nhs-ic:record-contact", "Contact details (HTTP Unsecured)"), ("application/pdf", "urn:nhs-ic:unstructured", "Unstructured Document"), ("application/json+fhir", "urn:nhs-ic:structured", "Structured Document"), ], ) def test_validate_nrl_format_code_valid_match( content_type, format_code, format_display ): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["attachment"]["contentType"] = content_type document_ref_data["content"][0]["format"] = { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": format_code, "display": format_display, } result = validator.validate(document_ref_data) assert result.is_valid is True @pytest.mark.parametrize( "content_type, format_code, format_display, expected_display", [ ( "application/pdf", "urn:nhs-ic:unstructured", "Contact details (HTTP Unsecured)", "Unstructured Document", ), ( "text/html", "urn:nhs-ic:record-contact", "Unstructured Document", "Contact details (HTTP Unsecured)", ), ( "application/fhir+json", "urn:nhs-ic:structured", "Unstructured Document", "Structured Document", ), ], ) def test_validate_nrl_format_code_display_mismatch( content_type, format_code, format_display, expected_display ): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["attachment"]["contentType"] = content_type document_ref_data["content"][0]["format"] = { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": format_code, "display": format_display, } result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": f"Invalid display for format code '{format_code}'. Expected '{expected_display}'", "expression": ["content[0].format.display"], } def test_validate_content_multiple_content_stability_extensions(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Add a second duplicate contentStability extension document_ref_data["content"][0]["extension"].append( document_ref_data["content"][0]["extension"][0] ) result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content extension: Extension must have one content stability extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability')", "expression": ["content[0].extension"], } def test_validate_content_multiple_content_retrieval_extensions(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Add 2 content retrieval extensions content_retrieval_extension = { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct", } ] }, } document_ref_data["content"][0]["extension"].append(content_retrieval_extension) document_ref_data["content"][0]["extension"].append(content_retrieval_extension) result = validator.validate(document_ref_data) assert result.is_valid is False assert len(result.issues) == 1 assert result.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity", } ] }, "diagnostics": "Invalid content retrieval extension: Extension must have one content retrieval extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism')", "expression": ["content[0].extension"], } def test_validate_two_content_with_different_retrieval_mechanisms(): """Test that two content items with different retrieval mechanisms are valid.""" validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") unstructured_format = { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document", } static_content_stability = { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static", } ] }, } # Add retrieval mechanism extension to the first content item, ssp first_content = { "attachment": { "contentType": "application/pdf", "url": "ssp://example.com/document1.pdf", }, "format": unstructured_format, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "SSP", "display": "Spine Secure Proxy", } ] }, }, static_content_stability, ], } document_ref_data["content"] = [first_content] # Add valid ASID identifier in context.related document_ref_data["context"]["related"] = [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "123456789012", } } ] result = validator.validate(document_ref_data) assert result.is_valid is True assert len(result.issues) == 0 # Add a second content item with a different retrieval mechanism second_content = { "attachment": { "contentType": "application/pdf", "url": "https://example.com/document2.pdf", }, "format": unstructured_format, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct", } ] }, }, static_content_stability, ], } document_ref_data["content"].append(second_content) result = validator.validate(document_ref_data) assert result.is_valid is True assert len(result.issues) == 0 def test_validate_content_retrieval_lowercase_urls(): """Test that the extension is recognised when 'NRLRetrievalMechanism' is in lowercase and throws an error for mismatching the URL case.""" validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") document_ref_data["content"][0]["extension"] = [ { "url": "https://fhir.nhs.uk/england/structuredefinition/extension-england-nrlretrievalmechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct", } ] }, }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static", } ] }, }, ] with pytest.raises(ParseError) as exc_info: validator.validate(document_ref_data) assert len(exc_info.value.issues) == 1 assert exc_info.value.issues[0].model_dump(exclude_none=True) == { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request", } ] }, "diagnostics": "Invalid content retrieval extension (content[0].extension[0].url: Input should be 'https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism', see: https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism)", "expression": ["content[0].extension[0].url"], } def make_content_stability_extension(code, display): return ContentStabilityExtension( url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", valueCodeableConcept=ContentStabilityExtensionValueCodeableConcept( coding=[ ContentStabilityExtensionCoding( system="https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", code=code, display=display, ) ] ), ) def make_retrieval_mechanism_extension(code, display): return NRLRetrievalMechanismExtension( url="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", valueCodeableConcept=NRLRetrievalMechanismExtensionValueCodeableConcept( coding=[ NRLRetrievalMechanismExtensionCoding( system="https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", code=code, display=display, ) ] ), ) def test_has_valid_extensions(): validator = DocumentReferenceValidator() extensions = [ make_content_stability_extension("static", "Static"), make_retrieval_mechanism_extension("Direct", "Direct"), ] assert validator._has_valid_extensions(extensions, 0) is True def test_has_valid_extensions_multiple_retrieval_mechanism(): validator = DocumentReferenceValidator() extensions = [ make_content_stability_extension("static", "Static"), make_retrieval_mechanism_extension("Direct", "Direct"), make_retrieval_mechanism_extension("SSP", "Spine Secure Proxy"), ] assert validator._has_valid_extensions(extensions, 0) is False assert any( "Invalid content retrieval extension: Extension must have one content retrieval extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism')" in issue.diagnostics for issue in validator.result.issues ) def test_no_content_extensions(): validator = DocumentReferenceValidator() extensions = [] assert validator._has_valid_extensions(extensions, 0) is False assert any( "Invalid content extension: Extension must have one content stability extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability')" in issue.diagnostics for issue in validator.result.issues ) @pytest.mark.parametrize( "code, display", [("static", "Static"), ("dynamic", "Dynamic")] ) def test_validate_content_stability_extension_valid(code, display): validator = DocumentReferenceValidator() ext = make_content_stability_extension(code, display) assert validator._validate_content_stability_extension(ext, 0, 0) is True assert validator.result.issues == [] @pytest.mark.parametrize( "code, display", [("dynamic", "Static"), ("static", "Dynamic")] ) def test_validate_content_stability_extension_display_mismatch(code, display): validator = DocumentReferenceValidator() ext = make_content_stability_extension(code, display) assert validator._validate_content_stability_extension(ext, 0, 0) is False assert any( f"Invalid content extension display: {display} Extension display must be the same as code either 'Static' or 'Dynamic'" in issue.diagnostics for issue in validator.result.issues ) @pytest.mark.parametrize( "code, display", [ ("SSP", "Spine Secure Proxy"), ("Direct", "Direct"), ("LDR", "Large Document Retrieval"), ("InContext", "Direct using In-Context"), ], ) def test_validate_retrieval_mechanism_extension_valid(code, display): validator = DocumentReferenceValidator() ext = make_retrieval_mechanism_extension(code, display) assert validator._validate_retrieval_mechanism_extension(ext, 0, 0) is True assert validator.result.issues == [] @pytest.mark.parametrize( "code, display", [ (code, wrong_display) for code, correct_display in CONTENT_RETRIEVAL_CODE_MAP.items() for wrong_display in CONTENT_RETRIEVAL_CODE_MAP.values() if wrong_display != correct_display ], ) def test_validate_retrieval_mechanism_extension_display_mismatch(code, display): validator = DocumentReferenceValidator() ext = make_retrieval_mechanism_extension(code, display) assert validator._validate_retrieval_mechanism_extension(ext, 0, 0) is False assert any( f"Invalid content extension display: {display} Expected display is '{CONTENT_RETRIEVAL_CODE_MAP.get(code)}'" in issue.diagnostics for issue in validator.result.issues ) def test_validate_structured_format_with_text_html_for_incontext_launch(): validator = DocumentReferenceValidator() document_ref_data = load_document_reference_json("Y05868-736253002-Valid") # Set up for direct in-context launch document_ref_data["content"][0]["attachment"]["contentType"] = "text/html" document_ref_data["content"][0]["format"] = { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:structured", "display": "Structured Document", } document_ref_data["content"][0]["extension"] = [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "InContext", "display": "Direct using In-Context", } ] }, }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "dynamic", "display": "Dynamic", } ] }, }, ] result = validator.validate(document_ref_data) assert result.is_valid is True NRLF-3.0.31/layer/nrlf/core/types.py000066400000000000000000000015341511201605300170570ustar00rootroot00000000000000from typing import Union from mypy_boto3_dynamodb import DynamoDBClient, DynamoDBServiceResource from mypy_boto3_lambda import LambdaClient from mypy_boto3_s3 import S3Client from nrlf.consumer.fhir.r4 import model as consumer_model from nrlf.producer.fhir.r4 import model as producer_model __all__ = ["DynamoDBServiceResource", "S3Client", "LambdaClient", "DynamoDBClient"] # Generic Model Types OperationOutcomeIssue = Union[ producer_model.OperationOutcomeIssue, consumer_model.OperationOutcomeIssue ] CodeableConcept = Union[producer_model.CodeableConcept, consumer_model.CodeableConcept] Bundle = Union[producer_model.Bundle, consumer_model.Bundle] DocumentReference = Union[ producer_model.DocumentReference, consumer_model.DocumentReference ] RequestQueryType = Union[ producer_model.RequestQueryType, consumer_model.RequestQueryType ] NRLF-3.0.31/layer/nrlf/core/utils.py000066400000000000000000000006251511201605300170530ustar00rootroot00000000000000from datetime import datetime, timezone def create_fhir_instant(time: datetime = None) -> str: """ Creates a timestamp string to represent the current time in the format defined by the FHIR spec: https://www.hl7.org/fhir/datatypes.html#instant """ if time is None: time = datetime.now(timezone.utc) return time.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z" NRLF-3.0.31/layer/nrlf/core/validators.py000066400000000000000000000741131511201605300200660ustar00rootroot00000000000000from dataclasses import dataclass from re import match from typing import Any, Dict, List, Optional from pydantic import ValidationError from nrlf.consumer.fhir.r4.model import RequestQueryCategory from nrlf.core.codes import SpineErrorConcept from nrlf.core.constants import ( ATTACHMENT_CONTENT_TYPES, CATEGORY_ATTRIBUTES, CONTENT_FORMAT_CODE_MAP, CONTENT_RETRIEVAL_CODE_MAP, ODS_SYSTEM, PRACTICE_SETTING_VALUE_SET_URL, REQUIRED_CREATE_FIELDS, SNOMED_PRACTICE_SETTINGS, SNOMED_SYSTEM_URL, TYPE_ATTRIBUTES, TYPE_CATEGORIES, Categories, PointerTypes, ) from nrlf.core.errors import ParseError from nrlf.core.logger import LogReference, logger from nrlf.core.types import DocumentReference, OperationOutcomeIssue, RequestQueryType from nrlf.producer.fhir.r4 import model as producer_model from nrlf.producer.fhir.r4.model import ( ContentStabilityExtension, NRLRetrievalMechanismExtension, ) def validate_type(type_: Optional[RequestQueryType], pointer_types: List[str]) -> bool: """ Validates if the given type is present in the list of pointer types. """ if not type_: return True return type_.root in pointer_types # TODO - Validate category is in set permissions once permissioning by category is done. def validate_category(categories: Optional[RequestQueryCategory]) -> bool: """ Validates if the given category is valid. """ if not categories: return True return all(category in Categories.list() for category in categories) @dataclass class ValidationResult: resource: DocumentReference issues: List[OperationOutcomeIssue] def reset(self): self.__init__( resource=producer_model.DocumentReference.model_construct(), issues=[] ) def add_error( self, issue_code: str, error_code: Optional[str] = None, diagnostics: Optional[str] = None, field: Optional[str] = None, ): details = None if error_code is not None: details = SpineErrorConcept.from_code(error_code) issue = producer_model.OperationOutcomeIssue( severity="error", code=issue_code, details=details, diagnostics=diagnostics, expression=[field] if field else None, # type: ignore ) logger.log(LogReference.VALIDATOR002, issue=issue.model_dump(exclude_none=True)) self.issues.append(issue) @property def is_valid(self): return not any(issue.severity in {"error", "fatal"} for issue in self.issues) class StopValidationError(Exception): pass class DocumentReferenceValidator: """ A class to validate document references """ MODEL = producer_model.DocumentReference def __init__(self): self.result = ValidationResult(resource=self.MODEL.model_construct(), issues=[]) @classmethod def parse(cls, data: Dict[str, Any]): try: logger.log(LogReference.PARSE000, data=data, model=cls.MODEL.__name__) result = cls.MODEL.model_validate(data) logger.log(LogReference.PARSE001, model=cls.MODEL.__name__) logger.log(LogReference.PARSE001a, result=result) return result except ValidationError as exc: logger.log( LogReference.PARSE002, model=cls.MODEL.__name__, data=data, validation_error=str(exc), ) raise ParseError.from_validation_error( exc, details=SpineErrorConcept.from_code("BAD_REQUEST"), msg="Failed to parse DocumentReference resource", ) from None def validate(self, data: Dict[str, Any] | DocumentReference): """ Validate the document reference """ logger.log(LogReference.VALIDATOR000, resource_type="DocumentReference") resource = self.parse(data) if isinstance(data, dict) else data self.result = ValidationResult(resource=resource, issues=[]) try: self._validate_required_fields(resource) self._validate_identifiers(resource) self._validate_relates_to(resource) self._validate_ssp_asid(resource) self._validate_type(resource) self._validate_category(resource) self._validate_author(resource) self._validate_type_category_mapping(resource) self._validate_content(resource) self._validate_content_format(resource) self._validate_content_extension(resource) self._validate_practiceSetting(resource) except StopValidationError: logger.log(LogReference.VALIDATOR003) logger.log( LogReference.VALIDATOR999, is_valid=self.result.is_valid, issue_count=len(self.result.issues), ) return self.result def _validate_required_fields(self, model: DocumentReference): """ Validate the required fields """ logger.log( LogReference.VALIDATOR001, step="required_fields", required_fields=REQUIRED_CREATE_FIELDS, ) for field in REQUIRED_CREATE_FIELDS: if not getattr(model, field, None): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"The required field '{field}' is missing", field=field, ) if not self.result.is_valid: raise StopValidationError() def _validate_identifiers(self, model: DocumentReference): """ """ logger.log(LogReference.VALIDATOR001, step="identifiers") if not (custodian_identifier := getattr(model.custodian, "identifier", None)): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Custodian must have an identifier", field="custodian.identifier", ) raise StopValidationError() if not (subject_identifier := getattr(model.subject, "identifier", None)): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Subject must have an identifier", field="subject.identifier", ) raise StopValidationError() if ( custodian_identifier.system != "https://fhir.nhs.uk/Id/ods-organization-code" ): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Provided custodian identifier system is not the ODS system (expected: 'https://fhir.nhs.uk/Id/ods-organization-code')", field="custodian.identifier.system", ) if subject_identifier.system != "https://fhir.nhs.uk/Id/nhs-number": self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=( "Provided subject identifier system is not the NHS number system " "(expected 'https://fhir.nhs.uk/Id/nhs-number')" ), field="subject.identifier.system", ) def _validate_relates_to(self, model: DocumentReference): """""" if not model.relatesTo: logger.log( LogReference.VALIDATOR001a, step="relates_to", reason="no_relates_to" ) return logger.log(LogReference.VALIDATOR001, step="relates_to") logger.debug("Validating relatesTo") for index, relates_to in enumerate(model.relatesTo): if relates_to.code not in [ "replaces", "transforms", "signs", "appends", "incorporates", "summarizes", ]: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid relatesTo code: {relates_to.code}", field=f"relatesTo[{index}].code", ) continue if relates_to.code == "replaces" and not ( relates_to.target.identifier and relates_to.target.identifier.value ): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="relatesTo code 'replaces' must have a target identifier", field=f"relatesTo[{index}].target.identifier.value", ) def _validate_asid(self, asid_references: list): """ Validate that the ASID provided in the document is valid """ logger.log(LogReference.VALIDATOR001, step="ssp_asid") if len(asid_references) > 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Multiple ASID identifiers provided. Only a single valid ASID identifier can be provided in the context.related.", field="context.related", ) return idx, asid_reference = asid_references[0] asid_value = getattr(asid_reference.identifier, "value") or "" if not match(r"^\d{12}$", asid_value): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid ASID value '{asid_value}'. A single ASID consisting of 12 digits can be provided in the context.related field.", field=f"context.related[{idx}].identifier.value", ) return def _validate_ssp_asid(self, model: DocumentReference): """ Validate that the document contains a valid ASID in the context.related field when the content contains an SSP URL """ ssp_content = any( [ content for content in model.content if content.attachment.url.startswith("ssp://") ] ) logger.log(LogReference.VALIDATOR001, step="ssp_content_and_asid_exists") does_related_exist = getattr(model.context, "related", None) does_asid_exist = False if does_related_exist: asid_references = [ (idx, related) for idx, related in enumerate(getattr(model.context, "related", [])) if related.identifier.system == "https://fhir.nhs.uk/Id/nhsSpineASID" ] if len(asid_references) > 0: does_asid_exist = True self._validate_asid(asid_references) if not does_asid_exist and not ssp_content: logger.log( LogReference.VALIDATOR001a, step="ssp_asid", reason="no_ssp_content" ) return if ssp_content and not does_related_exist: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Missing context.related. It must be provided and contain a single valid ASID identifier when content contains an SSP URL", field="context.related", ) return if ssp_content and does_related_exist and not does_asid_exist: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Missing ASID identifier. context.related must contain a single valid ASID identifier when content contains an SSP URL", field="context.related", ) return def _validate_type(self, model: DocumentReference): """ Validate the type field contains an appropriate coding system, code and display. """ logger.log(LogReference.VALIDATOR001, step="type") if len(model.type.coding) > 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid type coding length: {len(model.type.coding)} Type Coding must only contain a single value", field="type.coding", ) return coding = model.type.coding[0] if coding.system not in ["http://snomed.info/sct", "https://nicip.nhs.uk"]: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid type system: {coding.system} Type system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'", field="type.coding[0].system", ) return type_id = f"{coding.system}|{coding.code}" if type_id not in TYPE_ATTRIBUTES.keys(): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid type code: {coding.code} Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)", field="type.coding[0].code", ) return type_attributes = TYPE_ATTRIBUTES.get(type_id, {}) if coding.display != type_attributes.get("display"): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"type code '{coding.code}' must have a display value of '{type_attributes.get('display')}'", field="type.coding[0].display", ) def _validate_category(self, model: DocumentReference): """ Validate the category field contains an appropriate coding system, code and display. """ logger.log(LogReference.VALIDATOR001, step="category") if len(model.category) > 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid category length: {len(model.category)} Category must only contain a single value", field=f"category", ) return logger.debug("Validating category") if len(model.category[0].coding) > 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid category coding length: {len(model.category[0].coding)} Category Coding must only contain a single value", field=f"category[0].coding", ) return coding = model.category[0].coding[0] if coding.system != "http://snomed.info/sct": self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid category system: {coding.system} Category system must be 'http://snomed.info/sct'", field="category[0].coding[0].system", ) return category_id = f"{coding.system}|{coding.code}" if category_id not in CATEGORY_ATTRIBUTES.keys(): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid category code: {coding.code} Category must be a member of the England-NRLRecordCategory value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordCategory)", field="category[0].coding[0].code", ) return category_attributes = CATEGORY_ATTRIBUTES.get(category_id, {}) if coding.display != category_attributes.get("display"): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"category code '{coding.code}' must have a display value of '{category_attributes.get('display')}'", field="category[0].coding[0].display", ) def _validate_type_category_mapping(self, model: DocumentReference): """ Validate the type field matches the expected category """ logger.log(LogReference.VALIDATOR001, step="type_category_mapping") type_coding = model.type.coding[0] type_id = f"{type_coding.system}|{type_coding.code}" category_coding = model.category[0].coding[0] category_id = f"{category_coding.system}|{category_coding.code}" if type_id not in PointerTypes.list() or category_id not in Categories.list(): return # No point mapping to an unexisting/unsupported type/category type_category = TYPE_CATEGORIES.get(type_id) if type_category != category_id: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"The Category code of the provided document '{category_id}' must match the allowed category for pointer type '{type_id}' with a category value of '{type_category}'", field="category.coding[0].code", ) def _validate_content_format(self, model: DocumentReference): """ Validate the content.format field contains an appropriate coding. """ logger.log(LogReference.VALIDATOR001, step="content_format") logger.debug("Validating format") for i, content in enumerate(model.content): if ( content.attachment.contentType == "text/html" and content.format.code not in ["urn:nhs-ic:record-contact", "urn:nhs-ic:structured"] ): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid content format code: {content.format.code} format code must be 'urn:nhs-ic:record-contact' for Contact details attachments.", field=f"content[{i}].format.code", ) elif ( content.attachment.contentType == "application/pdf" and content.format.code != "urn:nhs-ic:unstructured" ): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid content format code: {content.format.code} format code must be 'urn:nhs-ic:unstructured' for Unstructured Document attachments.", field=f"content[{i}].format.code", ) elif ( content.attachment.contentType in { "application/json", "application/fhir+json", "application/json+fhir", } and content.format.code != "urn:nhs-ic:structured" ): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid content format code: {content.format.code} format code must be 'urn:nhs-ic:structured' for Structured Document attachments.", field=f"content[{i}].format.code", ) def _validate_content_extension(self, model: DocumentReference): """ Validate the content.extension field contains an appropriate coding. """ logger.log(LogReference.VALIDATOR001, step="content_extension") logger.debug("Validating extension") for i, content in enumerate(model.content): if not self._has_valid_extensions(content.extension, i): return def _is_content_stability_extension(self, extension): return "contentstability" in str(extension).lower() def _is_retrieval_mechanism_extension(self, extension): return "retrievalmechanism" in str(extension).lower() def _has_valid_extensions(self, extensions, i): content_stability_count = 0 content_retrieval_count = 0 for extension in extensions: if self._is_content_stability_extension(extension): content_stability_count += 1 elif self._is_retrieval_mechanism_extension(extension): content_retrieval_count += 1 if content_stability_count != 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Invalid content extension: Extension must have one content stability extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability')", field=f"content[{i}].extension", ) return False if content_retrieval_count > 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Invalid content retrieval extension: Extension must have one content retrieval extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism')", field=f"content[{i}].extension", ) return False return self._validate_content_extension_items(extensions, i) def _validate_content_extension_items(self, extensions, i): for j, extension in enumerate(extensions): if self._is_content_stability_extension(extension): if not self._validate_content_stability_extension(extension, i, j): return False elif self._is_retrieval_mechanism_extension(extension): if not self._validate_retrieval_mechanism_extension(extension, i, j): return False return True def _validate_content_stability_extension(self, extension, i, j): try: ContentStabilityExtension.model_validate(extension.model_dump()) except ValidationError as exc: raise ParseError.from_validation_error( exc, details=SpineErrorConcept.from_code("BAD_REQUEST"), msg="Invalid content stability extension", value_set="https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability", root_location=("content", i, "extension", j), ) from None coding = extension.valueCodeableConcept.coding[0] if coding.code != coding.display.lower(): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid content extension display: {coding.display} Extension display must be the same as code either 'Static' or 'Dynamic'", field=f"content[{i}].extension[{j}].valueCodeableConcept.coding[0].display", ) return False return True def _validate_retrieval_mechanism_extension(self, extension, i, j): try: NRLRetrievalMechanismExtension.model_validate(extension.model_dump()) except ValidationError as exc: raise ParseError.from_validation_error( exc, details=SpineErrorConcept.from_code("BAD_REQUEST"), msg="Invalid content retrieval extension", value_set="https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism", root_location=("content", i, "extension", j), ) from None coding = extension.valueCodeableConcept.coding[0] expected_retrieval_display = CONTENT_RETRIEVAL_CODE_MAP.get(coding.code) if coding.display != expected_retrieval_display: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid content extension display: {coding.display} Expected display is '{expected_retrieval_display}'", field=f"content[{i}].extension[{j}].valueCodeableConcept.coding[0].display", ) return False return True def _validate_author(self, model: DocumentReference): """ Validate the author field contains an appropriate coding system and code. """ logger.log(LogReference.VALIDATOR001, step="author") if len(model.author) > 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid author length: {len(model.author)} Author must only contain a single value", field="author", ) return logger.debug("Validating author") identifier = model.author[0].identifier if identifier.system != ODS_SYSTEM: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid author system: '{identifier.system}' Author system must be '{ODS_SYSTEM}'", field="author[0].identifier.system", ) return if not identifier.value.isalnum(): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid author value: '{identifier.value}' Author value must be alphanumeric", field="author[0].identifier.value", ) return if len(identifier.value) > 12: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid author value: '{identifier.value}' Author value must be less than 13 characters", field="author[0].identifier.value", ) return def _validate_practiceSetting(self, model: DocumentReference): """ Validate the practice setting field contains an appropriate coding system and code. """ if not ( practice_setting_coding := getattr( model.context.practiceSetting, "coding", [] ) ): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics="Invalid practice setting: must contain a Coding", field="context.practiceSetting.coding", ) return if len(practice_setting_coding) != 1: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid practice setting coding length: {len(model.context.practiceSetting.coding)} Practice Setting Coding must only contain a single value", field="context.practiceSetting.coding", ) return if ( practice_setting_system := getattr( practice_setting_coding[0], "system", None ) ) != SNOMED_SYSTEM_URL: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid practice setting system: {practice_setting_system} Practice Setting system must be '{SNOMED_SYSTEM_URL}'", field="context.practiceSetting.coding[0].system", ) return if ( practice_setting_value := getattr(practice_setting_coding[0], "code", None) ) not in SNOMED_PRACTICE_SETTINGS: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid practice setting code: {practice_setting_value} Practice Setting coding must be a member of value set {PRACTICE_SETTING_VALUE_SET_URL}", field="context.practiceSetting.coding[0].code", ) return if ( practice_setting_display := getattr( practice_setting_coding[0], "display", None ) ) != SNOMED_PRACTICE_SETTINGS.get(practice_setting_value): self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid practice setting coding: display {practice_setting_display} does not match the expected display for {practice_setting_value} Practice Setting coding is bound to value set {PRACTICE_SETTING_VALUE_SET_URL}", field="context.practiceSetting.coding[0]", ) return def _validate_content(self, model: DocumentReference): """ Validate that the contentType is present and supported. """ logger.log(LogReference.VALIDATOR001, step="content") for i, content in enumerate(model.content): if content.attachment.contentType not in ATTACHMENT_CONTENT_TYPES: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid contentType: {content.attachment.contentType}. Must be 'application/pdf', 'text/html' or 'application/fhir+json'", field=f"content[{i}].attachment.contentType", ) # Validate NRLFormatCode format_code = content.format.code format_display = content.format.display expected_display = CONTENT_FORMAT_CODE_MAP.get(format_code) if expected_display and format_display != expected_display: self.result.add_error( issue_code="business-rule", error_code="UNPROCESSABLE_ENTITY", diagnostics=f"Invalid display for format code '{format_code}'. Expected '{expected_display}'", field=f"content[{i}].format.display", ) NRLF-3.0.31/layer/nrlf/producer/000077500000000000000000000000001511201605300162315ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/producer/fhir/000077500000000000000000000000001511201605300171615ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/producer/fhir/r4/000077500000000000000000000000001511201605300175065ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/producer/fhir/r4/model.py000066400000000000000000001337461511201605300211760ustar00rootroot00000000000000# generated by datamodel-codegen: # filename: swagger.yaml # timestamp: 2025-09-12T10:25:26+00:00 from __future__ import annotations from typing import Annotated, List, Literal, Optional, Union from pydantic import ConfigDict, Field, RootModel from nrlf.core.parent_model import Parent class LocationItem(RootModel[str]): root: Annotated[ str, Field( description='This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.', pattern="[ \\r\\n\\t\\S]+", ), ] class ExpressionItem(RootModel[str]): root: Annotated[ str, Field( description="A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised.", pattern="[ \\r\\n\\t\\S]+", ), ] class BundleEntryRequest(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None method: Annotated[ str, Field( description="In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] url: Annotated[ str, Field( description="The URL for this entry, relative to the root (the address to which the request is posted).", pattern="\\S*", ), ] ifNoneMatch: Annotated[ Optional[str], Field( description='If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).', pattern="[ \\r\\n\\t\\S]+", ), ] = None ifModifiedSince: Annotated[ Optional[str], Field( description='Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).', pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None ifMatch: Annotated[ Optional[str], Field( description='Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).', pattern="[ \\r\\n\\t\\S]+", ), ] = None ifNoneExist: Annotated[ Optional[str], Field( description='Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL – what follows the "?" (not including the "?").', pattern="[ \\r\\n\\t\\S]+", ), ] = None class BundleEntrySearch(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None mode: Annotated[ Optional[str], Field( description="Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None score: Annotated[ Optional[float], Field( description="When searching, the server's search ranking score for the entry." ), ] = None class BundleLink(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None relation: Annotated[ str, Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1).", pattern="[ \\r\\n\\t\\S]+", ), ] url: Annotated[ str, Field(description="The reference details for the link.", pattern="\\S*") ] class Attachment(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None contentType: Annotated[ str, Field( description="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] language: Annotated[ Optional[str], Field( description="The human language of the content. The value can be any valid value according to BCP 47.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None data: Annotated[ Optional[str], Field( description="The actual data of the attachment – a sequence of bytes, base64 encoded.", pattern="(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+", ), ] = None url: Annotated[ str, Field(description="A location where the data can be accessed.", pattern="\\S*"), ] size: Annotated[ Optional[int], Field( description="The number of bytes of data that make up this attachment (before base64 encoding, if that is done)." ), ] = None hash: Annotated[ Optional[str], Field( description="The calculated hash of the data using SHA–1. Represented using base64.", pattern="(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+", ), ] = None title: Annotated[ Optional[str], Field( description="A label or set of text to display in place of the data.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None creation: Annotated[ Optional[str], Field( description="The date that the attachment was first created.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", ), ] = None class Coding(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None system: Annotated[ Optional[str], Field( description="The identification of the code system that defines the meaning of the symbol in the code.", pattern="\\S+", ), ] = None version: Annotated[ Optional[str], Field( description="The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None code: Annotated[ Optional[str], Field( description="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination).", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None display: Annotated[ Optional[str], Field( description="A representation of the meaning of the code in the system, following the rules of the system.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None userSelected: Annotated[ Optional[bool], Field( description="Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)." ), ] = None class NRLCoding(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None system: Annotated[ str, Field( description="The identification of the code system that defines the meaning of the symbol in the code.", pattern="\\S+", ), ] version: Annotated[ Optional[str], Field( description="The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None code: Annotated[ str, Field( description="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination).", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] display: Annotated[ str, Field( description="A representation of the meaning of the code in the system, following the rules of the system.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] userSelected: Annotated[ Optional[bool], Field( description="Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)." ), ] = None class ContentStabilityExtensionCoding(Coding): system: Literal[ "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability" ] code: Literal["static", "dynamic"] display: Literal["Static", "Dynamic"] class NRLRetrievalMechanismExtensionCoding(Coding): system: Literal[ "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism" ] code: Literal["SSP", "Direct", "LDR", "InContext"] display: Literal[ "Spine Secure Proxy", "Direct", "Large Document Retrieval", "Direct using In-Context", ] class NRLFormatCode(Coding): system: Annotated[ Literal["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"], Field(description="The system URL for the NRLF Format Code."), ] code: Annotated[ Literal[ "urn:nhs-ic:record-contact", "urn:nhs-ic:unstructured", "urn:nhs-ic:structured", ], Field(description="The code representing the format of the document."), ] display: Annotated[ Literal[ "Contact details (HTTP Unsecured)", "Unstructured Document", "Structured Document", ], Field(description="The display text for the code."), ] class Period(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None start: Annotated[ Optional[str], Field( description="The start of the period. The boundary is inclusive.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", ), ] = None end: Annotated[ Optional[str], Field( description="The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", ), ] = None class Quantity(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None value: Annotated[ Optional[float], Field( description="The value of the measured amount. The value includes an implicit precision in the presentation of the value." ), ] = None comparator: Annotated[ Optional[str], Field( description='How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.', pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None unit: Annotated[ Optional[str], Field( description="A human–readable form of the unit.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None system: Annotated[ Optional[str], Field( description="The identification of the system that provides the coded form of the unit.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None code: Annotated[ Optional[str], Field( description="A computer processable form of the unit in some unit representation system.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None class ProfileItem(RootModel[str]): root: Annotated[ str, Field( description="A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url).", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] class Meta(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None versionId: Annotated[ Optional[str], Field( description="The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None lastUpdated: Annotated[ Optional[str], Field( description="When the resource last changed – e.g. when the version changed.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None source: Annotated[ Optional[str], Field( description="A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None profile: Optional[List[ProfileItem]] = None security: Optional[List[Coding]] = None tag: Optional[List[Coding]] = None class Narrative(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None status: Annotated[ str, Field( description="The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] div: Annotated[ str, Field( description="The actual narrative content, a stripped down version of XHTML." ), ] class DocumentId(RootModel[str]): root: Annotated[str, Field(pattern="[A-Za-z0-9\\-\\.]{1,64}")] class RequestPathParams(Parent): id: DocumentId class RequestQuerySubject(RootModel[str]): root: Annotated[ str, Field( examples=["https://fhir.nhs.uk/Id/nhs-number|4409815415"], pattern="^https\\:\\/\\/fhir\\.nhs\\.uk\\/Id\\/nhs-number\\|(\\d+)$", ), ] class RequestQueryType(RootModel[str]): root: Annotated[str, Field(examples=["http://snomed.info/sct|736253002"])] class RequestQueryCategory(RootModel[str]): root: Annotated[str, Field(examples=["http://snomed.info/sct|103693007"])] class NextPageToken(RootModel[str]): root: str class RequestHeaderOdsCode(RootModel[str]): root: str class RequestHeaderOrganisationExtensionCode(RootModel[str]): root: str class RequestHeaderRequestId(RootModel[str]): root: Annotated[ str, Field( examples=["60E0B220-8136-4CA5-AE46-1D97EF59D068"], pattern="^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", ), ] class RequestHeaderCorrelationId(RootModel[str]): root: Annotated[str, Field(examples=["11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"])] class CodeableConcept(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None coding: Optional[List[Coding]] = None text: Annotated[ Optional[str], Field( description="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None class NRLCodeableConcept(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None coding: Annotated[List[NRLCoding], Field(max_length=1, min_length=1)] text: Annotated[ Optional[str], Field( description="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None class Extension(Parent): valueCodeableConcept: Annotated[ Optional[CodeableConcept], Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1)." ), ] = None url: Annotated[ Optional[str], Field(description="The reference details for the link.", pattern="\\S*"), ] = None class ContentStabilityExtensionValueCodeableConcept(CodeableConcept): coding: Annotated[ List[ContentStabilityExtensionCoding], Field(max_length=1, min_length=1) ] class NRLRetrievalMechanismExtensionValueCodeableConcept(CodeableConcept): coding: Annotated[ List[NRLRetrievalMechanismExtensionCoding], Field(max_length=1, min_length=1) ] class RequestHeader(Parent): odsCode: RequestHeaderOdsCode class RequestParams(Parent): subject_identifier: Annotated[ Optional[RequestQuerySubject], Field(alias="subject:identifier") ] = None type: Optional[RequestQueryType] = None category: Optional[RequestQueryCategory] = None next_page_token: Annotated[ Optional[NextPageToken], Field(alias="next-page-token") ] = None class OperationOutcomeIssue(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None severity: Annotated[ str, Field( description="Indicates whether the issue indicates a variation from successful processing.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] code: Annotated[ str, Field( description="Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] details: Annotated[ Optional[CodeableConcept], Field( description="Additional details about the error. This may be a text description of the error or a system code that identifies the error." ), ] = None diagnostics: Annotated[ Optional[str], Field( description="Additional diagnostic information about the issue.", pattern="[ \\r\\n\\t\\S]+", ), ] = None location: Optional[List[LocationItem]] = None expression: Optional[List[ExpressionItem]] = None class ContentStabilityExtension(Extension): url: Literal[ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" ] valueCodeableConcept: ContentStabilityExtensionValueCodeableConcept class NRLRetrievalMechanismExtension(Extension): url: Literal[ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" ] valueCodeableConcept: NRLRetrievalMechanismExtensionValueCodeableConcept class OperationOutcome(Parent): resourceType: Literal["OperationOutcome"] id: Annotated[ Optional[str], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[str], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", pattern="\\S*", ), ] = None language: Annotated[ Optional[str], Field( description="The base language in which the resource is written.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None text: Annotated[ Optional[Narrative], Field( description='A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' ), ] = None issue: Annotated[List[OperationOutcomeIssue], Field(min_length=1)] class DocumentReferenceContent(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None attachment: Annotated[ Attachment, Field( description="The document or URL of the document along with critical metadata to prove content has integrity." ), ] format: Annotated[ NRLFormatCode, Field( description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." ), ] extension: Annotated[ List[ Union[ContentStabilityExtension, NRLRetrievalMechanismExtension, Extension] ], Field(min_length=1), ] class DocumentReference(Parent): model_config = ConfigDict( regex_engine="python-re", ) resourceType: Literal["DocumentReference"] id: Annotated[ Optional[str], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", pattern="^(?=.{1,64}$)[A-Za-z0-9\\.]+-[A-Za-z0-9]+[A-Za-z0-9\\_\\-]*$", ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[str], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", pattern="\\S*", ), ] = None language: Annotated[ Optional[str], Field( description="The base language in which the resource is written.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None text: Annotated[ Optional[Narrative], Field( description='A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' ), ] = None masterIdentifier: Annotated[ Optional[Identifier], Field( description="Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document." ), ] = None identifier: Optional[List[Identifier]] = None status: Annotated[ str, Field( description="The status of this document reference.", pattern="^current$" ), ] docStatus: Annotated[ Optional[Literal["entered-in-error", "amended", "preliminary", "final"]], Field(description="The status of the underlying document."), ] = None type: Annotated[ NRLCodeableConcept, Field( description="Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced." ), ] category: List[NRLCodeableConcept] subject: Annotated[ Optional[Reference], Field( description="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)." ), ] = None date: Annotated[ Optional[str], Field( description="When the document reference was created.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None author: List[Reference] authenticator: Annotated[ Optional[Reference], Field( description="Which person or organization authenticates that this document is valid." ), ] = None custodian: Annotated[ Optional[Reference], Field( description="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document." ), ] = None relatesTo: Optional[List[DocumentReferenceRelatesTo]] = None description: Annotated[ Optional[str], Field( description="Human–readable description of the source document.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None securityLabel: Optional[List[CodeableConcept]] = None content: Annotated[List[DocumentReferenceContent], Field(min_length=1)] context: Annotated[ DocumentReferenceContext, Field(description="The clinical context in which the document was prepared."), ] class Bundle(Parent): resourceType: Literal["Bundle"] id: Annotated[ Optional[str], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[str], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", pattern="\\S*", ), ] = None language: Annotated[ Optional[str], Field( description="The base language in which the resource is written.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None identifier: Annotated[ Optional[Identifier], Field( description="A persistent identifier for the bundle that won't change as a bundle is copied from server to server." ), ] = None type: Annotated[ str, Field( description="Indicates the purpose of this bundle – how it is intended to be used.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] timestamp: Annotated[ Optional[str], Field( description="The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None total: Annotated[ Optional[int], Field( description="If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle." ), ] = None link: Optional[List[BundleLink]] = None entry: Optional[List[BundleEntry]] = None signature: Annotated[ Optional[Signature], Field( description="Digital Signature – base64 encoded. XML–DSig or a JWT." ), ] = None class BundleEntry(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None link: Optional[List[BundleLink]] = None fullUrl: Annotated[ Optional[str], Field( description="The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified.", pattern="\\S*", ), ] = None resource: Annotated[ Optional[Union[DocumentReference, OperationOutcome]], Field( description="The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type." ), ] = None search: Annotated[ Optional[BundleEntrySearch], Field( description="Information about the search process that lead to the creation of this entry." ), ] = None request: Annotated[ Optional[BundleEntryRequest], Field( description="Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry." ), ] = None response: Annotated[ Optional[BundleEntryResponse], Field( description="Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history." ), ] = None class BundleEntryResponse(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None status: Annotated[ str, Field( description="The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.", pattern="[ \\r\\n\\t\\S]+", ), ] location: Annotated[ Optional[str], Field( description="The location header created by processing this operation, populated if the operation returns a location.", pattern="\\S*", ), ] = None etag: Annotated[ Optional[str], Field( description="The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).", pattern="[ \\r\\n\\t\\S]+", ), ] = None lastModified: Annotated[ Optional[str], Field( description="The date/time that the resource was modified on the server.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] = None outcome: Annotated[ Optional[DocumentReference], Field( description="An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction." ), ] = None class DocumentReferenceContext(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None encounter: Optional[List[Reference]] = None event: Optional[List[CodeableConcept]] = None period: Annotated[ Optional[Period], Field( description="The time period over which the service that is described by the document was provided." ), ] = None facilityType: Annotated[ Optional[CodeableConcept], Field(description="The kind of facility where the patient was seen."), ] = None practiceSetting: Annotated[ NRLCodeableConcept, Field( description="This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty." ), ] sourcePatientInfo: Annotated[ Optional[Reference], Field( description="The Patient Information as known when the document was published. May be a reference to a version specific, or contained." ), ] = None related: Optional[List[Reference]] = None class DocumentReferenceRelatesTo(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None code: Annotated[ str, Field( description="The type of relationship that this document has with anther document.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] target: Annotated[ Reference, Field(description="The target document of this relationship.") ] class Identifier(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None use: Annotated[ Optional[str], Field( description="The purpose of this identifier.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None type: Annotated[ Optional[CodeableConcept], Field( description="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." ), ] = None system: Annotated[ Optional[str], Field( description="Establishes the namespace for the value – that is, a URL that describes a set values that are unique.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None value: Annotated[ Optional[str], Field( description="The portion of the identifier typically relevant to the user and which is unique within the context of the system.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None period: Annotated[ Optional[Period], Field(description="Time period during which identifier is/was valid for use."), ] = None assigner: Annotated[ Optional[Reference], Field(description="Organization that issued/manages the identifier."), ] = None class Reference(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None reference: Annotated[ Optional[str], Field( description="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None type: Annotated[ Optional[str], Field( description='The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).', pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None identifier: Annotated[ Optional[Identifier], Field( description="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." ), ] = None display: Annotated[ Optional[str], Field( description="Plain text narrative that identifies the resource in addition to the resource reference.", pattern="[\\S]+[ \\r\\n\\t\\S]*", ), ] = None class Signature(Parent): id: Annotated[ Optional[str], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", pattern="[A-Za-z0-9\\-\\.]{1,64}", ), ] = None type: Annotated[List[Coding], Field(min_length=1)] when: Annotated[ str, Field( description="When the digital signature was signed.", pattern="([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", ), ] who: Annotated[ Reference, Field( description="A reference to an application–usable description of the identity that signed (e.g. the signature used their private key)." ), ] onBehalfOf: Annotated[ Optional[Reference], Field( description="A reference to an application–usable description of the identity that is represented by the signature." ), ] = None targetFormat: Annotated[ Optional[str], Field( description="A mime type that indicates the technical format of the target resources signed by the signature.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None sigFormat: Annotated[ Optional[str], Field( description="A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc.", pattern="[^\\s]+(\\s[^\\s]+)*", ), ] = None data: Annotated[ Optional[str], Field( description="The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.", pattern="(\\s*([0-9a-zA-Z\\+/=]){4}\\s*)+", ), ] = None DocumentReference.model_rebuild() Bundle.model_rebuild() BundleEntry.model_rebuild() DocumentReferenceContext.model_rebuild() DocumentReferenceRelatesTo.model_rebuild() Identifier.model_rebuild() NRLF-3.0.31/layer/nrlf/producer/fhir/r4/strict_model.py000066400000000000000000001210131511201605300225460ustar00rootroot00000000000000# generated by datamodel-codegen: # filename: swagger.yaml # timestamp: 2025-09-12T10:25:28+00:00 from __future__ import annotations from typing import Annotated, List, Literal, Optional, Union from pydantic import ( ConfigDict, Field, RootModel, StrictBool, StrictFloat, StrictInt, StrictStr, ) from nrlf.core.parent_model import Parent class LocationItem(RootModel[StrictStr]): root: Annotated[ StrictStr, Field( description='This element is deprecated because it is XML specific. It is replaced by issue.expression, which is format independent, and simpler to parse. \n\nFor resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be "http." + the parameter name.' ), ] class ExpressionItem(RootModel[StrictStr]): root: Annotated[ StrictStr, Field( description="A [simple subset of FHIRPath](fhirpath.html#simple) limited to element names, repetition indicators and the default child accessor that identifies one of the elements in the resource that caused this issue to be raised." ), ] class BundleEntryRequest(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None method: Annotated[ StrictStr, Field( description="In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred." ), ] url: Annotated[ StrictStr, Field( description="The URL for this entry, relative to the root (the address to which the request is posted)." ), ] ifNoneMatch: Annotated[ Optional[StrictStr], Field( description='If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).' ), ] = None ifModifiedSince: Annotated[ Optional[StrictStr], Field( description='Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).' ), ] = None ifMatch: Annotated[ Optional[StrictStr], Field( description='Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).' ), ] = None ifNoneExist: Annotated[ Optional[StrictStr], Field( description='Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL – what follows the "?" (not including the "?").' ), ] = None class BundleEntrySearch(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None mode: Annotated[ Optional[StrictStr], Field( description="Why this entry is in the result set – whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process." ), ] = None score: Annotated[ Optional[StrictFloat], Field( description="When searching, the server's search ranking score for the entry." ), ] = None class BundleLink(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None relation: Annotated[ StrictStr, Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1)." ), ] url: Annotated[StrictStr, Field(description="The reference details for the link.")] class Attachment(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None contentType: Annotated[ StrictStr, Field( description="Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate." ), ] language: Annotated[ Optional[StrictStr], Field( description="The human language of the content. The value can be any valid value according to BCP 47." ), ] = None data: Annotated[ Optional[StrictStr], Field( description="The actual data of the attachment – a sequence of bytes, base64 encoded." ), ] = None url: Annotated[ StrictStr, Field(description="A location where the data can be accessed.") ] size: Annotated[ Optional[StrictInt], Field( description="The number of bytes of data that make up this attachment (before base64 encoding, if that is done)." ), ] = None hash: Annotated[ Optional[StrictStr], Field( description="The calculated hash of the data using SHA–1. Represented using base64." ), ] = None title: Annotated[ Optional[StrictStr], Field(description="A label or set of text to display in place of the data."), ] = None creation: Annotated[ Optional[StrictStr], Field(description="The date that the attachment was first created."), ] = None class Coding(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None system: Annotated[ Optional[StrictStr], Field( description="The identification of the code system that defines the meaning of the symbol in the code." ), ] = None version: Annotated[ Optional[StrictStr], Field( description="The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." ), ] = None code: Annotated[ Optional[StrictStr], Field( description="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination)." ), ] = None display: Annotated[ Optional[StrictStr], Field( description="A representation of the meaning of the code in the system, following the rules of the system." ), ] = None userSelected: Annotated[ Optional[StrictBool], Field( description="Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)." ), ] = None class NRLCoding(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None system: Annotated[ StrictStr, Field( description="The identification of the code system that defines the meaning of the symbol in the code." ), ] version: Annotated[ Optional[StrictStr], Field( description="The version of the code system which was used when choosing this code. Note that a well–maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." ), ] = None code: Annotated[ StrictStr, Field( description="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post–coordination)." ), ] display: Annotated[ StrictStr, Field( description="A representation of the meaning of the code in the system, following the rules of the system." ), ] userSelected: Annotated[ Optional[StrictBool], Field( description="Indicates that this coding was chosen by a user directly – e.g. off a pick list of available items (codes or displays)." ), ] = None class ContentStabilityExtensionCoding(Coding): system: Literal[ "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability" ] code: Literal["static", "dynamic"] display: Literal["Static", "Dynamic"] class NRLRetrievalMechanismExtensionCoding(Coding): system: Literal[ "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism" ] code: Literal["SSP", "Direct", "LDR", "InContext"] display: Literal[ "Spine Secure Proxy", "Direct", "Large Document Retrieval", "Direct using In-Context", ] class NRLFormatCode(Coding): system: Annotated[ Literal["https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode"], Field(description="The system URL for the NRLF Format Code."), ] code: Annotated[ Literal[ "urn:nhs-ic:record-contact", "urn:nhs-ic:unstructured", "urn:nhs-ic:structured", ], Field(description="The code representing the format of the document."), ] display: Annotated[ Literal[ "Contact details (HTTP Unsecured)", "Unstructured Document", "Structured Document", ], Field(description="The display text for the code."), ] class Period(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None start: Annotated[ Optional[StrictStr], Field(description="The start of the period. The boundary is inclusive."), ] = None end: Annotated[ Optional[StrictStr], Field( description="The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time." ), ] = None class Quantity(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None value: Annotated[ Optional[StrictFloat], Field( description="The value of the measured amount. The value includes an implicit precision in the presentation of the value." ), ] = None comparator: Annotated[ Optional[StrictStr], Field( description='How the value should be understood and represented – whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.' ), ] = None unit: Annotated[ Optional[StrictStr], Field(description="A human–readable form of the unit."), ] = None system: Annotated[ Optional[StrictStr], Field( description="The identification of the system that provides the coded form of the unit." ), ] = None code: Annotated[ Optional[StrictStr], Field( description="A computer processable form of the unit in some unit representation system." ), ] = None class ProfileItem(RootModel[StrictStr]): root: Annotated[ StrictStr, Field( description="A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition–definitions.html#StructureDefinition.url)." ), ] class Meta(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None versionId: Annotated[ Optional[StrictStr], Field( description="The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted." ), ] = None lastUpdated: Annotated[ Optional[StrictStr], Field( description="When the resource last changed – e.g. when the version changed." ), ] = None source: Annotated[ Optional[StrictStr], Field( description="A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc." ), ] = None profile: Optional[List[ProfileItem]] = None security: Optional[List[Coding]] = None tag: Optional[List[Coding]] = None class Narrative(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None status: Annotated[ StrictStr, Field( description="The status of the narrative – whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data." ), ] div: Annotated[ StrictStr, Field( description="The actual narrative content, a stripped down version of XHTML." ), ] class DocumentId(RootModel[StrictStr]): root: StrictStr class RequestPathParams(Parent): id: DocumentId class RequestQuerySubject(RootModel[StrictStr]): root: Annotated[ StrictStr, Field(examples=["https://fhir.nhs.uk/Id/nhs-number|4409815415"]) ] class RequestQueryType(RootModel[StrictStr]): root: Annotated[StrictStr, Field(examples=["http://snomed.info/sct|736253002"])] class RequestQueryCategory(RootModel[StrictStr]): root: Annotated[StrictStr, Field(examples=["http://snomed.info/sct|103693007"])] class NextPageToken(RootModel[StrictStr]): root: StrictStr class RequestHeaderOdsCode(RootModel[StrictStr]): root: StrictStr class RequestHeaderOrganisationExtensionCode(RootModel[StrictStr]): root: StrictStr class RequestHeaderRequestId(RootModel[StrictStr]): root: Annotated[StrictStr, Field(examples=["60E0B220-8136-4CA5-AE46-1D97EF59D068"])] class RequestHeaderCorrelationId(RootModel[StrictStr]): root: Annotated[StrictStr, Field(examples=["11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA"])] class CodeableConcept(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None coding: Optional[List[Coding]] = None text: Annotated[ Optional[StrictStr], Field( description="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user." ), ] = None class NRLCodeableConcept(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None coding: Annotated[List[NRLCoding], Field(max_length=1, min_length=1)] text: Annotated[ Optional[StrictStr], Field( description="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user." ), ] = None class Extension(Parent): valueCodeableConcept: Annotated[ Optional[CodeableConcept], Field( description="A name which details the functional use for this link – see [http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1](http://www.iana.org/assignments/link–relations/link–relations.xhtml#link–relations–1)." ), ] = None url: Annotated[ Optional[StrictStr], Field(description="The reference details for the link.") ] = None class ContentStabilityExtensionValueCodeableConcept(CodeableConcept): coding: Annotated[ List[ContentStabilityExtensionCoding], Field(max_length=1, min_length=1) ] class NRLRetrievalMechanismExtensionValueCodeableConcept(CodeableConcept): coding: Annotated[ List[NRLRetrievalMechanismExtensionCoding], Field(max_length=1, min_length=1) ] class RequestHeader(Parent): odsCode: RequestHeaderOdsCode class RequestParams(Parent): subject_identifier: Annotated[ Optional[RequestQuerySubject], Field(alias="subject:identifier") ] = None type: Optional[RequestQueryType] = None category: Optional[RequestQueryCategory] = None next_page_token: Annotated[ Optional[NextPageToken], Field(alias="next-page-token") ] = None class OperationOutcomeIssue(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None severity: Annotated[ StrictStr, Field( description="Indicates whether the issue indicates a variation from successful processing." ), ] code: Annotated[ StrictStr, Field( description="Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element." ), ] details: Annotated[ Optional[CodeableConcept], Field( description="Additional details about the error. This may be a text description of the error or a system code that identifies the error." ), ] = None diagnostics: Annotated[ Optional[StrictStr], Field(description="Additional diagnostic information about the issue."), ] = None location: Optional[List[LocationItem]] = None expression: Optional[List[ExpressionItem]] = None class ContentStabilityExtension(Extension): url: Literal[ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" ] valueCodeableConcept: ContentStabilityExtensionValueCodeableConcept class NRLRetrievalMechanismExtension(Extension): url: Literal[ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" ] valueCodeableConcept: NRLRetrievalMechanismExtensionValueCodeableConcept class OperationOutcome(Parent): resourceType: Literal["OperationOutcome"] id: Annotated[ Optional[StrictStr], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[StrictStr], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." ), ] = None language: Annotated[ Optional[StrictStr], Field(description="The base language in which the resource is written."), ] = None text: Annotated[ Optional[Narrative], Field( description='A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' ), ] = None issue: Annotated[List[OperationOutcomeIssue], Field(min_length=1)] class DocumentReferenceContent(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None attachment: Annotated[ Attachment, Field( description="The document or URL of the document along with critical metadata to prove content has integrity." ), ] format: Annotated[ NRLFormatCode, Field( description="An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." ), ] extension: Annotated[ List[ Union[ContentStabilityExtension, NRLRetrievalMechanismExtension, Extension] ], Field(min_length=1), ] class DocumentReference(Parent): model_config = ConfigDict( regex_engine="python-re", ) resourceType: Literal["DocumentReference"] id: Annotated[ Optional[StrictStr], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[StrictStr], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." ), ] = None language: Annotated[ Optional[StrictStr], Field(description="The base language in which the resource is written."), ] = None text: Annotated[ Optional[Narrative], Field( description='A human–readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.' ), ] = None masterIdentifier: Annotated[ Optional[Identifier], Field( description="Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document." ), ] = None identifier: Optional[List[Identifier]] = None status: Annotated[ StrictStr, Field(description="The status of this document reference.") ] docStatus: Annotated[ Optional[Literal["entered-in-error", "amended", "preliminary", "final"]], Field(description="The status of the underlying document."), ] = None type: Annotated[ NRLCodeableConcept, Field( description="Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced." ), ] category: List[NRLCodeableConcept] subject: Annotated[ Optional[Reference], Field( description="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)." ), ] = None date: Annotated[ Optional[StrictStr], Field(description="When the document reference was created."), ] = None author: List[Reference] authenticator: Annotated[ Optional[Reference], Field( description="Which person or organization authenticates that this document is valid." ), ] = None custodian: Annotated[ Optional[Reference], Field( description="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document." ), ] = None relatesTo: Optional[List[DocumentReferenceRelatesTo]] = None description: Annotated[ Optional[StrictStr], Field(description="Human–readable description of the source document."), ] = None securityLabel: Optional[List[CodeableConcept]] = None content: Annotated[List[DocumentReferenceContent], Field(min_length=1)] context: Annotated[ DocumentReferenceContext, Field(description="The clinical context in which the document was prepared."), ] class Bundle(Parent): resourceType: Literal["Bundle"] id: Annotated[ Optional[StrictStr], Field( description="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." ), ] = None meta: Annotated[ Optional[Meta], Field( description="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." ), ] = None implicitRules: Annotated[ Optional[StrictStr], Field( description="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." ), ] = None language: Annotated[ Optional[StrictStr], Field(description="The base language in which the resource is written."), ] = None identifier: Annotated[ Optional[Identifier], Field( description="A persistent identifier for the bundle that won't change as a bundle is copied from server to server." ), ] = None type: Annotated[ StrictStr, Field( description="Indicates the purpose of this bundle – how it is intended to be used." ), ] timestamp: Annotated[ Optional[StrictStr], Field( description="The date/time that the bundle was assembled – i.e. when the resources were placed in the bundle." ), ] = None total: Annotated[ Optional[StrictInt], Field( description="If a set of search matches, this is the total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle." ), ] = None link: Optional[List[BundleLink]] = None entry: Optional[List[BundleEntry]] = None signature: Annotated[ Optional[Signature], Field( description="Digital Signature – base64 encoded. XML–DSig or a JWT." ), ] = None class BundleEntry(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None link: Optional[List[BundleLink]] = None fullUrl: Annotated[ Optional[StrictStr], Field( description="The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource – i.e. if the fullUrl is not a urn:uuid, the URL shall be version–independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: \n* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)\n* Results from operations might involve resources that are not identified." ), ] = None resource: Annotated[ Optional[Union[DocumentReference, OperationOutcome]], Field( description="The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type." ), ] = None search: Annotated[ Optional[BundleEntrySearch], Field( description="Information about the search process that lead to the creation of this entry." ), ] = None request: Annotated[ Optional[BundleEntryRequest], Field( description="Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry." ), ] = None response: Annotated[ Optional[BundleEntryResponse], Field( description="Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history." ), ] = None class BundleEntryResponse(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None status: Annotated[ StrictStr, Field( description="The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code." ), ] location: Annotated[ Optional[StrictStr], Field( description="The location header created by processing this operation, populated if the operation returns a location." ), ] = None etag: Annotated[ Optional[StrictStr], Field( description="The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency))." ), ] = None lastModified: Annotated[ Optional[StrictStr], Field( description="The date/time that the resource was modified on the server." ), ] = None outcome: Annotated[ Optional[DocumentReference], Field( description="An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction." ), ] = None class DocumentReferenceContext(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None encounter: Optional[List[Reference]] = None event: Optional[List[CodeableConcept]] = None period: Annotated[ Optional[Period], Field( description="The time period over which the service that is described by the document was provided." ), ] = None facilityType: Annotated[ Optional[CodeableConcept], Field(description="The kind of facility where the patient was seen."), ] = None practiceSetting: Annotated[ NRLCodeableConcept, Field( description="This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty." ), ] sourcePatientInfo: Annotated[ Optional[Reference], Field( description="The Patient Information as known when the document was published. May be a reference to a version specific, or contained." ), ] = None related: Optional[List[Reference]] = None class DocumentReferenceRelatesTo(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None code: Annotated[ StrictStr, Field( description="The type of relationship that this document has with anther document." ), ] target: Annotated[ Reference, Field(description="The target document of this relationship.") ] class Identifier(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None use: Annotated[ Optional[StrictStr], Field(description="The purpose of this identifier.") ] = None type: Annotated[ Optional[CodeableConcept], Field( description="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose." ), ] = None system: Annotated[ Optional[StrictStr], Field( description="Establishes the namespace for the value – that is, a URL that describes a set values that are unique." ), ] = None value: Annotated[ Optional[StrictStr], Field( description="The portion of the identifier typically relevant to the user and which is unique within the context of the system." ), ] = None period: Annotated[ Optional[Period], Field(description="Time period during which identifier is/was valid for use."), ] = None assigner: Annotated[ Optional[Reference], Field(description="Organization that issued/manages the identifier."), ] = None class Reference(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None reference: Annotated[ Optional[StrictStr], Field( description="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." ), ] = None type: Annotated[ Optional[StrictStr], Field( description='The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).' ), ] = None identifier: Annotated[ Optional[Identifier], Field( description="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." ), ] = None display: Annotated[ Optional[StrictStr], Field( description="Plain text narrative that identifies the resource in addition to the resource reference." ), ] = None class Signature(Parent): id: Annotated[ Optional[StrictStr], Field( description="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ), ] = None type: Annotated[List[Coding], Field(min_length=1)] when: Annotated[ StrictStr, Field(description="When the digital signature was signed.") ] who: Annotated[ Reference, Field( description="A reference to an application–usable description of the identity that signed (e.g. the signature used their private key)." ), ] onBehalfOf: Annotated[ Optional[Reference], Field( description="A reference to an application–usable description of the identity that is represented by the signature." ), ] = None targetFormat: Annotated[ Optional[StrictStr], Field( description="A mime type that indicates the technical format of the target resources signed by the signature." ), ] = None sigFormat: Annotated[ Optional[StrictStr], Field( description="A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc." ), ] = None data: Annotated[ Optional[StrictStr], Field( description="The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty." ), ] = None DocumentReference.model_rebuild() Bundle.model_rebuild() BundleEntry.model_rebuild() DocumentReferenceContext.model_rebuild() DocumentReferenceRelatesTo.model_rebuild() Identifier.model_rebuild() NRLF-3.0.31/layer/nrlf/tests/000077500000000000000000000000001511201605300155505ustar00rootroot00000000000000NRLF-3.0.31/layer/nrlf/tests/data.py000066400000000000000000000017321511201605300170360ustar00rootroot00000000000000import json import pathlib from typing import Type from nrlf.core.types import DocumentReference from nrlf.producer.fhir.r4 import model as producer_model DATA_DIR = pathlib.Path(__file__).parent / "../../../tests/data/" FILE_CACHE = {} def load_document_reference_data(file_name: str) -> str: file_path = DATA_DIR / "DocumentReference" / f"{file_name}.json" if file_path in FILE_CACHE: return FILE_CACHE[file_path] if not file_path.exists(): raise FileNotFoundError(f"File not found: {file_path}") FILE_CACHE[file_path] = file_path.read_text() return FILE_CACHE[file_path] def load_document_reference_json(file_name: str) -> dict: contents = load_document_reference_data(file_name) return json.loads(contents) def load_document_reference( file_name: str, model: Type[DocumentReference] = producer_model.DocumentReference ): contents = load_document_reference_data(file_name) return model.model_validate_json(contents) NRLF-3.0.31/layer/nrlf/tests/dynamodb.py000066400000000000000000000036411511201605300177230ustar00rootroot00000000000000from nrlf.core.boto import get_dynamodb_resource from nrlf.core.config import Config from nrlf.core.dynamodb.repository import DocumentPointerRepository from nrlf.core.types import DynamoDBServiceResource def create_document_pointer_table(config: Config, dynamodb: DynamoDBServiceResource): return dynamodb.create_table( TableName=config.TABLE_NAME, KeySchema=[ {"AttributeName": "pk", "KeyType": "HASH"}, {"AttributeName": "sk", "KeyType": "RANGE"}, ], AttributeDefinitions=[ {"AttributeName": "pk", "AttributeType": "S"}, {"AttributeName": "sk", "AttributeType": "S"}, {"AttributeName": "patient_key", "AttributeType": "S"}, {"AttributeName": "patient_sort", "AttributeType": "S"}, {"AttributeName": "masterid_key", "AttributeType": "S"}, ], ProvisionedThroughput={"ReadCapacityUnits": 5, "WriteCapacityUnits": 5}, GlobalSecondaryIndexes=[ { "IndexName": "patient_gsi", "KeySchema": [ {"AttributeName": "patient_key", "KeyType": "HASH"}, {"AttributeName": "patient_sort", "KeyType": "RANGE"}, ], "Projection": {"ProjectionType": "ALL"}, }, { "IndexName": "masterid_gsi", "KeySchema": [ {"AttributeName": "masterid_key", "KeyType": "HASH"}, ], "Projection": {"ProjectionType": "ALL"}, }, ], ) def mock_repository(func): def wrapped_function(*args, **kwargs): config = Config() dynamodb = get_dynamodb_resource() create_document_pointer_table(config, dynamodb) repository = DocumentPointerRepository(table_name=config.TABLE_NAME) return func(*args, **kwargs, repository=repository) return wrapped_function NRLF-3.0.31/layer/nrlf/tests/events.py000066400000000000000000000045361511201605300174360ustar00rootroot00000000000000import json from typing import Any, Dict, List, Optional from unittest.mock import Mock def create_default_request_headers(headers: dict = {}) -> dict: return { **headers, } def create_headers( ods_code: str = "Y05868", nrl_permissions: Optional[List[str]] = [], app_name: Optional[str] = "TestApp", app_id: Optional[str] = "12345", nrl_app_id: Optional[str] = "Y05868-TestApp-12345678", additional_headers: Optional[Dict[str, str]] = {}, ) -> Dict[str, str]: return { "nhsd-connection-metadata": json.dumps( { "nrl.ods-code": ods_code, "nrl.permissions": nrl_permissions, "nrl.app-id": nrl_app_id, "nrl.test-event": True, } ), "nhsd-client-rp-details": json.dumps( {"developer.app.name": app_name, "developer.app.id": app_id} ), "X-Request-Id": "test_request_id", "NHSD-Correlation-Id": "test_correlation_id", **additional_headers, } def default_response_headers(): return { "X-Request-Id": "test_request_id", } def create_test_api_gateway_event( headers: Optional[Dict[str, str]] = {}, query_string_parameters: Optional[Dict[str, str]] = None, path_parameters: Optional[Dict[str, str]] = None, body: Optional[str] = None, ) -> Dict[str, Any]: return { "resource": "/", "path": "/", "httpMethod": "GET", "requestContext": { "resourcePath": "/", "httpMethod": "GET", "path": "/Prod/", "identity": { "clientCert": { "subjectDN": "CN=TEST SUBJECT", "issuerDN": "CN=TEST ISSUER", "serialNumber": "0000001", } }, }, "headers": headers or create_headers(), "multiValueHeaders": {}, "queryStringParameters": query_string_parameters or {}, "multiValueQueryStringParameters": None, "pathParameters": path_parameters, "stageVariables": None, "body": body, "isBase64Encoded": None, } def create_mock_context(): return Mock( function_name="test_function", function_version="1", invoked_function_arn="arn:aws:lambda:eu-west-2:123456789012:function:test_function:1", ) NRLF-3.0.31/layer/pyproject.toml000066400000000000000000000004051511201605300163600ustar00rootroot00000000000000[tool.poetry] name = "layers" version = "0.1.0" description = "" authors = [] packages = [ { include = "nrlf", from = "." }, ] [tool.poetry.dependencies] python = "^3.12" [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" NRLF-3.0.31/layer/test_permissions/000077500000000000000000000000001511201605300170575ustar00rootroot00000000000000NRLF-3.0.31/layer/test_permissions/Y05868-TestApp-12345678/000077500000000000000000000000001511201605300222015ustar00rootroot00000000000000NRLF-3.0.31/layer/test_permissions/Y05868-TestApp-12345678/RQI.json000066400000000000000000000000451511201605300235260ustar00rootroot00000000000000["http://snomed.info/sct|736253001"] NRLF-3.0.31/layer/test_permissions/Y05868-TestApp-12345678/TestCode.json000066400000000000000000000000451511201605300246050ustar00rootroot00000000000000["http://snomed.info/sct|736253001"] NRLF-3.0.31/layer/test_permissions/Y05868-TestApp-12345678/X26.json000066400000000000000000000000531511201605300234510ustar00rootroot00000000000000["http://snomed.info/sct|861421000000109"] NRLF-3.0.31/layer/test_permissions/Y05868-TestApp-12345678/Y05868.json000066400000000000000000000003641511201605300237220ustar00rootroot00000000000000[ "http://snomed.info/sct|736253001", "http://snomed.info/sct|736253002", "http://snomed.info/sct|1363501000000100", "http://snomed.info/sct|861421000000109", "http://snomed.info/sct|749001000000101", "https://nicip.nhs.uk|MAULR" ] NRLF-3.0.31/poetry.lock000066400000000000000000006763321511201605300145460ustar00rootroot00000000000000# This file is automatically @generated by Poetry 2.2.1 and should not be changed by hand. [[package]] name = "allure-behave" version = "2.13.5" description = "Allure behave integration" optional = false python-versions = "*" groups = ["dev"] files = [ {file = "allure-behave-2.13.5.tar.gz", hash = "sha256:338ca2cc7395d1ee3dd72f5d7d92d8920f1ade0e07ddebc637b38e61e06dc8dc"}, {file = "allure_behave-2.13.5-py3-none-any.whl", hash = "sha256:8b04291f435af536b46c3cbd20d33e61b27f5e25dd2fff2fdc1dc3fa2474e23e"}, ] [package.dependencies] allure-python-commons = "2.13.5" behave = ">=1.2.5" [[package]] name = "allure-pytest" version = "2.13.5" description = "Allure pytest integration" optional = false python-versions = "*" groups = ["dev"] files = [ {file = "allure-pytest-2.13.5.tar.gz", hash = "sha256:0ef8e1790c44a988db6b83c4d4f5e91451e2c4c8ea10601dfa88528d23afcf6e"}, {file = "allure_pytest-2.13.5-py3-none-any.whl", hash = "sha256:94130bac32964b78058e62cf4b815ad97a5ac82a065e6dd2d43abac2be7640fc"}, ] [package.dependencies] allure-python-commons = "2.13.5" pytest = ">=4.5.0" [[package]] name = "allure-python-commons" version = "2.13.5" description = "('Contains the API for end users as well as helper functions and classes to build Allure adapters for Python test frameworks',)" optional = false python-versions = ">=3.6" groups = ["dev"] files = [ {file = "allure-python-commons-2.13.5.tar.gz", hash = "sha256:a232e7955811f988e49a4c1dd6c16cce7e9b81d0ea0422b1e5654d3254e2caf3"}, {file = "allure_python_commons-2.13.5-py3-none-any.whl", hash = "sha256:8b0e837b6e32d810adec563f49e1d04127a5b6770e0232065b7cb09b9953980d"}, ] [package.dependencies] attrs = ">=16.0.0" pluggy = ">=0.4.0" [[package]] name = "annotated-types" version = "0.7.0" description = "Reusable constraint types to use with typing.Annotated" optional = false python-versions = ">=3.8" groups = ["main", "dev"] files = [ {file = "annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53"}, {file = "annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89"}, ] [[package]] name = "argcomplete" version = "3.2.3" description = "Bash tab completion for argparse" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "argcomplete-3.2.3-py3-none-any.whl", hash = "sha256:c12355e0494c76a2a7b73e3a59b09024ca0ba1e279fb9ed6c1b82d5b74b6a70c"}, {file = "argcomplete-3.2.3.tar.gz", hash = "sha256:bf7900329262e481be5a15f56f19736b376df6f82ed27576fa893652c5de6c23"}, ] [package.extras] test = ["coverage", "mypy", "pexpect", "ruff", "wheel"] [[package]] name = "attrs" version = "23.2.0" description = "Classes Without Boilerplate" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "attrs-23.2.0-py3-none-any.whl", hash = "sha256:99b87a485a5820b23b879f04c2305b44b951b502fd64be915879d77a7e8fc6f1"}, {file = "attrs-23.2.0.tar.gz", hash = "sha256:935dc3b529c262f6cf76e50877d35a4bd3c1de194fd41f47a2b7ae8f19971f30"}, ] [package.extras] cov = ["attrs[tests]", "coverage[toml] (>=5.3)"] dev = ["attrs[tests]", "pre-commit"] docs = ["furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphinxcontrib-towncrier", "towncrier", "zope-interface"] tests = ["attrs[tests-no-zope]", "zope-interface"] tests-mypy = ["mypy (>=1.6) ; platform_python_implementation == \"CPython\" and python_version >= \"3.8\"", "pytest-mypy-plugins ; platform_python_implementation == \"CPython\" and python_version >= \"3.8\""] tests-no-zope = ["attrs[tests-mypy]", "cloudpickle ; platform_python_implementation == \"CPython\"", "hypothesis", "pympler", "pytest (>=4.3.0)", "pytest-xdist[psutil]"] [[package]] name = "aws-lambda-powertools" version = "2.35.1" description = "Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity." optional = false python-versions = ">=3.8,<4.0.0" groups = ["main"] files = [ {file = "aws_lambda_powertools-2.35.1-py3-none-any.whl", hash = "sha256:70ff17435a973d9dffff9f99c513477de190c675ad8c0297f67951f0724adcda"}, {file = "aws_lambda_powertools-2.35.1.tar.gz", hash = "sha256:dc58bbe8a81c22f8cf525cac5c09fa3fcabfd1a4b2ec2abbfeb4c445e0912aa5"}, ] [package.dependencies] typing-extensions = ">=4.6.2,<5.0.0" [package.extras] all = ["aws-xray-sdk (>=2.8.0,<3.0.0)", "fastjsonschema (>=2.14.5,<3.0.0)", "pydantic (>=1.8.2,<2.0.0)"] aws-sdk = ["boto3 (>=1.26.164,<2.0.0)"] datadog = ["datadog-lambda (>=4.77,<6.0)"] datamasking = ["aws-encryption-sdk (>=3.1.1,<4.0.0)", "jsonpath-ng (>=1.6.0,<2.0.0)"] parser = ["pydantic (>=1.8.2,<2.0.0)"] redis = ["redis (>=4.4,<6.0)"] tracer = ["aws-xray-sdk (>=2.8.0,<3.0.0)"] validation = ["fastjsonschema (>=2.14.5,<3.0.0)"] [[package]] name = "behave" version = "1.2.6" description = "behave is behaviour-driven development, Python style" optional = false python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" groups = ["dev"] files = [ {file = "behave-1.2.6-py2.py3-none-any.whl", hash = "sha256:ebda1a6c9e5bfe95c5f9f0a2794e01c7098b3dde86c10a95d8621c5907ff6f1c"}, {file = "behave-1.2.6.tar.gz", hash = "sha256:b9662327aa53294c1351b0a9c369093ccec1d21026f050c3bd9b3e5cccf81a86"}, ] [package.dependencies] parse = ">=1.8.2" parse-type = ">=0.4.2" six = ">=1.11" [package.extras] develop = ["coverage", "invoke (>=0.21.0)", "modernize (>=0.5)", "path.py (>=8.1.2)", "pathlib", "pycmd", "pylint", "pytest (>=3.0)", "pytest-cov", "tox"] docs = ["sphinx (>=1.6)", "sphinx-bootstrap-theme (>=0.6)"] [[package]] name = "black" version = "24.3.0" description = "The uncompromising code formatter." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "black-24.3.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7d5e026f8da0322b5662fa7a8e752b3fa2dac1c1cbc213c3d7ff9bdd0ab12395"}, {file = "black-24.3.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9f50ea1132e2189d8dff0115ab75b65590a3e97de1e143795adb4ce317934995"}, {file = "black-24.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e2af80566f43c85f5797365077fb64a393861a3730bd110971ab7a0c94e873e7"}, {file = "black-24.3.0-cp310-cp310-win_amd64.whl", hash = "sha256:4be5bb28e090456adfc1255e03967fb67ca846a03be7aadf6249096100ee32d0"}, {file = "black-24.3.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4f1373a7808a8f135b774039f61d59e4be7eb56b2513d3d2f02a8b9365b8a8a9"}, {file = "black-24.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:aadf7a02d947936ee418777e0247ea114f78aff0d0959461057cae8a04f20597"}, {file = "black-24.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:65c02e4ea2ae09d16314d30912a58ada9a5c4fdfedf9512d23326128ac08ac3d"}, {file = "black-24.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:bf21b7b230718a5f08bd32d5e4f1db7fc8788345c8aea1d155fc17852b3410f5"}, {file = "black-24.3.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:2818cf72dfd5d289e48f37ccfa08b460bf469e67fb7c4abb07edc2e9f16fb63f"}, {file = "black-24.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:4acf672def7eb1725f41f38bf6bf425c8237248bb0804faa3965c036f7672d11"}, {file = "black-24.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c7ed6668cbbfcd231fa0dc1b137d3e40c04c7f786e626b405c62bcd5db5857e4"}, {file = "black-24.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:56f52cfbd3dabe2798d76dbdd299faa046a901041faf2cf33288bc4e6dae57b5"}, {file = "black-24.3.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:79dcf34b33e38ed1b17434693763301d7ccbd1c5860674a8f871bd15139e7837"}, {file = "black-24.3.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:e19cb1c6365fd6dc38a6eae2dcb691d7d83935c10215aef8e6c38edee3f77abd"}, {file = "black-24.3.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:65b76c275e4c1c5ce6e9870911384bff5ca31ab63d19c76811cb1fb162678213"}, {file = "black-24.3.0-cp38-cp38-win_amd64.whl", hash = "sha256:b5991d523eee14756f3c8d5df5231550ae8993e2286b8014e2fdea7156ed0959"}, {file = "black-24.3.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:c45f8dff244b3c431b36e3224b6be4a127c6aca780853574c00faf99258041eb"}, {file = "black-24.3.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:6905238a754ceb7788a73f02b45637d820b2f5478b20fec82ea865e4f5d4d9f7"}, {file = "black-24.3.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d7de8d330763c66663661a1ffd432274a2f92f07feeddd89ffd085b5744f85e7"}, {file = "black-24.3.0-cp39-cp39-win_amd64.whl", hash = "sha256:7bb041dca0d784697af4646d3b62ba4a6b028276ae878e53f6b4f74ddd6db99f"}, {file = "black-24.3.0-py3-none-any.whl", hash = "sha256:41622020d7120e01d377f74249e677039d20e6344ff5851de8a10f11f513bf93"}, {file = "black-24.3.0.tar.gz", hash = "sha256:a0c9c4a0771afc6919578cec71ce82a3e31e054904e7197deacbc9382671c41f"}, ] [package.dependencies] click = ">=8.0.0" mypy-extensions = ">=0.4.3" packaging = ">=22.0" pathspec = ">=0.9.0" platformdirs = ">=2" [package.extras] colorama = ["colorama (>=0.4.3)"] d = ["aiohttp (>=3.7.4) ; sys_platform != \"win32\" or implementation_name != \"pypy\"", "aiohttp (>=3.7.4,!=3.9.0) ; sys_platform == \"win32\" and implementation_name == \"pypy\""] jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] uvloop = ["uvloop (>=0.15.2)"] [[package]] name = "boto3" version = "1.40.66" description = "The AWS SDK for Python" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "boto3-1.40.66-py3-none-any.whl", hash = "sha256:ee4fe21c5301cc0e11cc11a53e71e5ddd82d5fae42b10fa8e5403f3aa06434e3"}, {file = "boto3-1.40.66.tar.gz", hash = "sha256:f2038d9bac5154da7390c29bfd013546ac96609e7ce5a7f3cb6f99412be3f4c0"}, ] [package.dependencies] botocore = ">=1.40.66,<1.41.0" jmespath = ">=0.7.1,<2.0.0" s3transfer = ">=0.14.0,<0.15.0" [package.extras] crt = ["botocore[crt] (>=1.21.0,<2.0a0)"] [[package]] name = "boto3-stubs" version = "1.40.59" description = "Type annotations for boto3 1.40.59 generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "boto3_stubs-1.40.59-py3-none-any.whl", hash = "sha256:8f2e623d9960d63ad4231a5991c25c92b145240e6b798d5045f79ff0e2807f8f"}, {file = "boto3_stubs-1.40.59.tar.gz", hash = "sha256:0791851ecfd465c5d76bd316f48c0113811c11c89521a48c5318d8a25b6fe8dd"}, ] [package.dependencies] botocore-stubs = "*" mypy-boto3-dynamodb = {version = ">=1.40.0,<1.41.0", optional = true, markers = "extra == \"dynamodb\""} mypy-boto3-firehose = {version = ">=1.40.0,<1.41.0", optional = true, markers = "extra == \"firehose\""} mypy-boto3-kinesis = {version = ">=1.40.0,<1.41.0", optional = true, markers = "extra == \"kinesis\""} mypy-boto3-lambda = {version = ">=1.40.0,<1.41.0", optional = true, markers = "extra == \"lambda\""} mypy-boto3-rds = {version = ">=1.40.0,<1.41.0", optional = true, markers = "extra == \"rds\""} mypy-boto3-s3 = {version = ">=1.40.0,<1.41.0", optional = true, markers = "extra == \"s3\""} types-s3transfer = "*" [package.extras] accessanalyzer = ["mypy-boto3-accessanalyzer (>=1.40.0,<1.41.0)"] account = ["mypy-boto3-account (>=1.40.0,<1.41.0)"] acm = ["mypy-boto3-acm (>=1.40.0,<1.41.0)"] acm-pca = ["mypy-boto3-acm-pca (>=1.40.0,<1.41.0)"] aiops = ["mypy-boto3-aiops (>=1.40.0,<1.41.0)"] all = ["mypy-boto3-accessanalyzer (>=1.40.0,<1.41.0)", "mypy-boto3-account (>=1.40.0,<1.41.0)", "mypy-boto3-acm (>=1.40.0,<1.41.0)", "mypy-boto3-acm-pca (>=1.40.0,<1.41.0)", "mypy-boto3-aiops (>=1.40.0,<1.41.0)", "mypy-boto3-amp (>=1.40.0,<1.41.0)", "mypy-boto3-amplify (>=1.40.0,<1.41.0)", "mypy-boto3-amplifybackend (>=1.40.0,<1.41.0)", "mypy-boto3-amplifyuibuilder (>=1.40.0,<1.41.0)", "mypy-boto3-apigateway (>=1.40.0,<1.41.0)", "mypy-boto3-apigatewaymanagementapi (>=1.40.0,<1.41.0)", "mypy-boto3-apigatewayv2 (>=1.40.0,<1.41.0)", "mypy-boto3-appconfig (>=1.40.0,<1.41.0)", "mypy-boto3-appconfigdata (>=1.40.0,<1.41.0)", "mypy-boto3-appfabric (>=1.40.0,<1.41.0)", "mypy-boto3-appflow (>=1.40.0,<1.41.0)", "mypy-boto3-appintegrations (>=1.40.0,<1.41.0)", "mypy-boto3-application-autoscaling (>=1.40.0,<1.41.0)", "mypy-boto3-application-insights (>=1.40.0,<1.41.0)", "mypy-boto3-application-signals (>=1.40.0,<1.41.0)", "mypy-boto3-applicationcostprofiler (>=1.40.0,<1.41.0)", "mypy-boto3-appmesh (>=1.40.0,<1.41.0)", "mypy-boto3-apprunner (>=1.40.0,<1.41.0)", "mypy-boto3-appstream (>=1.40.0,<1.41.0)", "mypy-boto3-appsync (>=1.40.0,<1.41.0)", "mypy-boto3-apptest (>=1.40.0,<1.41.0)", "mypy-boto3-arc-region-switch (>=1.40.0,<1.41.0)", "mypy-boto3-arc-zonal-shift (>=1.40.0,<1.41.0)", "mypy-boto3-artifact (>=1.40.0,<1.41.0)", "mypy-boto3-athena (>=1.40.0,<1.41.0)", "mypy-boto3-auditmanager (>=1.40.0,<1.41.0)", "mypy-boto3-autoscaling (>=1.40.0,<1.41.0)", "mypy-boto3-autoscaling-plans (>=1.40.0,<1.41.0)", "mypy-boto3-b2bi (>=1.40.0,<1.41.0)", "mypy-boto3-backup (>=1.40.0,<1.41.0)", "mypy-boto3-backup-gateway (>=1.40.0,<1.41.0)", "mypy-boto3-backupsearch (>=1.40.0,<1.41.0)", "mypy-boto3-batch (>=1.40.0,<1.41.0)", "mypy-boto3-bcm-dashboards (>=1.40.0,<1.41.0)", "mypy-boto3-bcm-data-exports (>=1.40.0,<1.41.0)", "mypy-boto3-bcm-pricing-calculator (>=1.40.0,<1.41.0)", "mypy-boto3-bcm-recommended-actions (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-agent (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-agent-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-agentcore (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-agentcore-control (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-data-automation (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-data-automation-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-bedrock-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-billing (>=1.40.0,<1.41.0)", "mypy-boto3-billingconductor (>=1.40.0,<1.41.0)", "mypy-boto3-braket (>=1.40.0,<1.41.0)", "mypy-boto3-budgets (>=1.40.0,<1.41.0)", "mypy-boto3-ce (>=1.40.0,<1.41.0)", "mypy-boto3-chatbot (>=1.40.0,<1.41.0)", "mypy-boto3-chime (>=1.40.0,<1.41.0)", "mypy-boto3-chime-sdk-identity (>=1.40.0,<1.41.0)", "mypy-boto3-chime-sdk-media-pipelines (>=1.40.0,<1.41.0)", "mypy-boto3-chime-sdk-meetings (>=1.40.0,<1.41.0)", "mypy-boto3-chime-sdk-messaging (>=1.40.0,<1.41.0)", "mypy-boto3-chime-sdk-voice (>=1.40.0,<1.41.0)", "mypy-boto3-cleanrooms (>=1.40.0,<1.41.0)", "mypy-boto3-cleanroomsml (>=1.40.0,<1.41.0)", "mypy-boto3-cloud9 (>=1.40.0,<1.41.0)", "mypy-boto3-cloudcontrol (>=1.40.0,<1.41.0)", "mypy-boto3-clouddirectory (>=1.40.0,<1.41.0)", "mypy-boto3-cloudformation (>=1.40.0,<1.41.0)", "mypy-boto3-cloudfront (>=1.40.0,<1.41.0)", "mypy-boto3-cloudfront-keyvaluestore (>=1.40.0,<1.41.0)", "mypy-boto3-cloudhsm (>=1.40.0,<1.41.0)", "mypy-boto3-cloudhsmv2 (>=1.40.0,<1.41.0)", "mypy-boto3-cloudsearch (>=1.40.0,<1.41.0)", "mypy-boto3-cloudsearchdomain (>=1.40.0,<1.41.0)", "mypy-boto3-cloudtrail (>=1.40.0,<1.41.0)", "mypy-boto3-cloudtrail-data (>=1.40.0,<1.41.0)", "mypy-boto3-cloudwatch (>=1.40.0,<1.41.0)", "mypy-boto3-codeartifact (>=1.40.0,<1.41.0)", "mypy-boto3-codebuild (>=1.40.0,<1.41.0)", "mypy-boto3-codecatalyst (>=1.40.0,<1.41.0)", "mypy-boto3-codecommit (>=1.40.0,<1.41.0)", "mypy-boto3-codeconnections (>=1.40.0,<1.41.0)", "mypy-boto3-codedeploy (>=1.40.0,<1.41.0)", "mypy-boto3-codeguru-reviewer (>=1.40.0,<1.41.0)", "mypy-boto3-codeguru-security (>=1.40.0,<1.41.0)", "mypy-boto3-codeguruprofiler (>=1.40.0,<1.41.0)", "mypy-boto3-codepipeline (>=1.40.0,<1.41.0)", "mypy-boto3-codestar-connections (>=1.40.0,<1.41.0)", "mypy-boto3-codestar-notifications (>=1.40.0,<1.41.0)", "mypy-boto3-cognito-identity (>=1.40.0,<1.41.0)", "mypy-boto3-cognito-idp (>=1.40.0,<1.41.0)", "mypy-boto3-cognito-sync (>=1.40.0,<1.41.0)", "mypy-boto3-comprehend (>=1.40.0,<1.41.0)", "mypy-boto3-comprehendmedical (>=1.40.0,<1.41.0)", "mypy-boto3-compute-optimizer (>=1.40.0,<1.41.0)", "mypy-boto3-config (>=1.40.0,<1.41.0)", "mypy-boto3-connect (>=1.40.0,<1.41.0)", "mypy-boto3-connect-contact-lens (>=1.40.0,<1.41.0)", "mypy-boto3-connectcampaigns (>=1.40.0,<1.41.0)", "mypy-boto3-connectcampaignsv2 (>=1.40.0,<1.41.0)", "mypy-boto3-connectcases (>=1.40.0,<1.41.0)", "mypy-boto3-connectparticipant (>=1.40.0,<1.41.0)", "mypy-boto3-controlcatalog (>=1.40.0,<1.41.0)", "mypy-boto3-controltower (>=1.40.0,<1.41.0)", "mypy-boto3-cost-optimization-hub (>=1.40.0,<1.41.0)", "mypy-boto3-cur (>=1.40.0,<1.41.0)", "mypy-boto3-customer-profiles (>=1.40.0,<1.41.0)", "mypy-boto3-databrew (>=1.40.0,<1.41.0)", "mypy-boto3-dataexchange (>=1.40.0,<1.41.0)", "mypy-boto3-datapipeline (>=1.40.0,<1.41.0)", "mypy-boto3-datasync (>=1.40.0,<1.41.0)", "mypy-boto3-datazone (>=1.40.0,<1.41.0)", "mypy-boto3-dax (>=1.40.0,<1.41.0)", "mypy-boto3-deadline (>=1.40.0,<1.41.0)", "mypy-boto3-detective (>=1.40.0,<1.41.0)", "mypy-boto3-devicefarm (>=1.40.0,<1.41.0)", "mypy-boto3-devops-guru (>=1.40.0,<1.41.0)", "mypy-boto3-directconnect (>=1.40.0,<1.41.0)", "mypy-boto3-discovery (>=1.40.0,<1.41.0)", "mypy-boto3-dlm (>=1.40.0,<1.41.0)", "mypy-boto3-dms (>=1.40.0,<1.41.0)", "mypy-boto3-docdb (>=1.40.0,<1.41.0)", "mypy-boto3-docdb-elastic (>=1.40.0,<1.41.0)", "mypy-boto3-drs (>=1.40.0,<1.41.0)", "mypy-boto3-ds (>=1.40.0,<1.41.0)", "mypy-boto3-ds-data (>=1.40.0,<1.41.0)", "mypy-boto3-dsql (>=1.40.0,<1.41.0)", "mypy-boto3-dynamodb (>=1.40.0,<1.41.0)", "mypy-boto3-dynamodbstreams (>=1.40.0,<1.41.0)", "mypy-boto3-ebs (>=1.40.0,<1.41.0)", "mypy-boto3-ec2 (>=1.40.0,<1.41.0)", "mypy-boto3-ec2-instance-connect (>=1.40.0,<1.41.0)", "mypy-boto3-ecr (>=1.40.0,<1.41.0)", "mypy-boto3-ecr-public (>=1.40.0,<1.41.0)", "mypy-boto3-ecs (>=1.40.0,<1.41.0)", "mypy-boto3-efs (>=1.40.0,<1.41.0)", "mypy-boto3-eks (>=1.40.0,<1.41.0)", "mypy-boto3-eks-auth (>=1.40.0,<1.41.0)", "mypy-boto3-elasticache (>=1.40.0,<1.41.0)", "mypy-boto3-elasticbeanstalk (>=1.40.0,<1.41.0)", "mypy-boto3-elastictranscoder (>=1.40.0,<1.41.0)", "mypy-boto3-elb (>=1.40.0,<1.41.0)", "mypy-boto3-elbv2 (>=1.40.0,<1.41.0)", "mypy-boto3-emr (>=1.40.0,<1.41.0)", "mypy-boto3-emr-containers (>=1.40.0,<1.41.0)", "mypy-boto3-emr-serverless (>=1.40.0,<1.41.0)", "mypy-boto3-entityresolution (>=1.40.0,<1.41.0)", "mypy-boto3-es (>=1.40.0,<1.41.0)", "mypy-boto3-events (>=1.40.0,<1.41.0)", "mypy-boto3-evidently (>=1.40.0,<1.41.0)", "mypy-boto3-evs (>=1.40.0,<1.41.0)", "mypy-boto3-finspace (>=1.40.0,<1.41.0)", "mypy-boto3-finspace-data (>=1.40.0,<1.41.0)", "mypy-boto3-firehose (>=1.40.0,<1.41.0)", "mypy-boto3-fis (>=1.40.0,<1.41.0)", "mypy-boto3-fms (>=1.40.0,<1.41.0)", "mypy-boto3-forecast (>=1.40.0,<1.41.0)", "mypy-boto3-forecastquery (>=1.40.0,<1.41.0)", "mypy-boto3-frauddetector (>=1.40.0,<1.41.0)", "mypy-boto3-freetier (>=1.40.0,<1.41.0)", "mypy-boto3-fsx (>=1.40.0,<1.41.0)", "mypy-boto3-gamelift (>=1.40.0,<1.41.0)", "mypy-boto3-gameliftstreams (>=1.40.0,<1.41.0)", "mypy-boto3-geo-maps (>=1.40.0,<1.41.0)", "mypy-boto3-geo-places (>=1.40.0,<1.41.0)", "mypy-boto3-geo-routes (>=1.40.0,<1.41.0)", "mypy-boto3-glacier (>=1.40.0,<1.41.0)", "mypy-boto3-globalaccelerator (>=1.40.0,<1.41.0)", "mypy-boto3-glue (>=1.40.0,<1.41.0)", "mypy-boto3-grafana (>=1.40.0,<1.41.0)", "mypy-boto3-greengrass (>=1.40.0,<1.41.0)", "mypy-boto3-greengrassv2 (>=1.40.0,<1.41.0)", "mypy-boto3-groundstation (>=1.40.0,<1.41.0)", "mypy-boto3-guardduty (>=1.40.0,<1.41.0)", "mypy-boto3-health (>=1.40.0,<1.41.0)", "mypy-boto3-healthlake (>=1.40.0,<1.41.0)", "mypy-boto3-iam (>=1.40.0,<1.41.0)", "mypy-boto3-identitystore (>=1.40.0,<1.41.0)", "mypy-boto3-imagebuilder (>=1.40.0,<1.41.0)", "mypy-boto3-importexport (>=1.40.0,<1.41.0)", "mypy-boto3-inspector (>=1.40.0,<1.41.0)", "mypy-boto3-inspector-scan (>=1.40.0,<1.41.0)", "mypy-boto3-inspector2 (>=1.40.0,<1.41.0)", "mypy-boto3-internetmonitor (>=1.40.0,<1.41.0)", "mypy-boto3-invoicing (>=1.40.0,<1.41.0)", "mypy-boto3-iot (>=1.40.0,<1.41.0)", "mypy-boto3-iot-data (>=1.40.0,<1.41.0)", "mypy-boto3-iot-jobs-data (>=1.40.0,<1.41.0)", "mypy-boto3-iot-managed-integrations (>=1.40.0,<1.41.0)", "mypy-boto3-iotanalytics (>=1.40.0,<1.41.0)", "mypy-boto3-iotdeviceadvisor (>=1.40.0,<1.41.0)", "mypy-boto3-iotevents (>=1.40.0,<1.41.0)", "mypy-boto3-iotevents-data (>=1.40.0,<1.41.0)", "mypy-boto3-iotfleethub (>=1.40.0,<1.41.0)", "mypy-boto3-iotfleetwise (>=1.40.0,<1.41.0)", "mypy-boto3-iotsecuretunneling (>=1.40.0,<1.41.0)", "mypy-boto3-iotsitewise (>=1.40.0,<1.41.0)", "mypy-boto3-iotthingsgraph (>=1.40.0,<1.41.0)", "mypy-boto3-iottwinmaker (>=1.40.0,<1.41.0)", "mypy-boto3-iotwireless (>=1.40.0,<1.41.0)", "mypy-boto3-ivs (>=1.40.0,<1.41.0)", "mypy-boto3-ivs-realtime (>=1.40.0,<1.41.0)", "mypy-boto3-ivschat (>=1.40.0,<1.41.0)", "mypy-boto3-kafka (>=1.40.0,<1.41.0)", "mypy-boto3-kafkaconnect (>=1.40.0,<1.41.0)", "mypy-boto3-kendra (>=1.40.0,<1.41.0)", "mypy-boto3-kendra-ranking (>=1.40.0,<1.41.0)", "mypy-boto3-keyspaces (>=1.40.0,<1.41.0)", "mypy-boto3-keyspacesstreams (>=1.40.0,<1.41.0)", "mypy-boto3-kinesis (>=1.40.0,<1.41.0)", "mypy-boto3-kinesis-video-archived-media (>=1.40.0,<1.41.0)", "mypy-boto3-kinesis-video-media (>=1.40.0,<1.41.0)", "mypy-boto3-kinesis-video-signaling (>=1.40.0,<1.41.0)", "mypy-boto3-kinesis-video-webrtc-storage (>=1.40.0,<1.41.0)", "mypy-boto3-kinesisanalytics (>=1.40.0,<1.41.0)", "mypy-boto3-kinesisanalyticsv2 (>=1.40.0,<1.41.0)", "mypy-boto3-kinesisvideo (>=1.40.0,<1.41.0)", "mypy-boto3-kms (>=1.40.0,<1.41.0)", "mypy-boto3-lakeformation (>=1.40.0,<1.41.0)", "mypy-boto3-lambda (>=1.40.0,<1.41.0)", "mypy-boto3-launch-wizard (>=1.40.0,<1.41.0)", "mypy-boto3-lex-models (>=1.40.0,<1.41.0)", "mypy-boto3-lex-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-lexv2-models (>=1.40.0,<1.41.0)", "mypy-boto3-lexv2-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-license-manager (>=1.40.0,<1.41.0)", "mypy-boto3-license-manager-linux-subscriptions (>=1.40.0,<1.41.0)", "mypy-boto3-license-manager-user-subscriptions (>=1.40.0,<1.41.0)", "mypy-boto3-lightsail (>=1.40.0,<1.41.0)", "mypy-boto3-location (>=1.40.0,<1.41.0)", "mypy-boto3-logs (>=1.40.0,<1.41.0)", "mypy-boto3-lookoutequipment (>=1.40.0,<1.41.0)", "mypy-boto3-lookoutmetrics (>=1.40.0,<1.41.0)", "mypy-boto3-lookoutvision (>=1.40.0,<1.41.0)", "mypy-boto3-m2 (>=1.40.0,<1.41.0)", "mypy-boto3-machinelearning (>=1.40.0,<1.41.0)", "mypy-boto3-macie2 (>=1.40.0,<1.41.0)", "mypy-boto3-mailmanager (>=1.40.0,<1.41.0)", "mypy-boto3-managedblockchain (>=1.40.0,<1.41.0)", "mypy-boto3-managedblockchain-query (>=1.40.0,<1.41.0)", "mypy-boto3-marketplace-agreement (>=1.40.0,<1.41.0)", "mypy-boto3-marketplace-catalog (>=1.40.0,<1.41.0)", "mypy-boto3-marketplace-deployment (>=1.40.0,<1.41.0)", "mypy-boto3-marketplace-entitlement (>=1.40.0,<1.41.0)", "mypy-boto3-marketplace-reporting (>=1.40.0,<1.41.0)", "mypy-boto3-marketplacecommerceanalytics (>=1.40.0,<1.41.0)", "mypy-boto3-mediaconnect (>=1.40.0,<1.41.0)", "mypy-boto3-mediaconvert (>=1.40.0,<1.41.0)", "mypy-boto3-medialive (>=1.40.0,<1.41.0)", "mypy-boto3-mediapackage (>=1.40.0,<1.41.0)", "mypy-boto3-mediapackage-vod (>=1.40.0,<1.41.0)", "mypy-boto3-mediapackagev2 (>=1.40.0,<1.41.0)", "mypy-boto3-mediastore (>=1.40.0,<1.41.0)", "mypy-boto3-mediastore-data (>=1.40.0,<1.41.0)", "mypy-boto3-mediatailor (>=1.40.0,<1.41.0)", "mypy-boto3-medical-imaging (>=1.40.0,<1.41.0)", "mypy-boto3-memorydb (>=1.40.0,<1.41.0)", "mypy-boto3-meteringmarketplace (>=1.40.0,<1.41.0)", "mypy-boto3-mgh (>=1.40.0,<1.41.0)", "mypy-boto3-mgn (>=1.40.0,<1.41.0)", "mypy-boto3-migration-hub-refactor-spaces (>=1.40.0,<1.41.0)", "mypy-boto3-migrationhub-config (>=1.40.0,<1.41.0)", "mypy-boto3-migrationhuborchestrator (>=1.40.0,<1.41.0)", "mypy-boto3-migrationhubstrategy (>=1.40.0,<1.41.0)", "mypy-boto3-mpa (>=1.40.0,<1.41.0)", "mypy-boto3-mq (>=1.40.0,<1.41.0)", "mypy-boto3-mturk (>=1.40.0,<1.41.0)", "mypy-boto3-mwaa (>=1.40.0,<1.41.0)", "mypy-boto3-neptune (>=1.40.0,<1.41.0)", "mypy-boto3-neptune-graph (>=1.40.0,<1.41.0)", "mypy-boto3-neptunedata (>=1.40.0,<1.41.0)", "mypy-boto3-network-firewall (>=1.40.0,<1.41.0)", "mypy-boto3-networkflowmonitor (>=1.40.0,<1.41.0)", "mypy-boto3-networkmanager (>=1.40.0,<1.41.0)", "mypy-boto3-networkmonitor (>=1.40.0,<1.41.0)", "mypy-boto3-notifications (>=1.40.0,<1.41.0)", "mypy-boto3-notificationscontacts (>=1.40.0,<1.41.0)", "mypy-boto3-oam (>=1.40.0,<1.41.0)", "mypy-boto3-observabilityadmin (>=1.40.0,<1.41.0)", "mypy-boto3-odb (>=1.40.0,<1.41.0)", "mypy-boto3-omics (>=1.40.0,<1.41.0)", "mypy-boto3-opensearch (>=1.40.0,<1.41.0)", "mypy-boto3-opensearchserverless (>=1.40.0,<1.41.0)", "mypy-boto3-organizations (>=1.40.0,<1.41.0)", "mypy-boto3-osis (>=1.40.0,<1.41.0)", "mypy-boto3-outposts (>=1.40.0,<1.41.0)", "mypy-boto3-panorama (>=1.40.0,<1.41.0)", "mypy-boto3-partnercentral-selling (>=1.40.0,<1.41.0)", "mypy-boto3-payment-cryptography (>=1.40.0,<1.41.0)", "mypy-boto3-payment-cryptography-data (>=1.40.0,<1.41.0)", "mypy-boto3-pca-connector-ad (>=1.40.0,<1.41.0)", "mypy-boto3-pca-connector-scep (>=1.40.0,<1.41.0)", "mypy-boto3-pcs (>=1.40.0,<1.41.0)", "mypy-boto3-personalize (>=1.40.0,<1.41.0)", "mypy-boto3-personalize-events (>=1.40.0,<1.41.0)", "mypy-boto3-personalize-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-pi (>=1.40.0,<1.41.0)", "mypy-boto3-pinpoint (>=1.40.0,<1.41.0)", "mypy-boto3-pinpoint-email (>=1.40.0,<1.41.0)", "mypy-boto3-pinpoint-sms-voice (>=1.40.0,<1.41.0)", "mypy-boto3-pinpoint-sms-voice-v2 (>=1.40.0,<1.41.0)", "mypy-boto3-pipes (>=1.40.0,<1.41.0)", "mypy-boto3-polly (>=1.40.0,<1.41.0)", "mypy-boto3-pricing (>=1.40.0,<1.41.0)", "mypy-boto3-proton (>=1.40.0,<1.41.0)", "mypy-boto3-qapps (>=1.40.0,<1.41.0)", "mypy-boto3-qbusiness (>=1.40.0,<1.41.0)", "mypy-boto3-qconnect (>=1.40.0,<1.41.0)", "mypy-boto3-qldb (>=1.40.0,<1.41.0)", "mypy-boto3-qldb-session (>=1.40.0,<1.41.0)", "mypy-boto3-quicksight (>=1.40.0,<1.41.0)", "mypy-boto3-ram (>=1.40.0,<1.41.0)", "mypy-boto3-rbin (>=1.40.0,<1.41.0)", "mypy-boto3-rds (>=1.40.0,<1.41.0)", "mypy-boto3-rds-data (>=1.40.0,<1.41.0)", "mypy-boto3-redshift (>=1.40.0,<1.41.0)", "mypy-boto3-redshift-data (>=1.40.0,<1.41.0)", "mypy-boto3-redshift-serverless (>=1.40.0,<1.41.0)", "mypy-boto3-rekognition (>=1.40.0,<1.41.0)", "mypy-boto3-repostspace (>=1.40.0,<1.41.0)", "mypy-boto3-resiliencehub (>=1.40.0,<1.41.0)", "mypy-boto3-resource-explorer-2 (>=1.40.0,<1.41.0)", "mypy-boto3-resource-groups (>=1.40.0,<1.41.0)", "mypy-boto3-resourcegroupstaggingapi (>=1.40.0,<1.41.0)", "mypy-boto3-robomaker (>=1.40.0,<1.41.0)", "mypy-boto3-rolesanywhere (>=1.40.0,<1.41.0)", "mypy-boto3-route53 (>=1.40.0,<1.41.0)", "mypy-boto3-route53-recovery-cluster (>=1.40.0,<1.41.0)", "mypy-boto3-route53-recovery-control-config (>=1.40.0,<1.41.0)", "mypy-boto3-route53-recovery-readiness (>=1.40.0,<1.41.0)", "mypy-boto3-route53domains (>=1.40.0,<1.41.0)", "mypy-boto3-route53profiles (>=1.40.0,<1.41.0)", "mypy-boto3-route53resolver (>=1.40.0,<1.41.0)", "mypy-boto3-rtbfabric (>=1.40.0,<1.41.0)", "mypy-boto3-rum (>=1.40.0,<1.41.0)", "mypy-boto3-s3 (>=1.40.0,<1.41.0)", "mypy-boto3-s3control (>=1.40.0,<1.41.0)", "mypy-boto3-s3outposts (>=1.40.0,<1.41.0)", "mypy-boto3-s3tables (>=1.40.0,<1.41.0)", "mypy-boto3-s3vectors (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker-a2i-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker-edge (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker-featurestore-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker-geospatial (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker-metrics (>=1.40.0,<1.41.0)", "mypy-boto3-sagemaker-runtime (>=1.40.0,<1.41.0)", "mypy-boto3-savingsplans (>=1.40.0,<1.41.0)", "mypy-boto3-scheduler (>=1.40.0,<1.41.0)", "mypy-boto3-schemas (>=1.40.0,<1.41.0)", "mypy-boto3-sdb (>=1.40.0,<1.41.0)", "mypy-boto3-secretsmanager (>=1.40.0,<1.41.0)", "mypy-boto3-security-ir (>=1.40.0,<1.41.0)", "mypy-boto3-securityhub (>=1.40.0,<1.41.0)", "mypy-boto3-securitylake (>=1.40.0,<1.41.0)", "mypy-boto3-serverlessrepo (>=1.40.0,<1.41.0)", "mypy-boto3-service-quotas (>=1.40.0,<1.41.0)", "mypy-boto3-servicecatalog (>=1.40.0,<1.41.0)", "mypy-boto3-servicecatalog-appregistry (>=1.40.0,<1.41.0)", "mypy-boto3-servicediscovery (>=1.40.0,<1.41.0)", "mypy-boto3-ses (>=1.40.0,<1.41.0)", "mypy-boto3-sesv2 (>=1.40.0,<1.41.0)", "mypy-boto3-shield (>=1.40.0,<1.41.0)", "mypy-boto3-signer (>=1.40.0,<1.41.0)", "mypy-boto3-simspaceweaver (>=1.40.0,<1.41.0)", "mypy-boto3-snow-device-management (>=1.40.0,<1.41.0)", "mypy-boto3-snowball (>=1.40.0,<1.41.0)", "mypy-boto3-sns (>=1.40.0,<1.41.0)", "mypy-boto3-socialmessaging (>=1.40.0,<1.41.0)", "mypy-boto3-sqs (>=1.40.0,<1.41.0)", "mypy-boto3-ssm (>=1.40.0,<1.41.0)", "mypy-boto3-ssm-contacts (>=1.40.0,<1.41.0)", "mypy-boto3-ssm-guiconnect (>=1.40.0,<1.41.0)", "mypy-boto3-ssm-incidents (>=1.40.0,<1.41.0)", "mypy-boto3-ssm-quicksetup (>=1.40.0,<1.41.0)", "mypy-boto3-ssm-sap (>=1.40.0,<1.41.0)", "mypy-boto3-sso (>=1.40.0,<1.41.0)", "mypy-boto3-sso-admin (>=1.40.0,<1.41.0)", "mypy-boto3-sso-oidc (>=1.40.0,<1.41.0)", "mypy-boto3-stepfunctions (>=1.40.0,<1.41.0)", "mypy-boto3-storagegateway (>=1.40.0,<1.41.0)", "mypy-boto3-sts (>=1.40.0,<1.41.0)", "mypy-boto3-supplychain (>=1.40.0,<1.41.0)", "mypy-boto3-support (>=1.40.0,<1.41.0)", "mypy-boto3-support-app (>=1.40.0,<1.41.0)", "mypy-boto3-swf (>=1.40.0,<1.41.0)", "mypy-boto3-synthetics (>=1.40.0,<1.41.0)", "mypy-boto3-taxsettings (>=1.40.0,<1.41.0)", "mypy-boto3-textract (>=1.40.0,<1.41.0)", "mypy-boto3-timestream-influxdb (>=1.40.0,<1.41.0)", "mypy-boto3-timestream-query (>=1.40.0,<1.41.0)", "mypy-boto3-timestream-write (>=1.40.0,<1.41.0)", "mypy-boto3-tnb (>=1.40.0,<1.41.0)", "mypy-boto3-transcribe (>=1.40.0,<1.41.0)", "mypy-boto3-transfer (>=1.40.0,<1.41.0)", "mypy-boto3-translate (>=1.40.0,<1.41.0)", "mypy-boto3-trustedadvisor (>=1.40.0,<1.41.0)", "mypy-boto3-verifiedpermissions (>=1.40.0,<1.41.0)", "mypy-boto3-voice-id (>=1.40.0,<1.41.0)", "mypy-boto3-vpc-lattice (>=1.40.0,<1.41.0)", "mypy-boto3-waf (>=1.40.0,<1.41.0)", "mypy-boto3-waf-regional (>=1.40.0,<1.41.0)", "mypy-boto3-wafv2 (>=1.40.0,<1.41.0)", "mypy-boto3-wellarchitected (>=1.40.0,<1.41.0)", "mypy-boto3-wisdom (>=1.40.0,<1.41.0)", "mypy-boto3-workdocs (>=1.40.0,<1.41.0)", "mypy-boto3-workmail (>=1.40.0,<1.41.0)", "mypy-boto3-workmailmessageflow (>=1.40.0,<1.41.0)", "mypy-boto3-workspaces (>=1.40.0,<1.41.0)", "mypy-boto3-workspaces-instances (>=1.40.0,<1.41.0)", "mypy-boto3-workspaces-thin-client (>=1.40.0,<1.41.0)", "mypy-boto3-workspaces-web (>=1.40.0,<1.41.0)", "mypy-boto3-xray (>=1.40.0,<1.41.0)"] amp = ["mypy-boto3-amp (>=1.40.0,<1.41.0)"] amplify = ["mypy-boto3-amplify (>=1.40.0,<1.41.0)"] amplifybackend = ["mypy-boto3-amplifybackend (>=1.40.0,<1.41.0)"] amplifyuibuilder = ["mypy-boto3-amplifyuibuilder (>=1.40.0,<1.41.0)"] apigateway = ["mypy-boto3-apigateway (>=1.40.0,<1.41.0)"] apigatewaymanagementapi = ["mypy-boto3-apigatewaymanagementapi (>=1.40.0,<1.41.0)"] apigatewayv2 = ["mypy-boto3-apigatewayv2 (>=1.40.0,<1.41.0)"] appconfig = ["mypy-boto3-appconfig (>=1.40.0,<1.41.0)"] appconfigdata = ["mypy-boto3-appconfigdata (>=1.40.0,<1.41.0)"] appfabric = ["mypy-boto3-appfabric (>=1.40.0,<1.41.0)"] appflow = ["mypy-boto3-appflow (>=1.40.0,<1.41.0)"] appintegrations = ["mypy-boto3-appintegrations (>=1.40.0,<1.41.0)"] application-autoscaling = ["mypy-boto3-application-autoscaling (>=1.40.0,<1.41.0)"] application-insights = ["mypy-boto3-application-insights (>=1.40.0,<1.41.0)"] application-signals = ["mypy-boto3-application-signals (>=1.40.0,<1.41.0)"] applicationcostprofiler = ["mypy-boto3-applicationcostprofiler (>=1.40.0,<1.41.0)"] appmesh = ["mypy-boto3-appmesh (>=1.40.0,<1.41.0)"] apprunner = ["mypy-boto3-apprunner (>=1.40.0,<1.41.0)"] appstream = ["mypy-boto3-appstream (>=1.40.0,<1.41.0)"] appsync = ["mypy-boto3-appsync (>=1.40.0,<1.41.0)"] apptest = ["mypy-boto3-apptest (>=1.40.0,<1.41.0)"] arc-region-switch = ["mypy-boto3-arc-region-switch (>=1.40.0,<1.41.0)"] arc-zonal-shift = ["mypy-boto3-arc-zonal-shift (>=1.40.0,<1.41.0)"] artifact = ["mypy-boto3-artifact (>=1.40.0,<1.41.0)"] athena = ["mypy-boto3-athena (>=1.40.0,<1.41.0)"] auditmanager = ["mypy-boto3-auditmanager (>=1.40.0,<1.41.0)"] autoscaling = ["mypy-boto3-autoscaling (>=1.40.0,<1.41.0)"] autoscaling-plans = ["mypy-boto3-autoscaling-plans (>=1.40.0,<1.41.0)"] b2bi = ["mypy-boto3-b2bi (>=1.40.0,<1.41.0)"] backup = ["mypy-boto3-backup (>=1.40.0,<1.41.0)"] backup-gateway = ["mypy-boto3-backup-gateway (>=1.40.0,<1.41.0)"] backupsearch = ["mypy-boto3-backupsearch (>=1.40.0,<1.41.0)"] batch = ["mypy-boto3-batch (>=1.40.0,<1.41.0)"] bcm-dashboards = ["mypy-boto3-bcm-dashboards (>=1.40.0,<1.41.0)"] bcm-data-exports = ["mypy-boto3-bcm-data-exports (>=1.40.0,<1.41.0)"] bcm-pricing-calculator = ["mypy-boto3-bcm-pricing-calculator (>=1.40.0,<1.41.0)"] bcm-recommended-actions = ["mypy-boto3-bcm-recommended-actions (>=1.40.0,<1.41.0)"] bedrock = ["mypy-boto3-bedrock (>=1.40.0,<1.41.0)"] bedrock-agent = ["mypy-boto3-bedrock-agent (>=1.40.0,<1.41.0)"] bedrock-agent-runtime = ["mypy-boto3-bedrock-agent-runtime (>=1.40.0,<1.41.0)"] bedrock-agentcore = ["mypy-boto3-bedrock-agentcore (>=1.40.0,<1.41.0)"] bedrock-agentcore-control = ["mypy-boto3-bedrock-agentcore-control (>=1.40.0,<1.41.0)"] bedrock-data-automation = ["mypy-boto3-bedrock-data-automation (>=1.40.0,<1.41.0)"] bedrock-data-automation-runtime = ["mypy-boto3-bedrock-data-automation-runtime (>=1.40.0,<1.41.0)"] bedrock-runtime = ["mypy-boto3-bedrock-runtime (>=1.40.0,<1.41.0)"] billing = ["mypy-boto3-billing (>=1.40.0,<1.41.0)"] billingconductor = ["mypy-boto3-billingconductor (>=1.40.0,<1.41.0)"] boto3 = ["boto3 (==1.40.59)"] braket = ["mypy-boto3-braket (>=1.40.0,<1.41.0)"] budgets = ["mypy-boto3-budgets (>=1.40.0,<1.41.0)"] ce = ["mypy-boto3-ce (>=1.40.0,<1.41.0)"] chatbot = ["mypy-boto3-chatbot (>=1.40.0,<1.41.0)"] chime = ["mypy-boto3-chime (>=1.40.0,<1.41.0)"] chime-sdk-identity = ["mypy-boto3-chime-sdk-identity (>=1.40.0,<1.41.0)"] chime-sdk-media-pipelines = ["mypy-boto3-chime-sdk-media-pipelines (>=1.40.0,<1.41.0)"] chime-sdk-meetings = ["mypy-boto3-chime-sdk-meetings (>=1.40.0,<1.41.0)"] chime-sdk-messaging = ["mypy-boto3-chime-sdk-messaging (>=1.40.0,<1.41.0)"] chime-sdk-voice = ["mypy-boto3-chime-sdk-voice (>=1.40.0,<1.41.0)"] cleanrooms = ["mypy-boto3-cleanrooms (>=1.40.0,<1.41.0)"] cleanroomsml = ["mypy-boto3-cleanroomsml (>=1.40.0,<1.41.0)"] cloud9 = ["mypy-boto3-cloud9 (>=1.40.0,<1.41.0)"] cloudcontrol = ["mypy-boto3-cloudcontrol (>=1.40.0,<1.41.0)"] clouddirectory = ["mypy-boto3-clouddirectory (>=1.40.0,<1.41.0)"] cloudformation = ["mypy-boto3-cloudformation (>=1.40.0,<1.41.0)"] cloudfront = ["mypy-boto3-cloudfront (>=1.40.0,<1.41.0)"] cloudfront-keyvaluestore = ["mypy-boto3-cloudfront-keyvaluestore (>=1.40.0,<1.41.0)"] cloudhsm = ["mypy-boto3-cloudhsm (>=1.40.0,<1.41.0)"] cloudhsmv2 = ["mypy-boto3-cloudhsmv2 (>=1.40.0,<1.41.0)"] cloudsearch = ["mypy-boto3-cloudsearch (>=1.40.0,<1.41.0)"] cloudsearchdomain = ["mypy-boto3-cloudsearchdomain (>=1.40.0,<1.41.0)"] cloudtrail = ["mypy-boto3-cloudtrail (>=1.40.0,<1.41.0)"] cloudtrail-data = ["mypy-boto3-cloudtrail-data (>=1.40.0,<1.41.0)"] cloudwatch = ["mypy-boto3-cloudwatch (>=1.40.0,<1.41.0)"] codeartifact = ["mypy-boto3-codeartifact (>=1.40.0,<1.41.0)"] codebuild = ["mypy-boto3-codebuild (>=1.40.0,<1.41.0)"] codecatalyst = ["mypy-boto3-codecatalyst (>=1.40.0,<1.41.0)"] codecommit = ["mypy-boto3-codecommit (>=1.40.0,<1.41.0)"] codeconnections = ["mypy-boto3-codeconnections (>=1.40.0,<1.41.0)"] codedeploy = ["mypy-boto3-codedeploy (>=1.40.0,<1.41.0)"] codeguru-reviewer = ["mypy-boto3-codeguru-reviewer (>=1.40.0,<1.41.0)"] codeguru-security = ["mypy-boto3-codeguru-security (>=1.40.0,<1.41.0)"] codeguruprofiler = ["mypy-boto3-codeguruprofiler (>=1.40.0,<1.41.0)"] codepipeline = ["mypy-boto3-codepipeline (>=1.40.0,<1.41.0)"] codestar-connections = ["mypy-boto3-codestar-connections (>=1.40.0,<1.41.0)"] codestar-notifications = ["mypy-boto3-codestar-notifications (>=1.40.0,<1.41.0)"] cognito-identity = ["mypy-boto3-cognito-identity (>=1.40.0,<1.41.0)"] cognito-idp = ["mypy-boto3-cognito-idp (>=1.40.0,<1.41.0)"] cognito-sync = ["mypy-boto3-cognito-sync (>=1.40.0,<1.41.0)"] comprehend = ["mypy-boto3-comprehend (>=1.40.0,<1.41.0)"] comprehendmedical = ["mypy-boto3-comprehendmedical (>=1.40.0,<1.41.0)"] compute-optimizer = ["mypy-boto3-compute-optimizer (>=1.40.0,<1.41.0)"] config = ["mypy-boto3-config (>=1.40.0,<1.41.0)"] connect = ["mypy-boto3-connect (>=1.40.0,<1.41.0)"] connect-contact-lens = ["mypy-boto3-connect-contact-lens (>=1.40.0,<1.41.0)"] connectcampaigns = ["mypy-boto3-connectcampaigns (>=1.40.0,<1.41.0)"] connectcampaignsv2 = ["mypy-boto3-connectcampaignsv2 (>=1.40.0,<1.41.0)"] connectcases = ["mypy-boto3-connectcases (>=1.40.0,<1.41.0)"] connectparticipant = ["mypy-boto3-connectparticipant (>=1.40.0,<1.41.0)"] controlcatalog = ["mypy-boto3-controlcatalog (>=1.40.0,<1.41.0)"] controltower = ["mypy-boto3-controltower (>=1.40.0,<1.41.0)"] cost-optimization-hub = ["mypy-boto3-cost-optimization-hub (>=1.40.0,<1.41.0)"] cur = ["mypy-boto3-cur (>=1.40.0,<1.41.0)"] customer-profiles = ["mypy-boto3-customer-profiles (>=1.40.0,<1.41.0)"] databrew = ["mypy-boto3-databrew (>=1.40.0,<1.41.0)"] dataexchange = ["mypy-boto3-dataexchange (>=1.40.0,<1.41.0)"] datapipeline = ["mypy-boto3-datapipeline (>=1.40.0,<1.41.0)"] datasync = ["mypy-boto3-datasync (>=1.40.0,<1.41.0)"] datazone = ["mypy-boto3-datazone (>=1.40.0,<1.41.0)"] dax = ["mypy-boto3-dax (>=1.40.0,<1.41.0)"] deadline = ["mypy-boto3-deadline (>=1.40.0,<1.41.0)"] detective = ["mypy-boto3-detective (>=1.40.0,<1.41.0)"] devicefarm = ["mypy-boto3-devicefarm (>=1.40.0,<1.41.0)"] devops-guru = ["mypy-boto3-devops-guru (>=1.40.0,<1.41.0)"] directconnect = ["mypy-boto3-directconnect (>=1.40.0,<1.41.0)"] discovery = ["mypy-boto3-discovery (>=1.40.0,<1.41.0)"] dlm = ["mypy-boto3-dlm (>=1.40.0,<1.41.0)"] dms = ["mypy-boto3-dms (>=1.40.0,<1.41.0)"] docdb = ["mypy-boto3-docdb (>=1.40.0,<1.41.0)"] docdb-elastic = ["mypy-boto3-docdb-elastic (>=1.40.0,<1.41.0)"] drs = ["mypy-boto3-drs (>=1.40.0,<1.41.0)"] ds = ["mypy-boto3-ds (>=1.40.0,<1.41.0)"] ds-data = ["mypy-boto3-ds-data (>=1.40.0,<1.41.0)"] dsql = ["mypy-boto3-dsql (>=1.40.0,<1.41.0)"] dynamodb = ["mypy-boto3-dynamodb (>=1.40.0,<1.41.0)"] dynamodbstreams = ["mypy-boto3-dynamodbstreams (>=1.40.0,<1.41.0)"] ebs = ["mypy-boto3-ebs (>=1.40.0,<1.41.0)"] ec2 = ["mypy-boto3-ec2 (>=1.40.0,<1.41.0)"] ec2-instance-connect = ["mypy-boto3-ec2-instance-connect (>=1.40.0,<1.41.0)"] ecr = ["mypy-boto3-ecr (>=1.40.0,<1.41.0)"] ecr-public = ["mypy-boto3-ecr-public (>=1.40.0,<1.41.0)"] ecs = ["mypy-boto3-ecs (>=1.40.0,<1.41.0)"] efs = ["mypy-boto3-efs (>=1.40.0,<1.41.0)"] eks = ["mypy-boto3-eks (>=1.40.0,<1.41.0)"] eks-auth = ["mypy-boto3-eks-auth (>=1.40.0,<1.41.0)"] elasticache = ["mypy-boto3-elasticache (>=1.40.0,<1.41.0)"] elasticbeanstalk = ["mypy-boto3-elasticbeanstalk (>=1.40.0,<1.41.0)"] elastictranscoder = ["mypy-boto3-elastictranscoder (>=1.40.0,<1.41.0)"] elb = ["mypy-boto3-elb (>=1.40.0,<1.41.0)"] elbv2 = ["mypy-boto3-elbv2 (>=1.40.0,<1.41.0)"] emr = ["mypy-boto3-emr (>=1.40.0,<1.41.0)"] emr-containers = ["mypy-boto3-emr-containers (>=1.40.0,<1.41.0)"] emr-serverless = ["mypy-boto3-emr-serverless (>=1.40.0,<1.41.0)"] entityresolution = ["mypy-boto3-entityresolution (>=1.40.0,<1.41.0)"] es = ["mypy-boto3-es (>=1.40.0,<1.41.0)"] essential = ["mypy-boto3-cloudformation (>=1.40.0,<1.41.0)", "mypy-boto3-dynamodb (>=1.40.0,<1.41.0)", "mypy-boto3-ec2 (>=1.40.0,<1.41.0)", "mypy-boto3-lambda (>=1.40.0,<1.41.0)", "mypy-boto3-rds (>=1.40.0,<1.41.0)", "mypy-boto3-s3 (>=1.40.0,<1.41.0)", "mypy-boto3-sqs (>=1.40.0,<1.41.0)"] events = ["mypy-boto3-events (>=1.40.0,<1.41.0)"] evidently = ["mypy-boto3-evidently (>=1.40.0,<1.41.0)"] evs = ["mypy-boto3-evs (>=1.40.0,<1.41.0)"] finspace = ["mypy-boto3-finspace (>=1.40.0,<1.41.0)"] finspace-data = ["mypy-boto3-finspace-data (>=1.40.0,<1.41.0)"] firehose = ["mypy-boto3-firehose (>=1.40.0,<1.41.0)"] fis = ["mypy-boto3-fis (>=1.40.0,<1.41.0)"] fms = ["mypy-boto3-fms (>=1.40.0,<1.41.0)"] forecast = ["mypy-boto3-forecast (>=1.40.0,<1.41.0)"] forecastquery = ["mypy-boto3-forecastquery (>=1.40.0,<1.41.0)"] frauddetector = ["mypy-boto3-frauddetector (>=1.40.0,<1.41.0)"] freetier = ["mypy-boto3-freetier (>=1.40.0,<1.41.0)"] fsx = ["mypy-boto3-fsx (>=1.40.0,<1.41.0)"] full = ["boto3-stubs-full (>=1.40.0,<1.41.0)"] gamelift = ["mypy-boto3-gamelift (>=1.40.0,<1.41.0)"] gameliftstreams = ["mypy-boto3-gameliftstreams (>=1.40.0,<1.41.0)"] geo-maps = ["mypy-boto3-geo-maps (>=1.40.0,<1.41.0)"] geo-places = ["mypy-boto3-geo-places (>=1.40.0,<1.41.0)"] geo-routes = ["mypy-boto3-geo-routes (>=1.40.0,<1.41.0)"] glacier = ["mypy-boto3-glacier (>=1.40.0,<1.41.0)"] globalaccelerator = ["mypy-boto3-globalaccelerator (>=1.40.0,<1.41.0)"] glue = ["mypy-boto3-glue (>=1.40.0,<1.41.0)"] grafana = ["mypy-boto3-grafana (>=1.40.0,<1.41.0)"] greengrass = ["mypy-boto3-greengrass (>=1.40.0,<1.41.0)"] greengrassv2 = ["mypy-boto3-greengrassv2 (>=1.40.0,<1.41.0)"] groundstation = ["mypy-boto3-groundstation (>=1.40.0,<1.41.0)"] guardduty = ["mypy-boto3-guardduty (>=1.40.0,<1.41.0)"] health = ["mypy-boto3-health (>=1.40.0,<1.41.0)"] healthlake = ["mypy-boto3-healthlake (>=1.40.0,<1.41.0)"] iam = ["mypy-boto3-iam (>=1.40.0,<1.41.0)"] identitystore = ["mypy-boto3-identitystore (>=1.40.0,<1.41.0)"] imagebuilder = ["mypy-boto3-imagebuilder (>=1.40.0,<1.41.0)"] importexport = ["mypy-boto3-importexport (>=1.40.0,<1.41.0)"] inspector = ["mypy-boto3-inspector (>=1.40.0,<1.41.0)"] inspector-scan = ["mypy-boto3-inspector-scan (>=1.40.0,<1.41.0)"] inspector2 = ["mypy-boto3-inspector2 (>=1.40.0,<1.41.0)"] internetmonitor = ["mypy-boto3-internetmonitor (>=1.40.0,<1.41.0)"] invoicing = ["mypy-boto3-invoicing (>=1.40.0,<1.41.0)"] iot = ["mypy-boto3-iot (>=1.40.0,<1.41.0)"] iot-data = ["mypy-boto3-iot-data (>=1.40.0,<1.41.0)"] iot-jobs-data = ["mypy-boto3-iot-jobs-data (>=1.40.0,<1.41.0)"] iot-managed-integrations = ["mypy-boto3-iot-managed-integrations (>=1.40.0,<1.41.0)"] iotanalytics = ["mypy-boto3-iotanalytics (>=1.40.0,<1.41.0)"] iotdeviceadvisor = ["mypy-boto3-iotdeviceadvisor (>=1.40.0,<1.41.0)"] iotevents = ["mypy-boto3-iotevents (>=1.40.0,<1.41.0)"] iotevents-data = ["mypy-boto3-iotevents-data (>=1.40.0,<1.41.0)"] iotfleethub = ["mypy-boto3-iotfleethub (>=1.40.0,<1.41.0)"] iotfleetwise = ["mypy-boto3-iotfleetwise (>=1.40.0,<1.41.0)"] iotsecuretunneling = ["mypy-boto3-iotsecuretunneling (>=1.40.0,<1.41.0)"] iotsitewise = ["mypy-boto3-iotsitewise (>=1.40.0,<1.41.0)"] iotthingsgraph = ["mypy-boto3-iotthingsgraph (>=1.40.0,<1.41.0)"] iottwinmaker = ["mypy-boto3-iottwinmaker (>=1.40.0,<1.41.0)"] iotwireless = ["mypy-boto3-iotwireless (>=1.40.0,<1.41.0)"] ivs = ["mypy-boto3-ivs (>=1.40.0,<1.41.0)"] ivs-realtime = ["mypy-boto3-ivs-realtime (>=1.40.0,<1.41.0)"] ivschat = ["mypy-boto3-ivschat (>=1.40.0,<1.41.0)"] kafka = ["mypy-boto3-kafka (>=1.40.0,<1.41.0)"] kafkaconnect = ["mypy-boto3-kafkaconnect (>=1.40.0,<1.41.0)"] kendra = ["mypy-boto3-kendra (>=1.40.0,<1.41.0)"] kendra-ranking = ["mypy-boto3-kendra-ranking (>=1.40.0,<1.41.0)"] keyspaces = ["mypy-boto3-keyspaces (>=1.40.0,<1.41.0)"] keyspacesstreams = ["mypy-boto3-keyspacesstreams (>=1.40.0,<1.41.0)"] kinesis = ["mypy-boto3-kinesis (>=1.40.0,<1.41.0)"] kinesis-video-archived-media = ["mypy-boto3-kinesis-video-archived-media (>=1.40.0,<1.41.0)"] kinesis-video-media = ["mypy-boto3-kinesis-video-media (>=1.40.0,<1.41.0)"] kinesis-video-signaling = ["mypy-boto3-kinesis-video-signaling (>=1.40.0,<1.41.0)"] kinesis-video-webrtc-storage = ["mypy-boto3-kinesis-video-webrtc-storage (>=1.40.0,<1.41.0)"] kinesisanalytics = ["mypy-boto3-kinesisanalytics (>=1.40.0,<1.41.0)"] kinesisanalyticsv2 = ["mypy-boto3-kinesisanalyticsv2 (>=1.40.0,<1.41.0)"] kinesisvideo = ["mypy-boto3-kinesisvideo (>=1.40.0,<1.41.0)"] kms = ["mypy-boto3-kms (>=1.40.0,<1.41.0)"] lakeformation = ["mypy-boto3-lakeformation (>=1.40.0,<1.41.0)"] lambda = ["mypy-boto3-lambda (>=1.40.0,<1.41.0)"] launch-wizard = ["mypy-boto3-launch-wizard (>=1.40.0,<1.41.0)"] lex-models = ["mypy-boto3-lex-models (>=1.40.0,<1.41.0)"] lex-runtime = ["mypy-boto3-lex-runtime (>=1.40.0,<1.41.0)"] lexv2-models = ["mypy-boto3-lexv2-models (>=1.40.0,<1.41.0)"] lexv2-runtime = ["mypy-boto3-lexv2-runtime (>=1.40.0,<1.41.0)"] license-manager = ["mypy-boto3-license-manager (>=1.40.0,<1.41.0)"] license-manager-linux-subscriptions = ["mypy-boto3-license-manager-linux-subscriptions (>=1.40.0,<1.41.0)"] license-manager-user-subscriptions = ["mypy-boto3-license-manager-user-subscriptions (>=1.40.0,<1.41.0)"] lightsail = ["mypy-boto3-lightsail (>=1.40.0,<1.41.0)"] location = ["mypy-boto3-location (>=1.40.0,<1.41.0)"] logs = ["mypy-boto3-logs (>=1.40.0,<1.41.0)"] lookoutequipment = ["mypy-boto3-lookoutequipment (>=1.40.0,<1.41.0)"] lookoutmetrics = ["mypy-boto3-lookoutmetrics (>=1.40.0,<1.41.0)"] lookoutvision = ["mypy-boto3-lookoutvision (>=1.40.0,<1.41.0)"] m2 = ["mypy-boto3-m2 (>=1.40.0,<1.41.0)"] machinelearning = ["mypy-boto3-machinelearning (>=1.40.0,<1.41.0)"] macie2 = ["mypy-boto3-macie2 (>=1.40.0,<1.41.0)"] mailmanager = ["mypy-boto3-mailmanager (>=1.40.0,<1.41.0)"] managedblockchain = ["mypy-boto3-managedblockchain (>=1.40.0,<1.41.0)"] managedblockchain-query = ["mypy-boto3-managedblockchain-query (>=1.40.0,<1.41.0)"] marketplace-agreement = ["mypy-boto3-marketplace-agreement (>=1.40.0,<1.41.0)"] marketplace-catalog = ["mypy-boto3-marketplace-catalog (>=1.40.0,<1.41.0)"] marketplace-deployment = ["mypy-boto3-marketplace-deployment (>=1.40.0,<1.41.0)"] marketplace-entitlement = ["mypy-boto3-marketplace-entitlement (>=1.40.0,<1.41.0)"] marketplace-reporting = ["mypy-boto3-marketplace-reporting (>=1.40.0,<1.41.0)"] marketplacecommerceanalytics = ["mypy-boto3-marketplacecommerceanalytics (>=1.40.0,<1.41.0)"] mediaconnect = ["mypy-boto3-mediaconnect (>=1.40.0,<1.41.0)"] mediaconvert = ["mypy-boto3-mediaconvert (>=1.40.0,<1.41.0)"] medialive = ["mypy-boto3-medialive (>=1.40.0,<1.41.0)"] mediapackage = ["mypy-boto3-mediapackage (>=1.40.0,<1.41.0)"] mediapackage-vod = ["mypy-boto3-mediapackage-vod (>=1.40.0,<1.41.0)"] mediapackagev2 = ["mypy-boto3-mediapackagev2 (>=1.40.0,<1.41.0)"] mediastore = ["mypy-boto3-mediastore (>=1.40.0,<1.41.0)"] mediastore-data = ["mypy-boto3-mediastore-data (>=1.40.0,<1.41.0)"] mediatailor = ["mypy-boto3-mediatailor (>=1.40.0,<1.41.0)"] medical-imaging = ["mypy-boto3-medical-imaging (>=1.40.0,<1.41.0)"] memorydb = ["mypy-boto3-memorydb (>=1.40.0,<1.41.0)"] meteringmarketplace = ["mypy-boto3-meteringmarketplace (>=1.40.0,<1.41.0)"] mgh = ["mypy-boto3-mgh (>=1.40.0,<1.41.0)"] mgn = ["mypy-boto3-mgn (>=1.40.0,<1.41.0)"] migration-hub-refactor-spaces = ["mypy-boto3-migration-hub-refactor-spaces (>=1.40.0,<1.41.0)"] migrationhub-config = ["mypy-boto3-migrationhub-config (>=1.40.0,<1.41.0)"] migrationhuborchestrator = ["mypy-boto3-migrationhuborchestrator (>=1.40.0,<1.41.0)"] migrationhubstrategy = ["mypy-boto3-migrationhubstrategy (>=1.40.0,<1.41.0)"] mpa = ["mypy-boto3-mpa (>=1.40.0,<1.41.0)"] mq = ["mypy-boto3-mq (>=1.40.0,<1.41.0)"] mturk = ["mypy-boto3-mturk (>=1.40.0,<1.41.0)"] mwaa = ["mypy-boto3-mwaa (>=1.40.0,<1.41.0)"] neptune = ["mypy-boto3-neptune (>=1.40.0,<1.41.0)"] neptune-graph = ["mypy-boto3-neptune-graph (>=1.40.0,<1.41.0)"] neptunedata = ["mypy-boto3-neptunedata (>=1.40.0,<1.41.0)"] network-firewall = ["mypy-boto3-network-firewall (>=1.40.0,<1.41.0)"] networkflowmonitor = ["mypy-boto3-networkflowmonitor (>=1.40.0,<1.41.0)"] networkmanager = ["mypy-boto3-networkmanager (>=1.40.0,<1.41.0)"] networkmonitor = ["mypy-boto3-networkmonitor (>=1.40.0,<1.41.0)"] notifications = ["mypy-boto3-notifications (>=1.40.0,<1.41.0)"] notificationscontacts = ["mypy-boto3-notificationscontacts (>=1.40.0,<1.41.0)"] oam = ["mypy-boto3-oam (>=1.40.0,<1.41.0)"] observabilityadmin = ["mypy-boto3-observabilityadmin (>=1.40.0,<1.41.0)"] odb = ["mypy-boto3-odb (>=1.40.0,<1.41.0)"] omics = ["mypy-boto3-omics (>=1.40.0,<1.41.0)"] opensearch = ["mypy-boto3-opensearch (>=1.40.0,<1.41.0)"] opensearchserverless = ["mypy-boto3-opensearchserverless (>=1.40.0,<1.41.0)"] organizations = ["mypy-boto3-organizations (>=1.40.0,<1.41.0)"] osis = ["mypy-boto3-osis (>=1.40.0,<1.41.0)"] outposts = ["mypy-boto3-outposts (>=1.40.0,<1.41.0)"] panorama = ["mypy-boto3-panorama (>=1.40.0,<1.41.0)"] partnercentral-selling = ["mypy-boto3-partnercentral-selling (>=1.40.0,<1.41.0)"] payment-cryptography = ["mypy-boto3-payment-cryptography (>=1.40.0,<1.41.0)"] payment-cryptography-data = ["mypy-boto3-payment-cryptography-data (>=1.40.0,<1.41.0)"] pca-connector-ad = ["mypy-boto3-pca-connector-ad (>=1.40.0,<1.41.0)"] pca-connector-scep = ["mypy-boto3-pca-connector-scep (>=1.40.0,<1.41.0)"] pcs = ["mypy-boto3-pcs (>=1.40.0,<1.41.0)"] personalize = ["mypy-boto3-personalize (>=1.40.0,<1.41.0)"] personalize-events = ["mypy-boto3-personalize-events (>=1.40.0,<1.41.0)"] personalize-runtime = ["mypy-boto3-personalize-runtime (>=1.40.0,<1.41.0)"] pi = ["mypy-boto3-pi (>=1.40.0,<1.41.0)"] pinpoint = ["mypy-boto3-pinpoint (>=1.40.0,<1.41.0)"] pinpoint-email = ["mypy-boto3-pinpoint-email (>=1.40.0,<1.41.0)"] pinpoint-sms-voice = ["mypy-boto3-pinpoint-sms-voice (>=1.40.0,<1.41.0)"] pinpoint-sms-voice-v2 = ["mypy-boto3-pinpoint-sms-voice-v2 (>=1.40.0,<1.41.0)"] pipes = ["mypy-boto3-pipes (>=1.40.0,<1.41.0)"] polly = ["mypy-boto3-polly (>=1.40.0,<1.41.0)"] pricing = ["mypy-boto3-pricing (>=1.40.0,<1.41.0)"] proton = ["mypy-boto3-proton (>=1.40.0,<1.41.0)"] qapps = ["mypy-boto3-qapps (>=1.40.0,<1.41.0)"] qbusiness = ["mypy-boto3-qbusiness (>=1.40.0,<1.41.0)"] qconnect = ["mypy-boto3-qconnect (>=1.40.0,<1.41.0)"] qldb = ["mypy-boto3-qldb (>=1.40.0,<1.41.0)"] qldb-session = ["mypy-boto3-qldb-session (>=1.40.0,<1.41.0)"] quicksight = ["mypy-boto3-quicksight (>=1.40.0,<1.41.0)"] ram = ["mypy-boto3-ram (>=1.40.0,<1.41.0)"] rbin = ["mypy-boto3-rbin (>=1.40.0,<1.41.0)"] rds = ["mypy-boto3-rds (>=1.40.0,<1.41.0)"] rds-data = ["mypy-boto3-rds-data (>=1.40.0,<1.41.0)"] redshift = ["mypy-boto3-redshift (>=1.40.0,<1.41.0)"] redshift-data = ["mypy-boto3-redshift-data (>=1.40.0,<1.41.0)"] redshift-serverless = ["mypy-boto3-redshift-serverless (>=1.40.0,<1.41.0)"] rekognition = ["mypy-boto3-rekognition (>=1.40.0,<1.41.0)"] repostspace = ["mypy-boto3-repostspace (>=1.40.0,<1.41.0)"] resiliencehub = ["mypy-boto3-resiliencehub (>=1.40.0,<1.41.0)"] resource-explorer-2 = ["mypy-boto3-resource-explorer-2 (>=1.40.0,<1.41.0)"] resource-groups = ["mypy-boto3-resource-groups (>=1.40.0,<1.41.0)"] resourcegroupstaggingapi = ["mypy-boto3-resourcegroupstaggingapi (>=1.40.0,<1.41.0)"] robomaker = ["mypy-boto3-robomaker (>=1.40.0,<1.41.0)"] rolesanywhere = ["mypy-boto3-rolesanywhere (>=1.40.0,<1.41.0)"] route53 = ["mypy-boto3-route53 (>=1.40.0,<1.41.0)"] route53-recovery-cluster = ["mypy-boto3-route53-recovery-cluster (>=1.40.0,<1.41.0)"] route53-recovery-control-config = ["mypy-boto3-route53-recovery-control-config (>=1.40.0,<1.41.0)"] route53-recovery-readiness = ["mypy-boto3-route53-recovery-readiness (>=1.40.0,<1.41.0)"] route53domains = ["mypy-boto3-route53domains (>=1.40.0,<1.41.0)"] route53profiles = ["mypy-boto3-route53profiles (>=1.40.0,<1.41.0)"] route53resolver = ["mypy-boto3-route53resolver (>=1.40.0,<1.41.0)"] rtbfabric = ["mypy-boto3-rtbfabric (>=1.40.0,<1.41.0)"] rum = ["mypy-boto3-rum (>=1.40.0,<1.41.0)"] s3 = ["mypy-boto3-s3 (>=1.40.0,<1.41.0)"] s3control = ["mypy-boto3-s3control (>=1.40.0,<1.41.0)"] s3outposts = ["mypy-boto3-s3outposts (>=1.40.0,<1.41.0)"] s3tables = ["mypy-boto3-s3tables (>=1.40.0,<1.41.0)"] s3vectors = ["mypy-boto3-s3vectors (>=1.40.0,<1.41.0)"] sagemaker = ["mypy-boto3-sagemaker (>=1.40.0,<1.41.0)"] sagemaker-a2i-runtime = ["mypy-boto3-sagemaker-a2i-runtime (>=1.40.0,<1.41.0)"] sagemaker-edge = ["mypy-boto3-sagemaker-edge (>=1.40.0,<1.41.0)"] sagemaker-featurestore-runtime = ["mypy-boto3-sagemaker-featurestore-runtime (>=1.40.0,<1.41.0)"] sagemaker-geospatial = ["mypy-boto3-sagemaker-geospatial (>=1.40.0,<1.41.0)"] sagemaker-metrics = ["mypy-boto3-sagemaker-metrics (>=1.40.0,<1.41.0)"] sagemaker-runtime = ["mypy-boto3-sagemaker-runtime (>=1.40.0,<1.41.0)"] savingsplans = ["mypy-boto3-savingsplans (>=1.40.0,<1.41.0)"] scheduler = ["mypy-boto3-scheduler (>=1.40.0,<1.41.0)"] schemas = ["mypy-boto3-schemas (>=1.40.0,<1.41.0)"] sdb = ["mypy-boto3-sdb (>=1.40.0,<1.41.0)"] secretsmanager = ["mypy-boto3-secretsmanager (>=1.40.0,<1.41.0)"] security-ir = ["mypy-boto3-security-ir (>=1.40.0,<1.41.0)"] securityhub = ["mypy-boto3-securityhub (>=1.40.0,<1.41.0)"] securitylake = ["mypy-boto3-securitylake (>=1.40.0,<1.41.0)"] serverlessrepo = ["mypy-boto3-serverlessrepo (>=1.40.0,<1.41.0)"] service-quotas = ["mypy-boto3-service-quotas (>=1.40.0,<1.41.0)"] servicecatalog = ["mypy-boto3-servicecatalog (>=1.40.0,<1.41.0)"] servicecatalog-appregistry = ["mypy-boto3-servicecatalog-appregistry (>=1.40.0,<1.41.0)"] servicediscovery = ["mypy-boto3-servicediscovery (>=1.40.0,<1.41.0)"] ses = ["mypy-boto3-ses (>=1.40.0,<1.41.0)"] sesv2 = ["mypy-boto3-sesv2 (>=1.40.0,<1.41.0)"] shield = ["mypy-boto3-shield (>=1.40.0,<1.41.0)"] signer = ["mypy-boto3-signer (>=1.40.0,<1.41.0)"] simspaceweaver = ["mypy-boto3-simspaceweaver (>=1.40.0,<1.41.0)"] snow-device-management = ["mypy-boto3-snow-device-management (>=1.40.0,<1.41.0)"] snowball = ["mypy-boto3-snowball (>=1.40.0,<1.41.0)"] sns = ["mypy-boto3-sns (>=1.40.0,<1.41.0)"] socialmessaging = ["mypy-boto3-socialmessaging (>=1.40.0,<1.41.0)"] sqs = ["mypy-boto3-sqs (>=1.40.0,<1.41.0)"] ssm = ["mypy-boto3-ssm (>=1.40.0,<1.41.0)"] ssm-contacts = ["mypy-boto3-ssm-contacts (>=1.40.0,<1.41.0)"] ssm-guiconnect = ["mypy-boto3-ssm-guiconnect (>=1.40.0,<1.41.0)"] ssm-incidents = ["mypy-boto3-ssm-incidents (>=1.40.0,<1.41.0)"] ssm-quicksetup = ["mypy-boto3-ssm-quicksetup (>=1.40.0,<1.41.0)"] ssm-sap = ["mypy-boto3-ssm-sap (>=1.40.0,<1.41.0)"] sso = ["mypy-boto3-sso (>=1.40.0,<1.41.0)"] sso-admin = ["mypy-boto3-sso-admin (>=1.40.0,<1.41.0)"] sso-oidc = ["mypy-boto3-sso-oidc (>=1.40.0,<1.41.0)"] stepfunctions = ["mypy-boto3-stepfunctions (>=1.40.0,<1.41.0)"] storagegateway = ["mypy-boto3-storagegateway (>=1.40.0,<1.41.0)"] sts = ["mypy-boto3-sts (>=1.40.0,<1.41.0)"] supplychain = ["mypy-boto3-supplychain (>=1.40.0,<1.41.0)"] support = ["mypy-boto3-support (>=1.40.0,<1.41.0)"] support-app = ["mypy-boto3-support-app (>=1.40.0,<1.41.0)"] swf = ["mypy-boto3-swf (>=1.40.0,<1.41.0)"] synthetics = ["mypy-boto3-synthetics (>=1.40.0,<1.41.0)"] taxsettings = ["mypy-boto3-taxsettings (>=1.40.0,<1.41.0)"] textract = ["mypy-boto3-textract (>=1.40.0,<1.41.0)"] timestream-influxdb = ["mypy-boto3-timestream-influxdb (>=1.40.0,<1.41.0)"] timestream-query = ["mypy-boto3-timestream-query (>=1.40.0,<1.41.0)"] timestream-write = ["mypy-boto3-timestream-write (>=1.40.0,<1.41.0)"] tnb = ["mypy-boto3-tnb (>=1.40.0,<1.41.0)"] transcribe = ["mypy-boto3-transcribe (>=1.40.0,<1.41.0)"] transfer = ["mypy-boto3-transfer (>=1.40.0,<1.41.0)"] translate = ["mypy-boto3-translate (>=1.40.0,<1.41.0)"] trustedadvisor = ["mypy-boto3-trustedadvisor (>=1.40.0,<1.41.0)"] verifiedpermissions = ["mypy-boto3-verifiedpermissions (>=1.40.0,<1.41.0)"] voice-id = ["mypy-boto3-voice-id (>=1.40.0,<1.41.0)"] vpc-lattice = ["mypy-boto3-vpc-lattice (>=1.40.0,<1.41.0)"] waf = ["mypy-boto3-waf (>=1.40.0,<1.41.0)"] waf-regional = ["mypy-boto3-waf-regional (>=1.40.0,<1.41.0)"] wafv2 = ["mypy-boto3-wafv2 (>=1.40.0,<1.41.0)"] wellarchitected = ["mypy-boto3-wellarchitected (>=1.40.0,<1.41.0)"] wisdom = ["mypy-boto3-wisdom (>=1.40.0,<1.41.0)"] workdocs = ["mypy-boto3-workdocs (>=1.40.0,<1.41.0)"] workmail = ["mypy-boto3-workmail (>=1.40.0,<1.41.0)"] workmailmessageflow = ["mypy-boto3-workmailmessageflow (>=1.40.0,<1.41.0)"] workspaces = ["mypy-boto3-workspaces (>=1.40.0,<1.41.0)"] workspaces-instances = ["mypy-boto3-workspaces-instances (>=1.40.0,<1.41.0)"] workspaces-thin-client = ["mypy-boto3-workspaces-thin-client (>=1.40.0,<1.41.0)"] workspaces-web = ["mypy-boto3-workspaces-web (>=1.40.0,<1.41.0)"] xray = ["mypy-boto3-xray (>=1.40.0,<1.41.0)"] [[package]] name = "botocore" version = "1.40.66" description = "Low-level, data-driven core of boto 3." optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "botocore-1.40.66-py3-none-any.whl", hash = "sha256:98d5766e17e72110b1d08ab510a8475a6597c59d9560235e2d28ae1a4b043b92"}, {file = "botocore-1.40.66.tar.gz", hash = "sha256:e49a55ad54426c4ea853a59ff9d8243023a90c935782d4c287e9b3424883c3fa"}, ] [package.dependencies] jmespath = ">=0.7.1,<2.0.0" python-dateutil = ">=2.1,<3.0.0" urllib3 = {version = ">=1.25.4,<2.2.0 || >2.2.0,<3", markers = "python_version >= \"3.10\""} [package.extras] crt = ["awscrt (==0.27.6)"] [[package]] name = "botocore-stubs" version = "1.34.67" description = "Type annotations and code completion for botocore" optional = false python-versions = "<4.0,>=3.8" groups = ["main"] files = [ {file = "botocore_stubs-1.34.67-py3-none-any.whl", hash = "sha256:e776b1f7a2907c3873499c309dbba16adae3dc7448536e2246de8afd45dad25d"}, {file = "botocore_stubs-1.34.67.tar.gz", hash = "sha256:bde9eda01ce4983c2dde943af25468ea56f677151aa533aaa3976ee35c6e37b7"}, ] [package.dependencies] types-awscrt = "*" [package.extras] botocore = ["botocore"] [[package]] name = "certifi" version = "2024.7.4" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.6" groups = ["main", "dev"] files = [ {file = "certifi-2024.7.4-py3-none-any.whl", hash = "sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90"}, {file = "certifi-2024.7.4.tar.gz", hash = "sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b"}, ] [[package]] name = "cffi" version = "1.16.0" description = "Foreign Function Interface for Python calling C code." optional = false python-versions = ">=3.8" groups = ["dev"] markers = "platform_python_implementation != \"PyPy\"" files = [ {file = "cffi-1.16.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6b3d6606d369fc1da4fd8c357d026317fbb9c9b75d36dc16e90e84c26854b088"}, {file = "cffi-1.16.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ac0f5edd2360eea2f1daa9e26a41db02dd4b0451b48f7c318e217ee092a213e9"}, {file = "cffi-1.16.0-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7e61e3e4fa664a8588aa25c883eab612a188c725755afff6289454d6362b9673"}, {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a72e8961a86d19bdb45851d8f1f08b041ea37d2bd8d4fd19903bc3083d80c896"}, {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5b50bf3f55561dac5438f8e70bfcdfd74543fd60df5fa5f62d94e5867deca684"}, {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7651c50c8c5ef7bdb41108b7b8c5a83013bfaa8a935590c5d74627c047a583c7"}, {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4108df7fe9b707191e55f33efbcb2d81928e10cea45527879a4749cbe472614"}, {file = "cffi-1.16.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:32c68ef735dbe5857c810328cb2481e24722a59a2003018885514d4c09af9743"}, {file = "cffi-1.16.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:673739cb539f8cdaa07d92d02efa93c9ccf87e345b9a0b556e3ecc666718468d"}, {file = "cffi-1.16.0-cp310-cp310-win32.whl", hash = "sha256:9f90389693731ff1f659e55c7d1640e2ec43ff725cc61b04b2f9c6d8d017df6a"}, {file = "cffi-1.16.0-cp310-cp310-win_amd64.whl", hash = "sha256:e6024675e67af929088fda399b2094574609396b1decb609c55fa58b028a32a1"}, {file = "cffi-1.16.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b84834d0cf97e7d27dd5b7f3aca7b6e9263c56308ab9dc8aae9784abb774d404"}, {file = "cffi-1.16.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1b8ebc27c014c59692bb2664c7d13ce7a6e9a629be20e54e7271fa696ff2b417"}, {file = "cffi-1.16.0-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ee07e47c12890ef248766a6e55bd38ebfb2bb8edd4142d56db91b21ea68b7627"}, {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d8a9d3ebe49f084ad71f9269834ceccbf398253c9fac910c4fd7053ff1386936"}, {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e70f54f1796669ef691ca07d046cd81a29cb4deb1e5f942003f401c0c4a2695d"}, {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5bf44d66cdf9e893637896c7faa22298baebcd18d1ddb6d2626a6e39793a1d56"}, {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7b78010e7b97fef4bee1e896df8a4bbb6712b7f05b7ef630f9d1da00f6444d2e"}, {file = "cffi-1.16.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c6a164aa47843fb1b01e941d385aab7215563bb8816d80ff3a363a9f8448a8dc"}, {file = "cffi-1.16.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e09f3ff613345df5e8c3667da1d918f9149bd623cd9070c983c013792a9a62eb"}, {file = "cffi-1.16.0-cp311-cp311-win32.whl", hash = "sha256:2c56b361916f390cd758a57f2e16233eb4f64bcbeee88a4881ea90fca14dc6ab"}, {file = "cffi-1.16.0-cp311-cp311-win_amd64.whl", hash = "sha256:db8e577c19c0fda0beb7e0d4e09e0ba74b1e4c092e0e40bfa12fe05b6f6d75ba"}, {file = "cffi-1.16.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:fa3a0128b152627161ce47201262d3140edb5a5c3da88d73a1b790a959126956"}, {file = "cffi-1.16.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:68e7c44931cc171c54ccb702482e9fc723192e88d25a0e133edd7aff8fcd1f6e"}, {file = "cffi-1.16.0-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:abd808f9c129ba2beda4cfc53bde801e5bcf9d6e0f22f095e45327c038bfe68e"}, {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:88e2b3c14bdb32e440be531ade29d3c50a1a59cd4e51b1dd8b0865c54ea5d2e2"}, {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fcc8eb6d5902bb1cf6dc4f187ee3ea80a1eba0a89aba40a5cb20a5087d961357"}, {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b7be2d771cdba2942e13215c4e340bfd76398e9227ad10402a8767ab1865d2e6"}, {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e715596e683d2ce000574bae5d07bd522c781a822866c20495e52520564f0969"}, {file = "cffi-1.16.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2d92b25dbf6cae33f65005baf472d2c245c050b1ce709cc4588cdcdd5495b520"}, {file = "cffi-1.16.0-cp312-cp312-win32.whl", hash = "sha256:b2ca4e77f9f47c55c194982e10f058db063937845bb2b7a86c84a6cfe0aefa8b"}, {file = "cffi-1.16.0-cp312-cp312-win_amd64.whl", hash = "sha256:68678abf380b42ce21a5f2abde8efee05c114c2fdb2e9eef2efdb0257fba1235"}, {file = "cffi-1.16.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:0c9ef6ff37e974b73c25eecc13952c55bceed9112be2d9d938ded8e856138bcc"}, {file = "cffi-1.16.0-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a09582f178759ee8128d9270cd1344154fd473bb77d94ce0aeb2a93ebf0feaf0"}, {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e760191dd42581e023a68b758769e2da259b5d52e3103c6060ddc02c9edb8d7b"}, {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:80876338e19c951fdfed6198e70bc88f1c9758b94578d5a7c4c91a87af3cf31c"}, {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a6a14b17d7e17fa0d207ac08642c8820f84f25ce17a442fd15e27ea18d67c59b"}, {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6602bc8dc6f3a9e02b6c22c4fc1e47aa50f8f8e6d3f78a5e16ac33ef5fefa324"}, {file = "cffi-1.16.0-cp38-cp38-win32.whl", hash = "sha256:131fd094d1065b19540c3d72594260f118b231090295d8c34e19a7bbcf2e860a"}, {file = "cffi-1.16.0-cp38-cp38-win_amd64.whl", hash = "sha256:31d13b0f99e0836b7ff893d37af07366ebc90b678b6664c955b54561fc36ef36"}, {file = "cffi-1.16.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:582215a0e9adbe0e379761260553ba11c58943e4bbe9c36430c4ca6ac74b15ed"}, {file = "cffi-1.16.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:b29ebffcf550f9da55bec9e02ad430c992a87e5f512cd63388abb76f1036d8d2"}, {file = "cffi-1.16.0-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dc9b18bf40cc75f66f40a7379f6a9513244fe33c0e8aa72e2d56b0196a7ef872"}, {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9cb4a35b3642fc5c005a6755a5d17c6c8b6bcb6981baf81cea8bfbc8903e8ba8"}, {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b86851a328eedc692acf81fb05444bdf1891747c25af7529e39ddafaf68a4f3f"}, {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c0f31130ebc2d37cdd8e44605fb5fa7ad59049298b3f745c74fa74c62fbfcfc4"}, {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f8e709127c6c77446a8c0a8c8bf3c8ee706a06cd44b1e827c3e6a2ee6b8c098"}, {file = "cffi-1.16.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:748dcd1e3d3d7cd5443ef03ce8685043294ad6bd7c02a38d1bd367cfd968e000"}, {file = "cffi-1.16.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8895613bcc094d4a1b2dbe179d88d7fb4a15cee43c052e8885783fac397d91fe"}, {file = "cffi-1.16.0-cp39-cp39-win32.whl", hash = "sha256:ed86a35631f7bfbb28e108dd96773b9d5a6ce4811cf6ea468bb6a359b256b1e4"}, {file = "cffi-1.16.0-cp39-cp39-win_amd64.whl", hash = "sha256:3686dffb02459559c74dd3d81748269ffb0eb027c39a6fc99502de37d501faa8"}, {file = "cffi-1.16.0.tar.gz", hash = "sha256:bcb3ef43e58665bbda2fb198698fcae6776483e0c4a631aa5647806c25e02cc0"}, ] [package.dependencies] pycparser = "*" [[package]] name = "cfgv" version = "3.4.0" description = "Validate configuration and produce human readable error messages." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "cfgv-3.4.0-py2.py3-none-any.whl", hash = "sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9"}, {file = "cfgv-3.4.0.tar.gz", hash = "sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560"}, ] [[package]] name = "charset-normalizer" version = "3.3.2" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." optional = false python-versions = ">=3.7.0" groups = ["main", "dev"] files = [ {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, ] [[package]] name = "click" version = "8.1.7" description = "Composable command line interface toolkit" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, ] [package.dependencies] colorama = {version = "*", markers = "platform_system == \"Windows\""} [[package]] name = "colorama" version = "0.4.6" description = "Cross-platform colored terminal text." optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" groups = ["dev"] markers = "sys_platform == \"win32\" or platform_system == \"Windows\"" files = [ {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, ] [[package]] name = "contourpy" version = "1.2.0" description = "Python library for calculating contours of 2D quadrilateral grids" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "contourpy-1.2.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:0274c1cb63625972c0c007ab14dd9ba9e199c36ae1a231ce45d725cbcbfd10a8"}, {file = "contourpy-1.2.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ab459a1cbbf18e8698399c595a01f6dcc5c138220ca3ea9e7e6126232d102bb4"}, {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fdd887f17c2f4572ce548461e4f96396681212d858cae7bd52ba3310bc6f00f"}, {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5d16edfc3fc09968e09ddffada434b3bf989bf4911535e04eada58469873e28e"}, {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1c203f617abc0dde5792beb586f827021069fb6d403d7f4d5c2b543d87edceb9"}, {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b69303ceb2e4d4f146bf82fda78891ef7bcd80c41bf16bfca3d0d7eb545448aa"}, {file = "contourpy-1.2.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:884c3f9d42d7218304bc74a8a7693d172685c84bd7ab2bab1ee567b769696df9"}, {file = "contourpy-1.2.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:4a1b1208102be6e851f20066bf0e7a96b7d48a07c9b0cfe6d0d4545c2f6cadab"}, {file = "contourpy-1.2.0-cp310-cp310-win32.whl", hash = "sha256:34b9071c040d6fe45d9826cbbe3727d20d83f1b6110d219b83eb0e2a01d79488"}, {file = "contourpy-1.2.0-cp310-cp310-win_amd64.whl", hash = "sha256:bd2f1ae63998da104f16a8b788f685e55d65760cd1929518fd94cd682bf03e41"}, {file = "contourpy-1.2.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:dd10c26b4eadae44783c45ad6655220426f971c61d9b239e6f7b16d5cdaaa727"}, {file = "contourpy-1.2.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5c6b28956b7b232ae801406e529ad7b350d3f09a4fde958dfdf3c0520cdde0dd"}, {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ebeac59e9e1eb4b84940d076d9f9a6cec0064e241818bcb6e32124cc5c3e377a"}, {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:139d8d2e1c1dd52d78682f505e980f592ba53c9f73bd6be102233e358b401063"}, {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1e9dc350fb4c58adc64df3e0703ab076f60aac06e67d48b3848c23647ae4310e"}, {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:18fc2b4ed8e4a8fe849d18dce4bd3c7ea637758c6343a1f2bae1e9bd4c9f4686"}, {file = "contourpy-1.2.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:16a7380e943a6d52472096cb7ad5264ecee36ed60888e2a3d3814991a0107286"}, {file = "contourpy-1.2.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:8d8faf05be5ec8e02a4d86f616fc2a0322ff4a4ce26c0f09d9f7fb5330a35c95"}, {file = "contourpy-1.2.0-cp311-cp311-win32.whl", hash = "sha256:67b7f17679fa62ec82b7e3e611c43a016b887bd64fb933b3ae8638583006c6d6"}, {file = "contourpy-1.2.0-cp311-cp311-win_amd64.whl", hash = "sha256:99ad97258985328b4f207a5e777c1b44a83bfe7cf1f87b99f9c11d4ee477c4de"}, {file = "contourpy-1.2.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:575bcaf957a25d1194903a10bc9f316c136c19f24e0985a2b9b5608bdf5dbfe0"}, {file = "contourpy-1.2.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9e6c93b5b2dbcedad20a2f18ec22cae47da0d705d454308063421a3b290d9ea4"}, {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:464b423bc2a009088f19bdf1f232299e8b6917963e2b7e1d277da5041f33a779"}, {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:68ce4788b7d93e47f84edd3f1f95acdcd142ae60bc0e5493bfd120683d2d4316"}, {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3d7d1f8871998cdff5d2ff6a087e5e1780139abe2838e85b0b46b7ae6cc25399"}, {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e739530c662a8d6d42c37c2ed52a6f0932c2d4a3e8c1f90692ad0ce1274abe0"}, {file = "contourpy-1.2.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:247b9d16535acaa766d03037d8e8fb20866d054d3c7fbf6fd1f993f11fc60ca0"}, {file = "contourpy-1.2.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:461e3ae84cd90b30f8d533f07d87c00379644205b1d33a5ea03381edc4b69431"}, {file = "contourpy-1.2.0-cp312-cp312-win32.whl", hash = "sha256:1c2559d6cffc94890b0529ea7eeecc20d6fadc1539273aa27faf503eb4656d8f"}, {file = "contourpy-1.2.0-cp312-cp312-win_amd64.whl", hash = "sha256:491b1917afdd8638a05b611a56d46587d5a632cabead889a5440f7c638bc6ed9"}, {file = "contourpy-1.2.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5fd1810973a375ca0e097dee059c407913ba35723b111df75671a1976efa04bc"}, {file = "contourpy-1.2.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:999c71939aad2780f003979b25ac5b8f2df651dac7b38fb8ce6c46ba5abe6ae9"}, {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b7caf9b241464c404613512d5594a6e2ff0cc9cb5615c9475cc1d9b514218ae8"}, {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:266270c6f6608340f6c9836a0fb9b367be61dde0c9a9a18d5ece97774105ff3e"}, {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dbd50d0a0539ae2e96e537553aff6d02c10ed165ef40c65b0e27e744a0f10af8"}, {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:11f8d2554e52f459918f7b8e6aa20ec2a3bce35ce95c1f0ef4ba36fbda306df5"}, {file = "contourpy-1.2.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:ce96dd400486e80ac7d195b2d800b03e3e6a787e2a522bfb83755938465a819e"}, {file = "contourpy-1.2.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:6d3364b999c62f539cd403f8123ae426da946e142312a514162adb2addd8d808"}, {file = "contourpy-1.2.0-cp39-cp39-win32.whl", hash = "sha256:1c88dfb9e0c77612febebb6ac69d44a8d81e3dc60f993215425b62c1161353f4"}, {file = "contourpy-1.2.0-cp39-cp39-win_amd64.whl", hash = "sha256:78e6ad33cf2e2e80c5dfaaa0beec3d61face0fb650557100ee36db808bfa6843"}, {file = "contourpy-1.2.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:be16975d94c320432657ad2402f6760990cb640c161ae6da1363051805fa8108"}, {file = "contourpy-1.2.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b95a225d4948b26a28c08307a60ac00fb8671b14f2047fc5476613252a129776"}, {file = "contourpy-1.2.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:0d7e03c0f9a4f90dc18d4e77e9ef4ec7b7bbb437f7f675be8e530d65ae6ef956"}, {file = "contourpy-1.2.0.tar.gz", hash = "sha256:171f311cb758de7da13fc53af221ae47a5877be5a0843a9fe150818c51ed276a"}, ] [package.dependencies] numpy = ">=1.20,<2.0" [package.extras] bokeh = ["bokeh", "selenium"] docs = ["furo", "sphinx (>=7.2)", "sphinx-copybutton"] mypy = ["contourpy[bokeh,docs]", "docutils-stubs", "mypy (==1.6.1)", "types-Pillow"] test = ["Pillow", "contourpy[test-no-images]", "matplotlib"] test-no-images = ["pytest", "pytest-cov", "pytest-xdist", "wurlitzer"] [[package]] name = "coverage" version = "7.4.4" description = "Code coverage measurement for Python" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "coverage-7.4.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e0be5efd5127542ef31f165de269f77560d6cdef525fffa446de6f7e9186cfb2"}, {file = "coverage-7.4.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ccd341521be3d1b3daeb41960ae94a5e87abe2f46f17224ba5d6f2b8398016cf"}, {file = "coverage-7.4.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:09fa497a8ab37784fbb20ab699c246053ac294d13fc7eb40ec007a5043ec91f8"}, {file = "coverage-7.4.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b1a93009cb80730c9bca5d6d4665494b725b6e8e157c1cb7f2db5b4b122ea562"}, {file = "coverage-7.4.4-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:690db6517f09336559dc0b5f55342df62370a48f5469fabf502db2c6d1cffcd2"}, {file = "coverage-7.4.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:09c3255458533cb76ef55da8cc49ffab9e33f083739c8bd4f58e79fecfe288f7"}, {file = "coverage-7.4.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:8ce1415194b4a6bd0cdcc3a1dfbf58b63f910dcb7330fe15bdff542c56949f87"}, {file = "coverage-7.4.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b91cbc4b195444e7e258ba27ac33769c41b94967919f10037e6355e998af255c"}, {file = "coverage-7.4.4-cp310-cp310-win32.whl", hash = "sha256:598825b51b81c808cb6f078dcb972f96af96b078faa47af7dfcdf282835baa8d"}, {file = "coverage-7.4.4-cp310-cp310-win_amd64.whl", hash = "sha256:09ef9199ed6653989ebbcaacc9b62b514bb63ea2f90256e71fea3ed74bd8ff6f"}, {file = "coverage-7.4.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:0f9f50e7ef2a71e2fae92774c99170eb8304e3fdf9c8c3c7ae9bab3e7229c5cf"}, {file = "coverage-7.4.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:623512f8ba53c422fcfb2ce68362c97945095b864cda94a92edbaf5994201083"}, {file = "coverage-7.4.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0513b9508b93da4e1716744ef6ebc507aff016ba115ffe8ecff744d1322a7b63"}, {file = "coverage-7.4.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40209e141059b9370a2657c9b15607815359ab3ef9918f0196b6fccce8d3230f"}, {file = "coverage-7.4.4-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8a2b2b78c78293782fd3767d53e6474582f62443d0504b1554370bde86cc8227"}, {file = "coverage-7.4.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:73bfb9c09951125d06ee473bed216e2c3742f530fc5acc1383883125de76d9cd"}, {file = "coverage-7.4.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:1f384c3cc76aeedce208643697fb3e8437604b512255de6d18dae3f27655a384"}, {file = "coverage-7.4.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:54eb8d1bf7cacfbf2a3186019bcf01d11c666bd495ed18717162f7eb1e9dd00b"}, {file = "coverage-7.4.4-cp311-cp311-win32.whl", hash = "sha256:cac99918c7bba15302a2d81f0312c08054a3359eaa1929c7e4b26ebe41e9b286"}, {file = "coverage-7.4.4-cp311-cp311-win_amd64.whl", hash = "sha256:b14706df8b2de49869ae03a5ccbc211f4041750cd4a66f698df89d44f4bd30ec"}, {file = "coverage-7.4.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:201bef2eea65e0e9c56343115ba3814e896afe6d36ffd37bab783261db430f76"}, {file = "coverage-7.4.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:41c9c5f3de16b903b610d09650e5e27adbfa7f500302718c9ffd1c12cf9d6818"}, {file = "coverage-7.4.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d898fe162d26929b5960e4e138651f7427048e72c853607f2b200909794ed978"}, {file = "coverage-7.4.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3ea79bb50e805cd6ac058dfa3b5c8f6c040cb87fe83de10845857f5535d1db70"}, {file = "coverage-7.4.4-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ce4b94265ca988c3f8e479e741693d143026632672e3ff924f25fab50518dd51"}, {file = "coverage-7.4.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:00838a35b882694afda09f85e469c96367daa3f3f2b097d846a7216993d37f4c"}, {file = "coverage-7.4.4-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:fdfafb32984684eb03c2d83e1e51f64f0906b11e64482df3c5db936ce3839d48"}, {file = "coverage-7.4.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:69eb372f7e2ece89f14751fbcbe470295d73ed41ecd37ca36ed2eb47512a6ab9"}, {file = "coverage-7.4.4-cp312-cp312-win32.whl", hash = "sha256:137eb07173141545e07403cca94ab625cc1cc6bc4c1e97b6e3846270e7e1fea0"}, {file = "coverage-7.4.4-cp312-cp312-win_amd64.whl", hash = "sha256:d71eec7d83298f1af3326ce0ff1d0ea83c7cb98f72b577097f9083b20bdaf05e"}, {file = "coverage-7.4.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:d5ae728ff3b5401cc320d792866987e7e7e880e6ebd24433b70a33b643bb0384"}, {file = "coverage-7.4.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:cc4f1358cb0c78edef3ed237ef2c86056206bb8d9140e73b6b89fbcfcbdd40e1"}, {file = "coverage-7.4.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8130a2aa2acb8788e0b56938786c33c7c98562697bf9f4c7d6e8e5e3a0501e4a"}, {file = "coverage-7.4.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cf271892d13e43bc2b51e6908ec9a6a5094a4df1d8af0bfc360088ee6c684409"}, {file = "coverage-7.4.4-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a4cdc86d54b5da0df6d3d3a2f0b710949286094c3a6700c21e9015932b81447e"}, {file = "coverage-7.4.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:ae71e7ddb7a413dd60052e90528f2f65270aad4b509563af6d03d53e979feafd"}, {file = "coverage-7.4.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:38dd60d7bf242c4ed5b38e094baf6401faa114fc09e9e6632374388a404f98e7"}, {file = "coverage-7.4.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:aa5b1c1bfc28384f1f53b69a023d789f72b2e0ab1b3787aae16992a7ca21056c"}, {file = "coverage-7.4.4-cp38-cp38-win32.whl", hash = "sha256:dfa8fe35a0bb90382837b238fff375de15f0dcdb9ae68ff85f7a63649c98527e"}, {file = "coverage-7.4.4-cp38-cp38-win_amd64.whl", hash = "sha256:b2991665420a803495e0b90a79233c1433d6ed77ef282e8e152a324bbbc5e0c8"}, {file = "coverage-7.4.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3b799445b9f7ee8bf299cfaed6f5b226c0037b74886a4e11515e569b36fe310d"}, {file = "coverage-7.4.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:b4d33f418f46362995f1e9d4f3a35a1b6322cb959c31d88ae56b0298e1c22357"}, {file = "coverage-7.4.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:aadacf9a2f407a4688d700e4ebab33a7e2e408f2ca04dbf4aef17585389eff3e"}, {file = "coverage-7.4.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7c95949560050d04d46b919301826525597f07b33beba6187d04fa64d47ac82e"}, {file = "coverage-7.4.4-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ff7687ca3d7028d8a5f0ebae95a6e4827c5616b31a4ee1192bdfde697db110d4"}, {file = "coverage-7.4.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:5fc1de20b2d4a061b3df27ab9b7c7111e9a710f10dc2b84d33a4ab25065994ec"}, {file = "coverage-7.4.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:c74880fc64d4958159fbd537a091d2a585448a8f8508bf248d72112723974cbd"}, {file = "coverage-7.4.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:742a76a12aa45b44d236815d282b03cfb1de3b4323f3e4ec933acfae08e54ade"}, {file = "coverage-7.4.4-cp39-cp39-win32.whl", hash = "sha256:d89d7b2974cae412400e88f35d86af72208e1ede1a541954af5d944a8ba46c57"}, {file = "coverage-7.4.4-cp39-cp39-win_amd64.whl", hash = "sha256:9ca28a302acb19b6af89e90f33ee3e1906961f94b54ea37de6737b7ca9d8827c"}, {file = "coverage-7.4.4-pp38.pp39.pp310-none-any.whl", hash = "sha256:b2c5edc4ac10a7ef6605a966c58929ec6c1bd0917fb8c15cb3363f65aa40e677"}, {file = "coverage-7.4.4.tar.gz", hash = "sha256:c901df83d097649e257e803be22592aedfd5182f07b3cc87d640bbb9afd50f49"}, ] [package.extras] toml = ["tomli ; python_full_version <= \"3.11.0a6\""] [[package]] name = "cryptography" version = "44.0.1" description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers." optional = false python-versions = "!=3.9.0,!=3.9.1,>=3.7" groups = ["dev"] files = [ {file = "cryptography-44.0.1-cp37-abi3-macosx_10_9_universal2.whl", hash = "sha256:bf688f615c29bfe9dfc44312ca470989279f0e94bb9f631f85e3459af8efc009"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dd7c7e2d71d908dc0f8d2027e1604102140d84b155e658c20e8ad1304317691f"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:887143b9ff6bad2b7570da75a7fe8bbf5f65276365ac259a5d2d5147a73775f2"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:322eb03ecc62784536bc173f1483e76747aafeb69c8728df48537eb431cd1911"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_28_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:21377472ca4ada2906bc313168c9dc7b1d7ca417b63c1c3011d0c74b7de9ae69"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:df978682c1504fc93b3209de21aeabf2375cb1571d4e61907b3e7a2540e83026"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_34_aarch64.whl", hash = "sha256:eb3889330f2a4a148abead555399ec9a32b13b7c8ba969b72d8e500eb7ef84cd"}, {file = "cryptography-44.0.1-cp37-abi3-manylinux_2_34_x86_64.whl", hash = "sha256:8e6a85a93d0642bd774460a86513c5d9d80b5c002ca9693e63f6e540f1815ed0"}, {file = "cryptography-44.0.1-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:6f76fdd6fd048576a04c5210d53aa04ca34d2ed63336d4abd306d0cbe298fddf"}, {file = "cryptography-44.0.1-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:6c8acf6f3d1f47acb2248ec3ea261171a671f3d9428e34ad0357148d492c7864"}, {file = "cryptography-44.0.1-cp37-abi3-win32.whl", hash = "sha256:24979e9f2040c953a94bf3c6782e67795a4c260734e5264dceea65c8f4bae64a"}, {file = "cryptography-44.0.1-cp37-abi3-win_amd64.whl", hash = "sha256:fd0ee90072861e276b0ff08bd627abec29e32a53b2be44e41dbcdf87cbee2b00"}, {file = "cryptography-44.0.1-cp39-abi3-macosx_10_9_universal2.whl", hash = "sha256:a2d8a7045e1ab9b9f803f0d9531ead85f90c5f2859e653b61497228b18452008"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b8272f257cf1cbd3f2e120f14c68bff2b6bdfcc157fafdee84a1b795efd72862"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1e8d181e90a777b63f3f0caa836844a1182f1f265687fac2115fcf245f5fbec3"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:436df4f203482f41aad60ed1813811ac4ab102765ecae7a2bbb1dbb66dcff5a7"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_28_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:4f422e8c6a28cf8b7f883eb790695d6d45b0c385a2583073f3cec434cc705e1a"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:72198e2b5925155497a5a3e8c216c7fb3e64c16ccee11f0e7da272fa93b35c4c"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_34_aarch64.whl", hash = "sha256:2a46a89ad3e6176223b632056f321bc7de36b9f9b93b2cc1cccf935a3849dc62"}, {file = "cryptography-44.0.1-cp39-abi3-manylinux_2_34_x86_64.whl", hash = "sha256:53f23339864b617a3dfc2b0ac8d5c432625c80014c25caac9082314e9de56f41"}, {file = "cryptography-44.0.1-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:888fcc3fce0c888785a4876ca55f9f43787f4c5c1cc1e2e0da71ad481ff82c5b"}, {file = "cryptography-44.0.1-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:00918d859aa4e57db8299607086f793fa7813ae2ff5a4637e318a25ef82730f7"}, {file = "cryptography-44.0.1-cp39-abi3-win32.whl", hash = "sha256:9b336599e2cb77b1008cb2ac264b290803ec5e8e89d618a5e978ff5eb6f715d9"}, {file = "cryptography-44.0.1-cp39-abi3-win_amd64.whl", hash = "sha256:e403f7f766ded778ecdb790da786b418a9f2394f36e8cc8b796cc056ab05f44f"}, {file = "cryptography-44.0.1-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:1f9a92144fa0c877117e9748c74501bea842f93d21ee00b0cf922846d9d0b183"}, {file = "cryptography-44.0.1-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:610a83540765a8d8ce0f351ce42e26e53e1f774a6efb71eb1b41eb01d01c3d12"}, {file = "cryptography-44.0.1-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:5fed5cd6102bb4eb843e3315d2bf25fede494509bddadb81e03a859c1bc17b83"}, {file = "cryptography-44.0.1-pp310-pypy310_pp73-manylinux_2_34_aarch64.whl", hash = "sha256:f4daefc971c2d1f82f03097dc6f216744a6cd2ac0f04c68fb935ea2ba2a0d420"}, {file = "cryptography-44.0.1-pp310-pypy310_pp73-manylinux_2_34_x86_64.whl", hash = "sha256:94f99f2b943b354a5b6307d7e8d19f5c423a794462bde2bf310c770ba052b1c4"}, {file = "cryptography-44.0.1-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:d9c5b9f698a83c8bd71e0f4d3f9f839ef244798e5ffe96febfa9714717db7af7"}, {file = "cryptography-44.0.1.tar.gz", hash = "sha256:f51f5705ab27898afda1aaa430f34ad90dc117421057782022edf0600bec5f14"}, ] [package.dependencies] cffi = {version = ">=1.12", markers = "platform_python_implementation != \"PyPy\""} [package.extras] docs = ["sphinx (>=5.3.0)", "sphinx-rtd-theme (>=3.0.0) ; python_version >= \"3.8\""] docstest = ["pyenchant (>=3)", "readme-renderer (>=30.0)", "sphinxcontrib-spelling (>=7.3.1)"] nox = ["nox (>=2024.4.15)", "nox[uv] (>=2024.3.2) ; python_version >= \"3.8\""] pep8test = ["check-sdist ; python_version >= \"3.8\"", "click (>=8.0.1)", "mypy (>=1.4)", "ruff (>=0.3.6)"] sdist = ["build (>=1.0.0)"] ssh = ["bcrypt (>=3.1.5)"] test = ["certifi (>=2024)", "cryptography-vectors (==44.0.1)", "pretend (>=0.7)", "pytest (>=7.4.0)", "pytest-benchmark (>=4.0)", "pytest-cov (>=2.10.1)", "pytest-xdist (>=3.5.0)"] test-randomorder = ["pytest-randomly"] [[package]] name = "cycler" version = "0.12.1" description = "Composable style cycles" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "cycler-0.12.1-py3-none-any.whl", hash = "sha256:85cef7cff222d8644161529808465972e51340599459b8ac3ccbac5a854e0d30"}, {file = "cycler-0.12.1.tar.gz", hash = "sha256:88bb128f02ba341da8ef447245a9e138fae777f6a23943da4540077d3601eb1c"}, ] [package.extras] docs = ["ipython", "matplotlib", "numpydoc", "sphinx"] tests = ["pytest", "pytest-cov", "pytest-xdist"] [[package]] name = "datamodel-code-generator" version = "0.26.1" description = "Datamodel Code Generator" optional = false python-versions = "<4.0,>=3.8" groups = ["dev"] files = [ {file = "datamodel_code_generator-0.26.1-py3-none-any.whl", hash = "sha256:bbe8a6cc0b9cfdbfd294e336e02b4c50b481ffc3b3c608b5578b6d7aa02cc8ae"}, {file = "datamodel_code_generator-0.26.1.tar.gz", hash = "sha256:3b7b49c4230fa197ca28847e1e8996cd664638a7e91796c826a61c60d4ccd8a2"}, ] [package.dependencies] argcomplete = ">=1.10,<4.0" black = ">=19.10b0" genson = ">=1.2.1,<2.0" inflect = ">=4.1.0,<6.0" isort = ">=4.3.21,<6.0" jinja2 = ">=2.10.1,<4.0" packaging = "*" pydantic = {version = ">=1.10.0,<2.0.0 || >2.0.0,<2.0.1 || >2.0.1,<2.4.0 || >2.4.0,<3.0", extras = ["email"], markers = "python_version >= \"3.12\" and python_version < \"4.0\""} pyyaml = ">=6.0.1" [package.extras] debug = ["PySnooper (>=0.4.1,<2.0.0)"] graphql = ["graphql-core (>=3.2.3,<4.0.0)"] http = ["httpx"] validation = ["openapi-spec-validator (>=0.2.8,<0.7.0)", "prance (>=0.18.2)"] [[package]] name = "distlib" version = "0.3.8" description = "Distribution utilities" optional = false python-versions = "*" groups = ["dev"] files = [ {file = "distlib-0.3.8-py2.py3-none-any.whl", hash = "sha256:034db59a0b96f8ca18035f36290806a9a6e6bd9d1ff91e45a7f172eb17e51784"}, {file = "distlib-0.3.8.tar.gz", hash = "sha256:1530ea13e350031b6312d8580ddb6b27a104275a31106523b8f123787f494f64"}, ] [[package]] name = "dnspython" version = "2.6.1" description = "DNS toolkit" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "dnspython-2.6.1-py3-none-any.whl", hash = "sha256:5ef3b9680161f6fa89daf8ad451b5f1a33b18ae8a1c6778cdf4b43f08c0a6e50"}, {file = "dnspython-2.6.1.tar.gz", hash = "sha256:e8f0f9c23a7b7cb99ded64e6c3a6f3e701d78f50c55e002b839dea7225cff7cc"}, ] [package.extras] dev = ["black (>=23.1.0)", "coverage (>=7.0)", "flake8 (>=7)", "mypy (>=1.8)", "pylint (>=3)", "pytest (>=7.4)", "pytest-cov (>=4.1.0)", "sphinx (>=7.2.0)", "twine (>=4.0.0)", "wheel (>=0.42.0)"] dnssec = ["cryptography (>=41)"] doh = ["h2 (>=4.1.0)", "httpcore (>=1.0.0)", "httpx (>=0.26.0)"] doq = ["aioquic (>=0.9.25)"] idna = ["idna (>=3.6)"] trio = ["trio (>=0.23)"] wmi = ["wmi (>=1.5.1)"] [[package]] name = "docker" version = "7.0.0" description = "A Python library for the Docker Engine API." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "docker-7.0.0-py3-none-any.whl", hash = "sha256:12ba681f2777a0ad28ffbcc846a69c31b4dfd9752b47eb425a274ee269c5e14b"}, {file = "docker-7.0.0.tar.gz", hash = "sha256:323736fb92cd9418fc5e7133bc953e11a9da04f4483f828b527db553f1e7e5a3"}, ] [package.dependencies] packaging = ">=14.0" pywin32 = {version = ">=304", markers = "sys_platform == \"win32\""} requests = ">=2.26.0" urllib3 = ">=1.26.0" [package.extras] ssh = ["paramiko (>=2.4.3)"] websockets = ["websocket-client (>=1.3.0)"] [[package]] name = "email-validator" version = "2.1.1" description = "A robust email address syntax and deliverability validation library." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "email_validator-2.1.1-py3-none-any.whl", hash = "sha256:97d882d174e2a65732fb43bfce81a3a834cbc1bde8bf419e30ef5ea976370a05"}, {file = "email_validator-2.1.1.tar.gz", hash = "sha256:200a70680ba08904be6d1eef729205cc0d687634399a5924d842533efb824b84"}, ] [package.dependencies] dnspython = ">=2.0.0" idna = ">=2.0.0" [[package]] name = "filelock" version = "3.13.1" description = "A platform independent file lock." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "filelock-3.13.1-py3-none-any.whl", hash = "sha256:57dbda9b35157b05fb3e58ee91448612eb674172fab98ee235ccb0b5bee19a1c"}, {file = "filelock-3.13.1.tar.gz", hash = "sha256:521f5f56c50f8426f5e03ad3b281b490a87ef15bc6c526f168290f0c7148d44e"}, ] [package.extras] docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.24)"] testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"] typing = ["typing-extensions (>=4.8) ; python_version < \"3.11\""] [[package]] name = "fire" version = "0.7.0" description = "A library for automatically generating command line interfaces." optional = false python-versions = "*" groups = ["dev"] files = [ {file = "fire-0.7.0.tar.gz", hash = "sha256:961550f07936eaf65ad1dc8360f2b2bf8408fad46abbfa4d2a3794f8d2a95cdf"}, ] [package.dependencies] termcolor = "*" [[package]] name = "fonttools" version = "4.50.0" description = "Tools to manipulate font files" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "fonttools-4.50.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:effd303fb422f8ce06543a36ca69148471144c534cc25f30e5be752bc4f46736"}, {file = "fonttools-4.50.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7913992ab836f621d06aabac118fc258b9947a775a607e1a737eb3a91c360335"}, {file = "fonttools-4.50.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8e0a1c5bd2f63da4043b63888534b52c5a1fd7ae187c8ffc64cbb7ae475b9dab"}, {file = "fonttools-4.50.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d40fc98540fa5360e7ecf2c56ddf3c6e7dd04929543618fd7b5cc76e66390562"}, {file = "fonttools-4.50.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:9fff65fbb7afe137bac3113827855e0204482727bddd00a806034ab0d3951d0d"}, {file = "fonttools-4.50.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b1aeae3dd2ee719074a9372c89ad94f7c581903306d76befdaca2a559f802472"}, {file = "fonttools-4.50.0-cp310-cp310-win32.whl", hash = "sha256:e9623afa319405da33b43c85cceb0585a6f5d3a1d7c604daf4f7e1dd55c03d1f"}, {file = "fonttools-4.50.0-cp310-cp310-win_amd64.whl", hash = "sha256:778c5f43e7e654ef7fe0605e80894930bc3a7772e2f496238e57218610140f54"}, {file = "fonttools-4.50.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:3dfb102e7f63b78c832e4539969167ffcc0375b013080e6472350965a5fe8048"}, {file = "fonttools-4.50.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:9e58fe34cb379ba3d01d5d319d67dd3ce7ca9a47ad044ea2b22635cd2d1247fc"}, {file = "fonttools-4.50.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2c673ab40d15a442a4e6eb09bf007c1dda47c84ac1e2eecbdf359adacb799c24"}, {file = "fonttools-4.50.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9b3ac35cdcd1a4c90c23a5200212c1bb74fa05833cc7c14291d7043a52ca2aaa"}, {file = "fonttools-4.50.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:8844e7a2c5f7ecf977e82eb6b3014f025c8b454e046d941ece05b768be5847ae"}, {file = "fonttools-4.50.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f849bd3c5c2249b49c98eca5aaebb920d2bfd92b3c69e84ca9bddf133e9f83f0"}, {file = "fonttools-4.50.0-cp311-cp311-win32.whl", hash = "sha256:39293ff231b36b035575e81c14626dfc14407a20de5262f9596c2cbb199c3625"}, {file = "fonttools-4.50.0-cp311-cp311-win_amd64.whl", hash = "sha256:c33d5023523b44d3481624f840c8646656a1def7630ca562f222eb3ead16c438"}, {file = "fonttools-4.50.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:b4a886a6dbe60100ba1cd24de962f8cd18139bd32808da80de1fa9f9f27bf1dc"}, {file = "fonttools-4.50.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b2ca1837bfbe5eafa11313dbc7edada79052709a1fffa10cea691210af4aa1fa"}, {file = "fonttools-4.50.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0493dd97ac8977e48ffc1476b932b37c847cbb87fd68673dee5182004906828"}, {file = "fonttools-4.50.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:77844e2f1b0889120b6c222fc49b2b75c3d88b930615e98893b899b9352a27ea"}, {file = "fonttools-4.50.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:3566bfb8c55ed9100afe1ba6f0f12265cd63a1387b9661eb6031a1578a28bad1"}, {file = "fonttools-4.50.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:35e10ddbc129cf61775d58a14f2d44121178d89874d32cae1eac722e687d9019"}, {file = "fonttools-4.50.0-cp312-cp312-win32.whl", hash = "sha256:cc8140baf9fa8f9b903f2b393a6c413a220fa990264b215bf48484f3d0bf8710"}, {file = "fonttools-4.50.0-cp312-cp312-win_amd64.whl", hash = "sha256:0ccc85fd96373ab73c59833b824d7a73846670a0cb1f3afbaee2b2c426a8f931"}, {file = "fonttools-4.50.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:e270a406219af37581d96c810172001ec536e29e5593aa40d4c01cca3e145aa6"}, {file = "fonttools-4.50.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:ac2463de667233372e9e1c7e9de3d914b708437ef52a3199fdbf5a60184f190c"}, {file = "fonttools-4.50.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:47abd6669195abe87c22750dbcd366dc3a0648f1b7c93c2baa97429c4dc1506e"}, {file = "fonttools-4.50.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:074841375e2e3d559aecc86e1224caf78e8b8417bb391e7d2506412538f21adc"}, {file = "fonttools-4.50.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:0743fd2191ad7ab43d78cd747215b12033ddee24fa1e088605a3efe80d6984de"}, {file = "fonttools-4.50.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:3d7080cce7be5ed65bee3496f09f79a82865a514863197ff4d4d177389e981b0"}, {file = "fonttools-4.50.0-cp38-cp38-win32.whl", hash = "sha256:a467ba4e2eadc1d5cc1a11d355abb945f680473fbe30d15617e104c81f483045"}, {file = "fonttools-4.50.0-cp38-cp38-win_amd64.whl", hash = "sha256:f77e048f805e00870659d6318fd89ef28ca4ee16a22b4c5e1905b735495fc422"}, {file = "fonttools-4.50.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:b6245eafd553c4e9a0708e93be51392bd2288c773523892fbd616d33fd2fda59"}, {file = "fonttools-4.50.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:a4062cc7e8de26f1603323ef3ae2171c9d29c8a9f5e067d555a2813cd5c7a7e0"}, {file = "fonttools-4.50.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:34692850dfd64ba06af61e5791a441f664cb7d21e7b544e8f385718430e8f8e4"}, {file = "fonttools-4.50.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:678dd95f26a67e02c50dcb5bf250f95231d455642afbc65a3b0bcdacd4e4dd38"}, {file = "fonttools-4.50.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4f2ce7b0b295fe64ac0a85aef46a0f2614995774bd7bc643b85679c0283287f9"}, {file = "fonttools-4.50.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:d346f4dc2221bfb7ab652d1e37d327578434ce559baf7113b0f55768437fe6a0"}, {file = "fonttools-4.50.0-cp39-cp39-win32.whl", hash = "sha256:a51eeaf52ba3afd70bf489be20e52fdfafe6c03d652b02477c6ce23c995222f4"}, {file = "fonttools-4.50.0-cp39-cp39-win_amd64.whl", hash = "sha256:8639be40d583e5d9da67795aa3eeeda0488fb577a1d42ae11a5036f18fb16d93"}, {file = "fonttools-4.50.0-py3-none-any.whl", hash = "sha256:48fa36da06247aa8282766cfd63efff1bb24e55f020f29a335939ed3844d20d3"}, {file = "fonttools-4.50.0.tar.gz", hash = "sha256:fa5cf61058c7dbb104c2ac4e782bf1b2016a8cf2f69de6e4dd6a865d2c969bb5"}, ] [package.extras] all = ["brotli (>=1.0.1) ; platform_python_implementation == \"CPython\"", "brotlicffi (>=0.8.0) ; platform_python_implementation != \"CPython\"", "fs (>=2.2.0,<3)", "lxml (>=4.0)", "lz4 (>=1.7.4.2)", "matplotlib", "munkres ; platform_python_implementation == \"PyPy\"", "pycairo", "scipy ; platform_python_implementation != \"PyPy\"", "skia-pathops (>=0.5.0)", "sympy", "uharfbuzz (>=0.23.0)", "unicodedata2 (>=15.1.0) ; python_version <= \"3.12\"", "xattr ; sys_platform == \"darwin\"", "zopfli (>=0.1.4)"] graphite = ["lz4 (>=1.7.4.2)"] interpolatable = ["munkres ; platform_python_implementation == \"PyPy\"", "pycairo", "scipy ; platform_python_implementation != \"PyPy\""] lxml = ["lxml (>=4.0)"] pathops = ["skia-pathops (>=0.5.0)"] plot = ["matplotlib"] repacker = ["uharfbuzz (>=0.23.0)"] symfont = ["sympy"] type1 = ["xattr ; sys_platform == \"darwin\""] ufo = ["fs (>=2.2.0,<3)"] unicode = ["unicodedata2 (>=15.1.0) ; python_version <= \"3.12\""] woff = ["brotli (>=1.0.1) ; platform_python_implementation == \"CPython\"", "brotlicffi (>=0.8.0) ; platform_python_implementation != \"CPython\"", "zopfli (>=0.1.4)"] [[package]] name = "freeze-uuid" version = "0.3.0" description = "Python package for mocking uuid." optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "freeze-uuid-0.3.0.tar.gz", hash = "sha256:3404bb75369136c87a97f767e333ca03a7cd76b833a947f04bc05fffd3fb1aa7"}, {file = "freeze_uuid-0.3.0-py3-none-any.whl", hash = "sha256:f57ebb6d4ae16e0a30732fc69c27f677594c63c2e8cf7f9354412790bc6ff8c0"}, ] [[package]] name = "freezegun" version = "1.5.4" description = "Let your Python tests travel through time" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "freezegun-1.5.4-py3-none-any.whl", hash = "sha256:8bdd75c9d790f53d5a173d273064ccd7900984b36635be552befeedb0cd47b20"}, {file = "freezegun-1.5.4.tar.gz", hash = "sha256:798b9372fdd4d907f33e8b6a58bc64e682d9ffa8d494ce60f780197ee81faed1"}, ] [package.dependencies] python-dateutil = ">=2.7" [[package]] name = "genson" version = "1.2.2" description = "GenSON is a powerful, user-friendly JSON Schema generator." optional = false python-versions = "*" groups = ["dev"] files = [ {file = "genson-1.2.2.tar.gz", hash = "sha256:8caf69aa10af7aee0e1a1351d1d06801f4696e005f06cedef438635384346a16"}, ] [[package]] name = "gherkin-official" version = "28.0.0" description = "Gherkin parser (official, by Cucumber team)" optional = false python-versions = "*" groups = ["dev"] files = [ {file = "gherkin-official-28.0.0.tar.gz", hash = "sha256:8aecd3113b71bdace8df71980995214a5ba5a20332f419119175e63e3bacf63c"}, {file = "gherkin_official-28.0.0-py3-none-any.whl", hash = "sha256:cee60c60f55bf5fc5cc2e8fa15958c5c157b2178d1d07ffdfac46811794b791d"}, ] [[package]] name = "identify" version = "2.5.35" description = "File identification library for Python" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "identify-2.5.35-py2.py3-none-any.whl", hash = "sha256:c4de0081837b211594f8e877a6b4fad7ca32bbfc1a9307fdd61c28bfe923f13e"}, {file = "identify-2.5.35.tar.gz", hash = "sha256:10a7ca245cfcd756a554a7288159f72ff105ad233c7c4b9c6f0f4d108f5f6791"}, ] [package.extras] license = ["ukkonen"] [[package]] name = "idna" version = "3.7" description = "Internationalized Domain Names in Applications (IDNA)" optional = false python-versions = ">=3.5" groups = ["main", "dev"] files = [ {file = "idna-3.7-py3-none-any.whl", hash = "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0"}, {file = "idna-3.7.tar.gz", hash = "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc"}, ] [[package]] name = "inflect" version = "5.6.2" description = "Correctly generate plurals, singular nouns, ordinals, indefinite articles; convert numbers to words" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "inflect-5.6.2-py3-none-any.whl", hash = "sha256:b45d91a4a28a4e617ff1821117439b06eaa86e2a4573154af0149e9be6687238"}, {file = "inflect-5.6.2.tar.gz", hash = "sha256:aadc7ed73928f5e014129794bbac03058cca35d0a973a5fc4eb45c7fa26005f9"}, ] [package.extras] docs = ["jaraco.packaging (>=9)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx"] testing = ["pygments", "pytest (>=6)", "pytest-black (>=0.3.7) ; platform_python_implementation != \"PyPy\"", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-flake8", "pytest-mypy (>=0.9.1) ; platform_python_implementation != \"PyPy\""] [[package]] name = "iniconfig" version = "2.0.0" description = "brain-dead simple config-ini parsing" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, ] [[package]] name = "isort" version = "5.13.2" description = "A Python utility / library to sort Python imports." optional = false python-versions = ">=3.8.0" groups = ["dev"] files = [ {file = "isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6"}, {file = "isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109"}, ] [package.extras] colors = ["colorama (>=0.4.6)"] [[package]] name = "jinja2" version = "3.1.6" description = "A very fast and expressive template engine." optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "jinja2-3.1.6-py3-none-any.whl", hash = "sha256:85ece4451f492d0c13c5dd7c13a64681a86afae63a5f347908daf103ce6d2f67"}, {file = "jinja2-3.1.6.tar.gz", hash = "sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d"}, ] [package.dependencies] MarkupSafe = ">=2.0" [package.extras] i18n = ["Babel (>=2.7)"] [[package]] name = "jmespath" version = "1.0.1" description = "JSON Matching Expressions" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "jmespath-1.0.1-py3-none-any.whl", hash = "sha256:02e2e4cc71b5bcab88332eebf907519190dd9e6e82107fa7f83b1003a6252980"}, {file = "jmespath-1.0.1.tar.gz", hash = "sha256:90261b206d6defd58fdd5e85f478bf633a2901798906be2ad389150c5c60edbe"}, ] [[package]] name = "kiwisolver" version = "1.4.5" description = "A fast implementation of the Cassowary constraint solver" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "kiwisolver-1.4.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:05703cf211d585109fcd72207a31bb170a0f22144d68298dc5e61b3c946518af"}, {file = "kiwisolver-1.4.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:146d14bebb7f1dc4d5fbf74f8a6cb15ac42baadee8912eb84ac0b3b2a3dc6ac3"}, {file = "kiwisolver-1.4.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6ef7afcd2d281494c0a9101d5c571970708ad911d028137cd558f02b851c08b4"}, {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:9eaa8b117dc8337728e834b9c6e2611f10c79e38f65157c4c38e9400286f5cb1"}, {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ec20916e7b4cbfb1f12380e46486ec4bcbaa91a9c448b97023fde0d5bbf9e4ff"}, {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:39b42c68602539407884cf70d6a480a469b93b81b7701378ba5e2328660c847a"}, {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aa12042de0171fad672b6c59df69106d20d5596e4f87b5e8f76df757a7c399aa"}, {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2a40773c71d7ccdd3798f6489aaac9eee213d566850a9533f8d26332d626b82c"}, {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:19df6e621f6d8b4b9c4d45f40a66839294ff2bb235e64d2178f7522d9170ac5b"}, {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:83d78376d0d4fd884e2c114d0621624b73d2aba4e2788182d286309ebdeed770"}, {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:e391b1f0a8a5a10ab3b9bb6afcfd74f2175f24f8975fb87ecae700d1503cdee0"}, {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:852542f9481f4a62dbb5dd99e8ab7aedfeb8fb6342349a181d4036877410f525"}, {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:59edc41b24031bc25108e210c0def6f6c2191210492a972d585a06ff246bb79b"}, {file = "kiwisolver-1.4.5-cp310-cp310-win32.whl", hash = "sha256:a6aa6315319a052b4ee378aa171959c898a6183f15c1e541821c5c59beaa0238"}, {file = "kiwisolver-1.4.5-cp310-cp310-win_amd64.whl", hash = "sha256:d0ef46024e6a3d79c01ff13801cb19d0cad7fd859b15037aec74315540acc276"}, {file = "kiwisolver-1.4.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:11863aa14a51fd6ec28688d76f1735f8f69ab1fabf388851a595d0721af042f5"}, {file = "kiwisolver-1.4.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:8ab3919a9997ab7ef2fbbed0cc99bb28d3c13e6d4b1ad36e97e482558a91be90"}, {file = "kiwisolver-1.4.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:fcc700eadbbccbf6bc1bcb9dbe0786b4b1cb91ca0dcda336eef5c2beed37b797"}, {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dfdd7c0b105af050eb3d64997809dc21da247cf44e63dc73ff0fd20b96be55a9"}, {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:76c6a5964640638cdeaa0c359382e5703e9293030fe730018ca06bc2010c4437"}, {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bbea0db94288e29afcc4c28afbf3a7ccaf2d7e027489c449cf7e8f83c6346eb9"}, {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ceec1a6bc6cab1d6ff5d06592a91a692f90ec7505d6463a88a52cc0eb58545da"}, {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:040c1aebeda72197ef477a906782b5ab0d387642e93bda547336b8957c61022e"}, {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:f91de7223d4c7b793867797bacd1ee53bfe7359bd70d27b7b58a04efbb9436c8"}, {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:faae4860798c31530dd184046a900e652c95513796ef51a12bc086710c2eec4d"}, {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:b0157420efcb803e71d1b28e2c287518b8808b7cf1ab8af36718fd0a2c453eb0"}, {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:06f54715b7737c2fecdbf140d1afb11a33d59508a47bf11bb38ecf21dc9ab79f"}, {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:fdb7adb641a0d13bdcd4ef48e062363d8a9ad4a182ac7647ec88f695e719ae9f"}, {file = "kiwisolver-1.4.5-cp311-cp311-win32.whl", hash = "sha256:bb86433b1cfe686da83ce32a9d3a8dd308e85c76b60896d58f082136f10bffac"}, {file = "kiwisolver-1.4.5-cp311-cp311-win_amd64.whl", hash = "sha256:6c08e1312a9cf1074d17b17728d3dfce2a5125b2d791527f33ffbe805200a355"}, {file = "kiwisolver-1.4.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:32d5cf40c4f7c7b3ca500f8985eb3fb3a7dfc023215e876f207956b5ea26632a"}, {file = "kiwisolver-1.4.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f846c260f483d1fd217fe5ed7c173fb109efa6b1fc8381c8b7552c5781756192"}, {file = "kiwisolver-1.4.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5ff5cf3571589b6d13bfbfd6bcd7a3f659e42f96b5fd1c4830c4cf21d4f5ef45"}, {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7269d9e5f1084a653d575c7ec012ff57f0c042258bf5db0954bf551c158466e7"}, {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:da802a19d6e15dffe4b0c24b38b3af68e6c1a68e6e1d8f30148c83864f3881db"}, {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3aba7311af82e335dd1e36ffff68aaca609ca6290c2cb6d821a39aa075d8e3ff"}, {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:763773d53f07244148ccac5b084da5adb90bfaee39c197554f01b286cf869228"}, {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2270953c0d8cdab5d422bee7d2007f043473f9d2999631c86a223c9db56cbd16"}, {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d099e745a512f7e3bbe7249ca835f4d357c586d78d79ae8f1dcd4d8adeb9bda9"}, {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:74db36e14a7d1ce0986fa104f7d5637aea5c82ca6326ed0ec5694280942d1162"}, {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:7e5bab140c309cb3a6ce373a9e71eb7e4873c70c2dda01df6820474f9889d6d4"}, {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:0f114aa76dc1b8f636d077979c0ac22e7cd8f3493abbab152f20eb8d3cda71f3"}, {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:88a2df29d4724b9237fc0c6eaf2a1adae0cdc0b3e9f4d8e7dc54b16812d2d81a"}, {file = "kiwisolver-1.4.5-cp312-cp312-win32.whl", hash = "sha256:72d40b33e834371fd330fb1472ca19d9b8327acb79a5821d4008391db8e29f20"}, {file = "kiwisolver-1.4.5-cp312-cp312-win_amd64.whl", hash = "sha256:2c5674c4e74d939b9d91dda0fae10597ac7521768fec9e399c70a1f27e2ea2d9"}, {file = "kiwisolver-1.4.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:3a2b053a0ab7a3960c98725cfb0bf5b48ba82f64ec95fe06f1d06c99b552e130"}, {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3cd32d6c13807e5c66a7cbb79f90b553642f296ae4518a60d8d76243b0ad2898"}, {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:59ec7b7c7e1a61061850d53aaf8e93db63dce0c936db1fda2658b70e4a1be709"}, {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:da4cfb373035def307905d05041c1d06d8936452fe89d464743ae7fb8371078b"}, {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2400873bccc260b6ae184b2b8a4fec0e4082d30648eadb7c3d9a13405d861e89"}, {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:1b04139c4236a0f3aff534479b58f6f849a8b351e1314826c2d230849ed48985"}, {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:4e66e81a5779b65ac21764c295087de82235597a2293d18d943f8e9e32746265"}, {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:7931d8f1f67c4be9ba1dd9c451fb0eeca1a25b89e4d3f89e828fe12a519b782a"}, {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:b3f7e75f3015df442238cca659f8baa5f42ce2a8582727981cbfa15fee0ee205"}, {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:bbf1d63eef84b2e8c89011b7f2235b1e0bf7dacc11cac9431fc6468e99ac77fb"}, {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:4c380469bd3f970ef677bf2bcba2b6b0b4d5c75e7a020fb863ef75084efad66f"}, {file = "kiwisolver-1.4.5-cp37-cp37m-win32.whl", hash = "sha256:9408acf3270c4b6baad483865191e3e582b638b1654a007c62e3efe96f09a9a3"}, {file = "kiwisolver-1.4.5-cp37-cp37m-win_amd64.whl", hash = "sha256:5b94529f9b2591b7af5f3e0e730a4e0a41ea174af35a4fd067775f9bdfeee01a"}, {file = "kiwisolver-1.4.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:11c7de8f692fc99816e8ac50d1d1aef4f75126eefc33ac79aac02c099fd3db71"}, {file = "kiwisolver-1.4.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:53abb58632235cd154176ced1ae8f0d29a6657aa1aa9decf50b899b755bc2b93"}, {file = "kiwisolver-1.4.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:88b9f257ca61b838b6f8094a62418421f87ac2a1069f7e896c36a7d86b5d4c29"}, {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3195782b26fc03aa9c6913d5bad5aeb864bdc372924c093b0f1cebad603dd712"}, {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fc579bf0f502e54926519451b920e875f433aceb4624a3646b3252b5caa9e0b6"}, {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5a580c91d686376f0f7c295357595c5a026e6cbc3d77b7c36e290201e7c11ecb"}, {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:cfe6ab8da05c01ba6fbea630377b5da2cd9bcbc6338510116b01c1bc939a2c18"}, {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:d2e5a98f0ec99beb3c10e13b387f8db39106d53993f498b295f0c914328b1333"}, {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:a51a263952b1429e429ff236d2f5a21c5125437861baeed77f5e1cc2d2c7c6da"}, {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:3edd2fa14e68c9be82c5b16689e8d63d89fe927e56debd6e1dbce7a26a17f81b"}, {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:74d1b44c6cfc897df648cc9fdaa09bc3e7679926e6f96df05775d4fb3946571c"}, {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:76d9289ed3f7501012e05abb8358bbb129149dbd173f1f57a1bf1c22d19ab7cc"}, {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:92dea1ffe3714fa8eb6a314d2b3c773208d865a0e0d35e713ec54eea08a66250"}, {file = "kiwisolver-1.4.5-cp38-cp38-win32.whl", hash = "sha256:5c90ae8c8d32e472be041e76f9d2f2dbff4d0b0be8bd4041770eddb18cf49a4e"}, {file = "kiwisolver-1.4.5-cp38-cp38-win_amd64.whl", hash = "sha256:c7940c1dc63eb37a67721b10d703247552416f719c4188c54e04334321351ced"}, {file = "kiwisolver-1.4.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:9407b6a5f0d675e8a827ad8742e1d6b49d9c1a1da5d952a67d50ef5f4170b18d"}, {file = "kiwisolver-1.4.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:15568384086b6df3c65353820a4473575dbad192e35010f622c6ce3eebd57af9"}, {file = "kiwisolver-1.4.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0dc9db8e79f0036e8173c466d21ef18e1befc02de8bf8aa8dc0813a6dc8a7046"}, {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:cdc8a402aaee9a798b50d8b827d7ecf75edc5fb35ea0f91f213ff927c15f4ff0"}, {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:6c3bd3cde54cafb87d74d8db50b909705c62b17c2099b8f2e25b461882e544ff"}, {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:955e8513d07a283056b1396e9a57ceddbd272d9252c14f154d450d227606eb54"}, {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:346f5343b9e3f00b8db8ba359350eb124b98c99efd0b408728ac6ebf38173958"}, {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b9098e0049e88c6a24ff64545cdfc50807818ba6c1b739cae221bbbcbc58aad3"}, {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:00bd361b903dc4bbf4eb165f24d1acbee754fce22ded24c3d56eec268658a5cf"}, {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7b8b454bac16428b22560d0a1cf0a09875339cab69df61d7805bf48919415901"}, {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:f1d072c2eb0ad60d4c183f3fb44ac6f73fb7a8f16a2694a91f988275cbf352f9"}, {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:31a82d498054cac9f6d0b53d02bb85811185bcb477d4b60144f915f3b3126342"}, {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:6512cb89e334e4700febbffaaa52761b65b4f5a3cf33f960213d5656cea36a77"}, {file = "kiwisolver-1.4.5-cp39-cp39-win32.whl", hash = "sha256:9db8ea4c388fdb0f780fe91346fd438657ea602d58348753d9fb265ce1bca67f"}, {file = "kiwisolver-1.4.5-cp39-cp39-win_amd64.whl", hash = "sha256:59415f46a37f7f2efeec758353dd2eae1b07640d8ca0f0c42548ec4125492635"}, {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:5c7b3b3a728dc6faf3fc372ef24f21d1e3cee2ac3e9596691d746e5a536de920"}, {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:620ced262a86244e2be10a676b646f29c34537d0d9cc8eb26c08f53d98013390"}, {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:378a214a1e3bbf5ac4a8708304318b4f890da88c9e6a07699c4ae7174c09a68d"}, {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:aaf7be1207676ac608a50cd08f102f6742dbfc70e8d60c4db1c6897f62f71523"}, {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:ba55dce0a9b8ff59495ddd050a0225d58bd0983d09f87cfe2b6aec4f2c1234e4"}, {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:fd32ea360bcbb92d28933fc05ed09bffcb1704ba3fc7942e81db0fd4f81a7892"}, {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5e7139af55d1688f8b960ee9ad5adafc4ac17c1c473fe07133ac092310d76544"}, {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:dced8146011d2bc2e883f9bd68618b8247387f4bbec46d7392b3c3b032640126"}, {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c9bf3325c47b11b2e51bca0824ea217c7cd84491d8ac4eefd1e409705ef092bd"}, {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:5794cf59533bc3f1b1c821f7206a3617999db9fbefc345360aafe2e067514929"}, {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e368f200bbc2e4f905b8e71eb38b3c04333bddaa6a2464a6355487b02bb7fb09"}, {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e5d706eba36b4c4d5bc6c6377bb6568098765e990cfc21ee16d13963fab7b3e7"}, {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85267bd1aa8880a9c88a8cb71e18d3d64d2751a790e6ca6c27b8ccc724bcd5ad"}, {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:210ef2c3a1f03272649aff1ef992df2e724748918c4bc2d5a90352849eb40bea"}, {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:11d011a7574eb3b82bcc9c1a1d35c1d7075677fdd15de527d91b46bd35e935ee"}, {file = "kiwisolver-1.4.5.tar.gz", hash = "sha256:e57e563a57fb22a142da34f38acc2fc1a5c864bc29ca1517a88abc963e60d6ec"}, ] [[package]] name = "layers" version = "0.1.0" description = "" optional = false python-versions = "^3.12" groups = ["dev"] files = [] develop = true [package.source] type = "directory" url = "layer" [[package]] name = "markupsafe" version = "2.1.5" description = "Safely add untrusted strings to HTML/XML markup." optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"}, {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"}, {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"}, {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"}, {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"}, {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"}, {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"}, {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"}, {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"}, {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"}, {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"}, {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"}, {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"}, {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"}, {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"}, {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"}, {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"}, {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"}, {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"}, {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"}, {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"}, {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"}, {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"}, {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"}, {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"}, {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"}, {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"}, {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"}, {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"}, {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"}, {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"}, {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"}, {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"}, {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"}, {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"}, {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"}, {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"}, {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"}, {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"}, {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"}, {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"}, {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"}, {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"}, {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"}, {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"}, {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"}, {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"}, {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"}, {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"}, {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"}, {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"}, {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"}, ] [[package]] name = "matplotlib" version = "3.8.4" description = "Python plotting package" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "matplotlib-3.8.4-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:abc9d838f93583650c35eca41cfcec65b2e7cb50fd486da6f0c49b5e1ed23014"}, {file = "matplotlib-3.8.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8f65c9f002d281a6e904976007b2d46a1ee2bcea3a68a8c12dda24709ddc9106"}, {file = "matplotlib-3.8.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ce1edd9f5383b504dbc26eeea404ed0a00656c526638129028b758fd43fc5f10"}, {file = "matplotlib-3.8.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ecd79298550cba13a43c340581a3ec9c707bd895a6a061a78fa2524660482fc0"}, {file = "matplotlib-3.8.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:90df07db7b599fe7035d2f74ab7e438b656528c68ba6bb59b7dc46af39ee48ef"}, {file = "matplotlib-3.8.4-cp310-cp310-win_amd64.whl", hash = "sha256:ac24233e8f2939ac4fd2919eed1e9c0871eac8057666070e94cbf0b33dd9c338"}, {file = "matplotlib-3.8.4-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:72f9322712e4562e792b2961971891b9fbbb0e525011e09ea0d1f416c4645661"}, {file = "matplotlib-3.8.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:232ce322bfd020a434caaffbd9a95333f7c2491e59cfc014041d95e38ab90d1c"}, {file = "matplotlib-3.8.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6addbd5b488aedb7f9bc19f91cd87ea476206f45d7116fcfe3d31416702a82fa"}, {file = "matplotlib-3.8.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cc4ccdc64e3039fc303defd119658148f2349239871db72cd74e2eeaa9b80b71"}, {file = "matplotlib-3.8.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:b7a2a253d3b36d90c8993b4620183b55665a429da8357a4f621e78cd48b2b30b"}, {file = "matplotlib-3.8.4-cp311-cp311-win_amd64.whl", hash = "sha256:8080d5081a86e690d7688ffa542532e87f224c38a6ed71f8fbed34dd1d9fedae"}, {file = "matplotlib-3.8.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:6485ac1f2e84676cff22e693eaa4fbed50ef5dc37173ce1f023daef4687df616"}, {file = "matplotlib-3.8.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:c89ee9314ef48c72fe92ce55c4e95f2f39d70208f9f1d9db4e64079420d8d732"}, {file = "matplotlib-3.8.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:50bac6e4d77e4262c4340d7a985c30912054745ec99756ce213bfbc3cb3808eb"}, {file = "matplotlib-3.8.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f51c4c869d4b60d769f7b4406eec39596648d9d70246428745a681c327a8ad30"}, {file = "matplotlib-3.8.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:b12ba985837e4899b762b81f5b2845bd1a28f4fdd1a126d9ace64e9c4eb2fb25"}, {file = "matplotlib-3.8.4-cp312-cp312-win_amd64.whl", hash = "sha256:7a6769f58ce51791b4cb8b4d7642489df347697cd3e23d88266aaaee93b41d9a"}, {file = "matplotlib-3.8.4-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:843cbde2f0946dadd8c5c11c6d91847abd18ec76859dc319362a0964493f0ba6"}, {file = "matplotlib-3.8.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:1c13f041a7178f9780fb61cc3a2b10423d5e125480e4be51beaf62b172413b67"}, {file = "matplotlib-3.8.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb44f53af0a62dc80bba4443d9b27f2fde6acfdac281d95bc872dc148a6509cc"}, {file = "matplotlib-3.8.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:606e3b90897554c989b1e38a258c626d46c873523de432b1462f295db13de6f9"}, {file = "matplotlib-3.8.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:9bb0189011785ea794ee827b68777db3ca3f93f3e339ea4d920315a0e5a78d54"}, {file = "matplotlib-3.8.4-cp39-cp39-win_amd64.whl", hash = "sha256:6209e5c9aaccc056e63b547a8152661324404dd92340a6e479b3a7f24b42a5d0"}, {file = "matplotlib-3.8.4-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:c7064120a59ce6f64103c9cefba8ffe6fba87f2c61d67c401186423c9a20fd35"}, {file = "matplotlib-3.8.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a0e47eda4eb2614300fc7bb4657fced3e83d6334d03da2173b09e447418d499f"}, {file = "matplotlib-3.8.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:493e9f6aa5819156b58fce42b296ea31969f2aab71c5b680b4ea7a3cb5c07d94"}, {file = "matplotlib-3.8.4.tar.gz", hash = "sha256:8aac397d5e9ec158960e31c381c5ffc52ddd52bd9a47717e2a694038167dffea"}, ] [package.dependencies] contourpy = ">=1.0.1" cycler = ">=0.10" fonttools = ">=4.22.0" kiwisolver = ">=1.3.1" numpy = ">=1.21" packaging = ">=20.0" pillow = ">=8" pyparsing = ">=2.3.1" python-dateutil = ">=2.7" [[package]] name = "moto" version = "5.1.9" description = "A library that allows you to easily mock out tests based on AWS infrastructure" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "moto-5.1.9-py3-none-any.whl", hash = "sha256:e9ba7e4764a6088ccc34e3cc846ae719861ca202409fa865573de40a3e805b9b"}, {file = "moto-5.1.9.tar.gz", hash = "sha256:0c4f0387b06b5d24c0ce90f8f89f31a565cc05789189c5d59b5df02594f2e371"}, ] [package.dependencies] boto3 = ">=1.9.201" botocore = ">=1.20.88,<1.35.45 || >1.35.45,<1.35.46 || >1.35.46" cryptography = ">=35.0.0" docker = {version = ">=3.0.0", optional = true, markers = "extra == \"dynamodb\""} Jinja2 = ">=2.10.1" py-partiql-parser = {version = "0.6.1", optional = true, markers = "extra == \"dynamodb\" or extra == \"s3\""} python-dateutil = ">=2.1,<3.0.0" PyYAML = {version = ">=5.1", optional = true, markers = "extra == \"s3\""} requests = ">=2.5" responses = ">=0.15.0,<0.25.5 || >0.25.5" werkzeug = ">=0.5,<2.2.0 || >2.2.0,<2.2.1 || >2.2.1" xmltodict = "*" [package.extras] all = ["PyYAML (>=5.1)", "antlr4-python3-runtime", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "graphql-core", "joserfc (>=0.9.0)", "jsonpath_ng", "jsonschema", "multipart", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.6.1)", "pyparsing (>=3.0.7)", "setuptools"] apigateway = ["PyYAML (>=5.1)", "joserfc (>=0.9.0)", "openapi-spec-validator (>=0.5.0)"] apigatewayv2 = ["PyYAML (>=5.1)", "openapi-spec-validator (>=0.5.0)"] appsync = ["graphql-core"] awslambda = ["docker (>=3.0.0)"] batch = ["docker (>=3.0.0)"] cloudformation = ["PyYAML (>=5.1)", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "graphql-core", "joserfc (>=0.9.0)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.6.1)", "pyparsing (>=3.0.7)", "setuptools"] cognitoidp = ["joserfc (>=0.9.0)"] dynamodb = ["docker (>=3.0.0)", "py-partiql-parser (==0.6.1)"] dynamodbstreams = ["docker (>=3.0.0)", "py-partiql-parser (==0.6.1)"] events = ["jsonpath_ng"] glue = ["pyparsing (>=3.0.7)"] proxy = ["PyYAML (>=5.1)", "antlr4-python3-runtime", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=2.5.1)", "graphql-core", "joserfc (>=0.9.0)", "jsonpath_ng", "multipart", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.6.1)", "pyparsing (>=3.0.7)", "setuptools"] quicksight = ["jsonschema"] resourcegroupstaggingapi = ["PyYAML (>=5.1)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "graphql-core", "joserfc (>=0.9.0)", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.6.1)", "pyparsing (>=3.0.7)"] s3 = ["PyYAML (>=5.1)", "py-partiql-parser (==0.6.1)"] s3crc32c = ["PyYAML (>=5.1)", "crc32c", "py-partiql-parser (==0.6.1)"] server = ["PyYAML (>=5.1)", "antlr4-python3-runtime", "aws-xray-sdk (>=0.93,!=0.96)", "cfn-lint (>=0.40.0)", "docker (>=3.0.0)", "flask (!=2.2.0,!=2.2.1)", "flask-cors", "graphql-core", "joserfc (>=0.9.0)", "jsonpath_ng", "openapi-spec-validator (>=0.5.0)", "py-partiql-parser (==0.6.1)", "pyparsing (>=3.0.7)", "setuptools"] ssm = ["PyYAML (>=5.1)"] stepfunctions = ["antlr4-python3-runtime", "jsonpath_ng"] xray = ["aws-xray-sdk (>=0.93,!=0.96)", "setuptools"] [[package]] name = "mypy-boto3-dynamodb" version = "1.40.56" description = "Type annotations for boto3 DynamoDB 1.40.56 service generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "mypy_boto3_dynamodb-1.40.56-py3-none-any.whl", hash = "sha256:3bf3f541a0d21c249109dd65f18c61b3e6a0fe7124b3afe989877d5cca42b65a"}, {file = "mypy_boto3_dynamodb-1.40.56.tar.gz", hash = "sha256:576dd12fe1125754066e7fa480f92c123220970a9d69f7663a56d701f2978ac5"}, ] [[package]] name = "mypy-boto3-firehose" version = "1.40.0" description = "Type annotations for boto3 Firehose 1.40.0 service generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "mypy_boto3_firehose-1.40.0-py3-none-any.whl", hash = "sha256:0a16dc2e4b66dbc8c918332914eae1f8695ac6412838bb55d04f6558f419205e"}, {file = "mypy_boto3_firehose-1.40.0.tar.gz", hash = "sha256:673a7b5683da5481d7dca71cc651482deb063493fb7f5a7adee5cbc0ddeb2dcb"}, ] [[package]] name = "mypy-boto3-kinesis" version = "1.40.0" description = "Type annotations for boto3 Kinesis 1.40.0 service generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "mypy_boto3_kinesis-1.40.0-py3-none-any.whl", hash = "sha256:5edd790730bdeca17c5287acbec04d8930b6adf34dc4f48854330f7092484984"}, {file = "mypy_boto3_kinesis-1.40.0.tar.gz", hash = "sha256:4f74f715e23a8dce062b40f6a4f2ff1023cec6f41b4521f0bc15679883a7e68e"}, ] [[package]] name = "mypy-boto3-lambda" version = "1.40.58" description = "Type annotations for boto3 Lambda 1.40.58 service generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "mypy_boto3_lambda-1.40.58-py3-none-any.whl", hash = "sha256:61a1cb3654122dc9a557509606721ea78247b4e450e98c2b849f5ae0f9a9a652"}, {file = "mypy_boto3_lambda-1.40.58.tar.gz", hash = "sha256:fe1002d770e115c7853ec497768b18da528efd384497207fc5e83257e4fd8573"}, ] [[package]] name = "mypy-boto3-rds" version = "1.40.50" description = "Type annotations for boto3 RDS 1.40.50 service generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "mypy_boto3_rds-1.40.50-py3-none-any.whl", hash = "sha256:455f6636ac63c4c94aaeaa9376529cc39c0532fb9bcd511c646a0ef4b001d788"}, {file = "mypy_boto3_rds-1.40.50.tar.gz", hash = "sha256:7d5506bf7eab2b59266f93261049c2ac25c460f7e09f583abb86980699c3bed5"}, ] [[package]] name = "mypy-boto3-s3" version = "1.40.26" description = "Type annotations for boto3 S3 1.40.26 service generated with mypy-boto3-builder 8.11.0" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "mypy_boto3_s3-1.40.26-py3-none-any.whl", hash = "sha256:6d055d16ef89a0133ade92f6b4f09603e4acc31a0f5e8f846edf4eb48f17b5a7"}, {file = "mypy_boto3_s3-1.40.26.tar.gz", hash = "sha256:8d2bfd1052894d0e84c9fb9358d838ba0eed0265076c7dd7f45622c770275c99"}, ] [[package]] name = "mypy-extensions" version = "1.0.0" description = "Type system extensions for programs checked with the mypy type checker." optional = false python-versions = ">=3.5" groups = ["dev"] files = [ {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, ] [[package]] name = "nhs-number" version = "1.3.4" description = "Python package to provide utilities for NHS Numbers, including validity checks, normalisation, and generation." optional = false python-versions = ">=3.7,<4.0" groups = ["main"] files = [ {file = "nhs_number-1.3.4-py3-none-any.whl", hash = "sha256:254b31ffe85ae2290c9325442fb4427c3839f46a049408bb1c1e9c9f36e0c39b"}, {file = "nhs_number-1.3.4.tar.gz", hash = "sha256:be2bb644aead15a3d7b577d48717d599b85469a101f105efd6effbad1bf70217"}, ] [[package]] name = "nodeenv" version = "1.8.0" description = "Node.js virtual environment builder" optional = false python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*" groups = ["dev"] files = [ {file = "nodeenv-1.8.0-py2.py3-none-any.whl", hash = "sha256:df865724bb3c3adc86b3876fa209771517b0cfe596beff01a92700e0e8be4cec"}, {file = "nodeenv-1.8.0.tar.gz", hash = "sha256:d51e0c37e64fbf47d017feac3145cdbb58836d7eee8c6f6d3b6880c5456227d2"}, ] [package.dependencies] setuptools = "*" [[package]] name = "nrlf-converter" version = "0.0.9" description = "NHS Clinicals Record Locator Document Pointer to HL7 FHIR R4 DocumentReference conversion" optional = false python-versions = ">=3.8,<4.0" groups = ["dev"] files = [ {file = "nrlf_converter-0.0.9-py3-none-any.whl", hash = "sha256:3d525df8507cd517ee5638d880973f650e960afd22be4f33b97ba2f17c5c3a56"}, ] [package.source] type = "url" url = "https://github.com/NHSDigital/nrlf-converter/releases/download/0.0.9/nrlf_converter-0.0.9-py3-none-any.whl" [[package]] name = "numpy" version = "1.26.4" description = "Fundamental package for array computing in Python" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "numpy-1.26.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:9ff0f4f29c51e2803569d7a51c2304de5554655a60c5d776e35b4a41413830d0"}, {file = "numpy-1.26.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2e4ee3380d6de9c9ec04745830fd9e2eccb3e6cf790d39d7b98ffd19b0dd754a"}, {file = "numpy-1.26.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d209d8969599b27ad20994c8e41936ee0964e6da07478d6c35016bc386b66ad4"}, {file = "numpy-1.26.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ffa75af20b44f8dba823498024771d5ac50620e6915abac414251bd971b4529f"}, {file = "numpy-1.26.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:62b8e4b1e28009ef2846b4c7852046736bab361f7aeadeb6a5b89ebec3c7055a"}, {file = "numpy-1.26.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a4abb4f9001ad2858e7ac189089c42178fcce737e4169dc61321660f1a96c7d2"}, {file = "numpy-1.26.4-cp310-cp310-win32.whl", hash = "sha256:bfe25acf8b437eb2a8b2d49d443800a5f18508cd811fea3181723922a8a82b07"}, {file = "numpy-1.26.4-cp310-cp310-win_amd64.whl", hash = "sha256:b97fe8060236edf3662adfc2c633f56a08ae30560c56310562cb4f95500022d5"}, {file = "numpy-1.26.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4c66707fabe114439db9068ee468c26bbdf909cac0fb58686a42a24de1760c71"}, {file = "numpy-1.26.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:edd8b5fe47dab091176d21bb6de568acdd906d1887a4584a15a9a96a1dca06ef"}, {file = "numpy-1.26.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7ab55401287bfec946ced39700c053796e7cc0e3acbef09993a9ad2adba6ca6e"}, {file = "numpy-1.26.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:666dbfb6ec68962c033a450943ded891bed2d54e6755e35e5835d63f4f6931d5"}, {file = "numpy-1.26.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:96ff0b2ad353d8f990b63294c8986f1ec3cb19d749234014f4e7eb0112ceba5a"}, {file = "numpy-1.26.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:60dedbb91afcbfdc9bc0b1f3f402804070deed7392c23eb7a7f07fa857868e8a"}, {file = "numpy-1.26.4-cp311-cp311-win32.whl", hash = "sha256:1af303d6b2210eb850fcf03064d364652b7120803a0b872f5211f5234b399f20"}, {file = "numpy-1.26.4-cp311-cp311-win_amd64.whl", hash = "sha256:cd25bcecc4974d09257ffcd1f098ee778f7834c3ad767fe5db785be9a4aa9cb2"}, {file = "numpy-1.26.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b3ce300f3644fb06443ee2222c2201dd3a89ea6040541412b8fa189341847218"}, {file = "numpy-1.26.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:03a8c78d01d9781b28a6989f6fa1bb2c4f2d51201cf99d3dd875df6fbd96b23b"}, {file = "numpy-1.26.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9fad7dcb1aac3c7f0584a5a8133e3a43eeb2fe127f47e3632d43d677c66c102b"}, {file = "numpy-1.26.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:675d61ffbfa78604709862923189bad94014bef562cc35cf61d3a07bba02a7ed"}, {file = "numpy-1.26.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:ab47dbe5cc8210f55aa58e4805fe224dac469cde56b9f731a4c098b91917159a"}, {file = "numpy-1.26.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:1dda2e7b4ec9dd512f84935c5f126c8bd8b9f2fc001e9f54af255e8c5f16b0e0"}, {file = "numpy-1.26.4-cp312-cp312-win32.whl", hash = "sha256:50193e430acfc1346175fcbdaa28ffec49947a06918b7b92130744e81e640110"}, {file = "numpy-1.26.4-cp312-cp312-win_amd64.whl", hash = "sha256:08beddf13648eb95f8d867350f6a018a4be2e5ad54c8d8caed89ebca558b2818"}, {file = "numpy-1.26.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:7349ab0fa0c429c82442a27a9673fc802ffdb7c7775fad780226cb234965e53c"}, {file = "numpy-1.26.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:52b8b60467cd7dd1e9ed082188b4e6bb35aa5cdd01777621a1658910745b90be"}, {file = "numpy-1.26.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d5241e0a80d808d70546c697135da2c613f30e28251ff8307eb72ba696945764"}, {file = "numpy-1.26.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f870204a840a60da0b12273ef34f7051e98c3b5961b61b0c2c1be6dfd64fbcd3"}, {file = "numpy-1.26.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:679b0076f67ecc0138fd2ede3a8fd196dddc2ad3254069bcb9faf9a79b1cebcd"}, {file = "numpy-1.26.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:47711010ad8555514b434df65f7d7b076bb8261df1ca9bb78f53d3b2db02e95c"}, {file = "numpy-1.26.4-cp39-cp39-win32.whl", hash = "sha256:a354325ee03388678242a4d7ebcd08b5c727033fcff3b2f536aea978e15ee9e6"}, {file = "numpy-1.26.4-cp39-cp39-win_amd64.whl", hash = "sha256:3373d5d70a5fe74a2c1bb6d2cfd9609ecf686d47a2d7b1d37a8f3b6bf6003aea"}, {file = "numpy-1.26.4-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:afedb719a9dcfc7eaf2287b839d8198e06dcd4cb5d276a3df279231138e83d30"}, {file = "numpy-1.26.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95a7476c59002f2f6c590b9b7b998306fba6a5aa646b1e22ddfeaf8f78c3a29c"}, {file = "numpy-1.26.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7e50d0a0cc3189f9cb0aeb3a6a6af18c16f59f004b866cd2be1c14b36134a4a0"}, {file = "numpy-1.26.4.tar.gz", hash = "sha256:2a02aba9ed12e4ac4eb3ea9421c420301a0c6460d9830d74a9df87efa4912010"}, ] [[package]] name = "packaging" version = "24.0" description = "Core utilities for Python packages" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "packaging-24.0-py3-none-any.whl", hash = "sha256:2ddfb553fdf02fb784c234c7ba6ccc288296ceabec964ad2eae3777778130bc5"}, {file = "packaging-24.0.tar.gz", hash = "sha256:eb82c5e3e56209074766e6885bb04b8c38a0c015d0a30036ebe7ece34c9989e9"}, ] [[package]] name = "parse" version = "1.20.1" description = "parse() is the opposite of format()" optional = false python-versions = "*" groups = ["dev"] files = [ {file = "parse-1.20.1-py2.py3-none-any.whl", hash = "sha256:76ddd5214255ae711db4c512be636151fbabaa948c6f30115aecc440422ca82c"}, {file = "parse-1.20.1.tar.gz", hash = "sha256:09002ca350ad42e76629995f71f7b518670bcf93548bdde3684fd55d2be51975"}, ] [[package]] name = "parse-type" version = "0.6.2" description = "Simplifies to build parse types based on the parse module" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*" groups = ["dev"] files = [ {file = "parse_type-0.6.2-py2.py3-none-any.whl", hash = "sha256:06d39a8b70fde873eb2a131141a0e79bb34a432941fb3d66fad247abafc9766c"}, {file = "parse_type-0.6.2.tar.gz", hash = "sha256:79b1f2497060d0928bc46016793f1fca1057c4aacdf15ef876aa48d75a73a355"}, ] [package.dependencies] parse = {version = ">=1.18.0", markers = "python_version >= \"3.0\""} six = ">=1.15" [package.extras] develop = ["build (>=0.5.1)", "coverage (>=4.4)", "pylint", "pytest (<5.0) ; python_version < \"3.0\"", "pytest (>=5.0) ; python_version >= \"3.0\"", "pytest-cov", "pytest-html (>=1.19.0)", "ruff ; python_version >= \"3.7\"", "tox (>=2.8,<4.0)", "twine (>=1.13.0)", "virtualenv (<20.22.0) ; python_version <= \"3.6\"", "virtualenv (>=20.0.0) ; python_version > \"3.6\""] docs = ["Sphinx (>=1.6)", "sphinx-bootstrap-theme (>=0.6.0)"] testing = ["pytest (<5.0) ; python_version < \"3.0\"", "pytest (>=5.0) ; python_version >= \"3.0\"", "pytest-html (>=1.19.0)"] [[package]] name = "pathspec" version = "0.12.1" description = "Utility library for gitignore style pattern matching of file paths." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08"}, {file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"}, ] [[package]] name = "pillow" version = "10.3.0" description = "Python Imaging Library (Fork)" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "pillow-10.3.0-cp310-cp310-macosx_10_10_x86_64.whl", hash = "sha256:90b9e29824800e90c84e4022dd5cc16eb2d9605ee13f05d47641eb183cd73d45"}, {file = "pillow-10.3.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:a2c405445c79c3f5a124573a051062300936b0281fee57637e706453e452746c"}, {file = "pillow-10.3.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:78618cdbccaa74d3f88d0ad6cb8ac3007f1a6fa5c6f19af64b55ca170bfa1edf"}, {file = "pillow-10.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:261ddb7ca91fcf71757979534fb4c128448b5b4c55cb6152d280312062f69599"}, {file = "pillow-10.3.0-cp310-cp310-manylinux_2_28_aarch64.whl", hash = "sha256:ce49c67f4ea0609933d01c0731b34b8695a7a748d6c8d186f95e7d085d2fe475"}, {file = "pillow-10.3.0-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:b14f16f94cbc61215115b9b1236f9c18403c15dd3c52cf629072afa9d54c1cbf"}, {file = "pillow-10.3.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:d33891be6df59d93df4d846640f0e46f1a807339f09e79a8040bc887bdcd7ed3"}, {file = "pillow-10.3.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b50811d664d392f02f7761621303eba9d1b056fb1868c8cdf4231279645c25f5"}, {file = "pillow-10.3.0-cp310-cp310-win32.whl", hash = "sha256:ca2870d5d10d8726a27396d3ca4cf7976cec0f3cb706debe88e3a5bd4610f7d2"}, {file = "pillow-10.3.0-cp310-cp310-win_amd64.whl", hash = "sha256:f0d0591a0aeaefdaf9a5e545e7485f89910c977087e7de2b6c388aec32011e9f"}, {file = "pillow-10.3.0-cp310-cp310-win_arm64.whl", hash = "sha256:ccce24b7ad89adb5a1e34a6ba96ac2530046763912806ad4c247356a8f33a67b"}, {file = "pillow-10.3.0-cp311-cp311-macosx_10_10_x86_64.whl", hash = "sha256:5f77cf66e96ae734717d341c145c5949c63180842a545c47a0ce7ae52ca83795"}, {file = "pillow-10.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e4b878386c4bf293578b48fc570b84ecfe477d3b77ba39a6e87150af77f40c57"}, {file = "pillow-10.3.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fdcbb4068117dfd9ce0138d068ac512843c52295ed996ae6dd1faf537b6dbc27"}, {file = "pillow-10.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9797a6c8fe16f25749b371c02e2ade0efb51155e767a971c61734b1bf6293994"}, {file = "pillow-10.3.0-cp311-cp311-manylinux_2_28_aarch64.whl", hash = "sha256:9e91179a242bbc99be65e139e30690e081fe6cb91a8e77faf4c409653de39451"}, {file = "pillow-10.3.0-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:1b87bd9d81d179bd8ab871603bd80d8645729939f90b71e62914e816a76fc6bd"}, {file = "pillow-10.3.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:81d09caa7b27ef4e61cb7d8fbf1714f5aec1c6b6c5270ee53504981e6e9121ad"}, {file = "pillow-10.3.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:048ad577748b9fa4a99a0548c64f2cb8d672d5bf2e643a739ac8faff1164238c"}, {file = "pillow-10.3.0-cp311-cp311-win32.whl", hash = "sha256:7161ec49ef0800947dc5570f86568a7bb36fa97dd09e9827dc02b718c5643f09"}, {file = "pillow-10.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:8eb0908e954d093b02a543dc963984d6e99ad2b5e36503d8a0aaf040505f747d"}, {file = "pillow-10.3.0-cp311-cp311-win_arm64.whl", hash = "sha256:4e6f7d1c414191c1199f8996d3f2282b9ebea0945693fb67392c75a3a320941f"}, {file = "pillow-10.3.0-cp312-cp312-macosx_10_10_x86_64.whl", hash = "sha256:e46f38133e5a060d46bd630faa4d9fa0202377495df1f068a8299fd78c84de84"}, {file = "pillow-10.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:50b8eae8f7334ec826d6eeffaeeb00e36b5e24aa0b9df322c247539714c6df19"}, {file = "pillow-10.3.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9d3bea1c75f8c53ee4d505c3e67d8c158ad4df0d83170605b50b64025917f338"}, {file = "pillow-10.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:19aeb96d43902f0a783946a0a87dbdad5c84c936025b8419da0a0cd7724356b1"}, {file = "pillow-10.3.0-cp312-cp312-manylinux_2_28_aarch64.whl", hash = "sha256:74d28c17412d9caa1066f7a31df8403ec23d5268ba46cd0ad2c50fb82ae40462"}, {file = "pillow-10.3.0-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:ff61bfd9253c3915e6d41c651d5f962da23eda633cf02262990094a18a55371a"}, {file = "pillow-10.3.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d886f5d353333b4771d21267c7ecc75b710f1a73d72d03ca06df49b09015a9ef"}, {file = "pillow-10.3.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:4b5ec25d8b17217d635f8935dbc1b9aa5907962fae29dff220f2659487891cd3"}, {file = "pillow-10.3.0-cp312-cp312-win32.whl", hash = "sha256:51243f1ed5161b9945011a7360e997729776f6e5d7005ba0c6879267d4c5139d"}, {file = "pillow-10.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:412444afb8c4c7a6cc11a47dade32982439925537e483be7c0ae0cf96c4f6a0b"}, {file = "pillow-10.3.0-cp312-cp312-win_arm64.whl", hash = "sha256:798232c92e7665fe82ac085f9d8e8ca98826f8e27859d9a96b41d519ecd2e49a"}, {file = "pillow-10.3.0-cp38-cp38-macosx_10_10_x86_64.whl", hash = "sha256:4eaa22f0d22b1a7e93ff0a596d57fdede2e550aecffb5a1ef1106aaece48e96b"}, {file = "pillow-10.3.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:cd5e14fbf22a87321b24c88669aad3a51ec052eb145315b3da3b7e3cc105b9a2"}, {file = "pillow-10.3.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1530e8f3a4b965eb6a7785cf17a426c779333eb62c9a7d1bbcf3ffd5bf77a4aa"}, {file = "pillow-10.3.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5d512aafa1d32efa014fa041d38868fda85028e3f930a96f85d49c7d8ddc0383"}, {file = "pillow-10.3.0-cp38-cp38-manylinux_2_28_aarch64.whl", hash = "sha256:339894035d0ede518b16073bdc2feef4c991ee991a29774b33e515f1d308e08d"}, {file = "pillow-10.3.0-cp38-cp38-manylinux_2_28_x86_64.whl", hash = "sha256:aa7e402ce11f0885305bfb6afb3434b3cd8f53b563ac065452d9d5654c7b86fd"}, {file = "pillow-10.3.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:0ea2a783a2bdf2a561808fe4a7a12e9aa3799b701ba305de596bc48b8bdfce9d"}, {file = "pillow-10.3.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:c78e1b00a87ce43bb37642c0812315b411e856a905d58d597750eb79802aaaa3"}, {file = "pillow-10.3.0-cp38-cp38-win32.whl", hash = "sha256:72d622d262e463dfb7595202d229f5f3ab4b852289a1cd09650362db23b9eb0b"}, {file = "pillow-10.3.0-cp38-cp38-win_amd64.whl", hash = "sha256:2034f6759a722da3a3dbd91a81148cf884e91d1b747992ca288ab88c1de15999"}, {file = "pillow-10.3.0-cp39-cp39-macosx_10_10_x86_64.whl", hash = "sha256:2ed854e716a89b1afcedea551cd85f2eb2a807613752ab997b9974aaa0d56936"}, {file = "pillow-10.3.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:dc1a390a82755a8c26c9964d457d4c9cbec5405896cba94cf51f36ea0d855002"}, {file = "pillow-10.3.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4203efca580f0dd6f882ca211f923168548f7ba334c189e9eab1178ab840bf60"}, {file = "pillow-10.3.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3102045a10945173d38336f6e71a8dc71bcaeed55c3123ad4af82c52807b9375"}, {file = "pillow-10.3.0-cp39-cp39-manylinux_2_28_aarch64.whl", hash = "sha256:6fb1b30043271ec92dc65f6d9f0b7a830c210b8a96423074b15c7bc999975f57"}, {file = "pillow-10.3.0-cp39-cp39-manylinux_2_28_x86_64.whl", hash = "sha256:1dfc94946bc60ea375cc39cff0b8da6c7e5f8fcdc1d946beb8da5c216156ddd8"}, {file = "pillow-10.3.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:b09b86b27a064c9624d0a6c54da01c1beaf5b6cadfa609cf63789b1d08a797b9"}, {file = "pillow-10.3.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:d3b2348a78bc939b4fed6552abfd2e7988e0f81443ef3911a4b8498ca084f6eb"}, {file = "pillow-10.3.0-cp39-cp39-win32.whl", hash = "sha256:45ebc7b45406febf07fef35d856f0293a92e7417ae7933207e90bf9090b70572"}, {file = "pillow-10.3.0-cp39-cp39-win_amd64.whl", hash = "sha256:0ba26351b137ca4e0db0342d5d00d2e355eb29372c05afd544ebf47c0956ffeb"}, {file = "pillow-10.3.0-cp39-cp39-win_arm64.whl", hash = "sha256:50fd3f6b26e3441ae07b7c979309638b72abc1a25da31a81a7fbd9495713ef4f"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-macosx_10_10_x86_64.whl", hash = "sha256:6b02471b72526ab8a18c39cb7967b72d194ec53c1fd0a70b050565a0f366d355"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:8ab74c06ffdab957d7670c2a5a6e1a70181cd10b727cd788c4dd9005b6a8acd9"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:048eeade4c33fdf7e08da40ef402e748df113fd0b4584e32c4af74fe78baaeb2"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9e2ec1e921fd07c7cda7962bad283acc2f2a9ccc1b971ee4b216b75fad6f0463"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:4c8e73e99da7db1b4cad7f8d682cf6abad7844da39834c288fbfa394a47bbced"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:16563993329b79513f59142a6b02055e10514c1a8e86dca8b48a893e33cf91e3"}, {file = "pillow-10.3.0-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:dd78700f5788ae180b5ee8902c6aea5a5726bac7c364b202b4b3e3ba2d293170"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-macosx_10_10_x86_64.whl", hash = "sha256:aff76a55a8aa8364d25400a210a65ff59d0168e0b4285ba6bf2bd83cf675ba32"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:b7bc2176354defba3edc2b9a777744462da2f8e921fbaf61e52acb95bafa9828"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:793b4e24db2e8742ca6423d3fde8396db336698c55cd34b660663ee9e45ed37f"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d93480005693d247f8346bc8ee28c72a2191bdf1f6b5db469c096c0c867ac015"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:c83341b89884e2b2e55886e8fbbf37c3fa5efd6c8907124aeb72f285ae5696e5"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:1a1d1915db1a4fdb2754b9de292642a39a7fb28f1736699527bb649484fb966a"}, {file = "pillow-10.3.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:a0eaa93d054751ee9964afa21c06247779b90440ca41d184aeb5d410f20ff591"}, {file = "pillow-10.3.0.tar.gz", hash = "sha256:9d2455fbf44c914840c793e89aa82d0e1763a14253a000743719ae5946814b2d"}, ] [package.extras] docs = ["furo", "olefile", "sphinx (>=2.4)", "sphinx-copybutton", "sphinx-inline-tabs", "sphinx-removed-in", "sphinxext-opengraph"] fpx = ["olefile"] mic = ["olefile"] tests = ["check-manifest", "coverage", "defusedxml", "markdown2", "olefile", "packaging", "pyroma", "pytest", "pytest-cov", "pytest-timeout"] typing = ["typing-extensions ; python_version < \"3.10\""] xmp = ["defusedxml"] [[package]] name = "platformdirs" version = "4.2.0" description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "platformdirs-4.2.0-py3-none-any.whl", hash = "sha256:0614df2a2f37e1a662acbd8e2b25b92ccf8632929bc6d43467e17fe89c75e068"}, {file = "platformdirs-4.2.0.tar.gz", hash = "sha256:ef0cc731df711022c174543cb70a9b5bd22e5a9337c8624ef2c2ceb8ddad8768"}, ] [package.extras] docs = ["furo (>=2023.9.10)", "proselint (>=0.13)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"] test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)"] [[package]] name = "pluggy" version = "1.6.0" description = "plugin and hook calling mechanisms for python" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746"}, {file = "pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3"}, ] [package.extras] dev = ["pre-commit", "tox"] testing = ["coverage", "pytest", "pytest-benchmark"] [[package]] name = "pre-commit" version = "4.2.0" description = "A framework for managing and maintaining multi-language pre-commit hooks." optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "pre_commit-4.2.0-py2.py3-none-any.whl", hash = "sha256:a009ca7205f1eb497d10b845e52c838a98b6cdd2102a6c8e4540e94ee75c58bd"}, {file = "pre_commit-4.2.0.tar.gz", hash = "sha256:601283b9757afd87d40c4c4a9b2b5de9637a8ea02eaff7adc2d0fb4e04841146"}, ] [package.dependencies] cfgv = ">=2.0.0" identify = ">=1.0.0" nodeenv = ">=0.11.1" pyyaml = ">=5.1" virtualenv = ">=20.10.0" [[package]] name = "py-partiql-parser" version = "0.6.1" description = "Pure Python PartiQL Parser" optional = false python-versions = "*" groups = ["dev"] files = [ {file = "py_partiql_parser-0.6.1-py2.py3-none-any.whl", hash = "sha256:ff6a48067bff23c37e9044021bf1d949c83e195490c17e020715e927fe5b2456"}, {file = "py_partiql_parser-0.6.1.tar.gz", hash = "sha256:8583ff2a0e15560ef3bc3df109a7714d17f87d81d33e8c38b7fed4e58a63215d"}, ] [package.extras] dev = ["black (==22.6.0)", "flake8", "mypy", "pytest"] [[package]] name = "pycparser" version = "2.21" description = "C parser in Python" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" groups = ["dev"] markers = "platform_python_implementation != \"PyPy\"" files = [ {file = "pycparser-2.21-py2.py3-none-any.whl", hash = "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9"}, {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"}, ] [[package]] name = "pydantic" version = "2.9.2" description = "Data validation using Python type hints" optional = false python-versions = ">=3.8" groups = ["main", "dev"] files = [ {file = "pydantic-2.9.2-py3-none-any.whl", hash = "sha256:f048cec7b26778210e28a0459867920654d48e5e62db0958433636cde4254f12"}, {file = "pydantic-2.9.2.tar.gz", hash = "sha256:d155cef71265d1e9807ed1c32b4c8deec042a44a50a4188b25ac67ecd81a9c0f"}, ] [package.dependencies] annotated-types = ">=0.6.0" email-validator = {version = ">=2.0.0", optional = true, markers = "extra == \"email\""} pydantic-core = "2.23.4" typing-extensions = [ {version = ">=4.12.2", markers = "python_version >= \"3.13\""}, {version = ">=4.6.1", markers = "python_version < \"3.13\""}, ] [package.extras] email = ["email-validator (>=2.0.0)"] timezone = ["tzdata ; python_version >= \"3.9\" and sys_platform == \"win32\""] [[package]] name = "pydantic-core" version = "2.23.4" description = "Core functionality for Pydantic validation and serialization" optional = false python-versions = ">=3.8" groups = ["main", "dev"] files = [ {file = "pydantic_core-2.23.4-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:b10bd51f823d891193d4717448fab065733958bdb6a6b351967bd349d48d5c9b"}, {file = "pydantic_core-2.23.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:4fc714bdbfb534f94034efaa6eadd74e5b93c8fa6315565a222f7b6f42ca1166"}, {file = "pydantic_core-2.23.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:63e46b3169866bd62849936de036f901a9356e36376079b05efa83caeaa02ceb"}, {file = "pydantic_core-2.23.4-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ed1a53de42fbe34853ba90513cea21673481cd81ed1be739f7f2efb931b24916"}, {file = "pydantic_core-2.23.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:cfdd16ab5e59fc31b5e906d1a3f666571abc367598e3e02c83403acabc092e07"}, {file = "pydantic_core-2.23.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:255a8ef062cbf6674450e668482456abac99a5583bbafb73f9ad469540a3a232"}, {file = "pydantic_core-2.23.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4a7cd62e831afe623fbb7aabbb4fe583212115b3ef38a9f6b71869ba644624a2"}, {file = "pydantic_core-2.23.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f09e2ff1f17c2b51f2bc76d1cc33da96298f0a036a137f5440ab3ec5360b624f"}, {file = "pydantic_core-2.23.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e38e63e6f3d1cec5a27e0afe90a085af8b6806ee208b33030e65b6516353f1a3"}, {file = "pydantic_core-2.23.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:0dbd8dbed2085ed23b5c04afa29d8fd2771674223135dc9bc937f3c09284d071"}, {file = "pydantic_core-2.23.4-cp310-none-win32.whl", hash = "sha256:6531b7ca5f951d663c339002e91aaebda765ec7d61b7d1e3991051906ddde119"}, {file = "pydantic_core-2.23.4-cp310-none-win_amd64.whl", hash = "sha256:7c9129eb40958b3d4500fa2467e6a83356b3b61bfff1b414c7361d9220f9ae8f"}, {file = "pydantic_core-2.23.4-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:77733e3892bb0a7fa797826361ce8a9184d25c8dffaec60b7ffe928153680ba8"}, {file = "pydantic_core-2.23.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1b84d168f6c48fabd1f2027a3d1bdfe62f92cade1fb273a5d68e621da0e44e6d"}, {file = "pydantic_core-2.23.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:df49e7a0861a8c36d089c1ed57d308623d60416dab2647a4a17fe050ba85de0e"}, {file = "pydantic_core-2.23.4-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ff02b6d461a6de369f07ec15e465a88895f3223eb75073ffea56b84d9331f607"}, {file = "pydantic_core-2.23.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:996a38a83508c54c78a5f41456b0103c30508fed9abcad0a59b876d7398f25fd"}, {file = "pydantic_core-2.23.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d97683ddee4723ae8c95d1eddac7c192e8c552da0c73a925a89fa8649bf13eea"}, {file = "pydantic_core-2.23.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:216f9b2d7713eb98cb83c80b9c794de1f6b7e3145eef40400c62e86cee5f4e1e"}, {file = "pydantic_core-2.23.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6f783e0ec4803c787bcea93e13e9932edab72068f68ecffdf86a99fd5918878b"}, {file = "pydantic_core-2.23.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:d0776dea117cf5272382634bd2a5c1b6eb16767c223c6a5317cd3e2a757c61a0"}, {file = "pydantic_core-2.23.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:d5f7a395a8cf1621939692dba2a6b6a830efa6b3cee787d82c7de1ad2930de64"}, {file = "pydantic_core-2.23.4-cp311-none-win32.whl", hash = "sha256:74b9127ffea03643e998e0c5ad9bd3811d3dac8c676e47db17b0ee7c3c3bf35f"}, {file = "pydantic_core-2.23.4-cp311-none-win_amd64.whl", hash = "sha256:98d134c954828488b153d88ba1f34e14259284f256180ce659e8d83e9c05eaa3"}, {file = "pydantic_core-2.23.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:f3e0da4ebaef65158d4dfd7d3678aad692f7666877df0002b8a522cdf088f231"}, {file = "pydantic_core-2.23.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f69a8e0b033b747bb3e36a44e7732f0c99f7edd5cea723d45bc0d6e95377ffee"}, {file = "pydantic_core-2.23.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:723314c1d51722ab28bfcd5240d858512ffd3116449c557a1336cbe3919beb87"}, {file = "pydantic_core-2.23.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:bb2802e667b7051a1bebbfe93684841cc9351004e2badbd6411bf357ab8d5ac8"}, {file = "pydantic_core-2.23.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d18ca8148bebe1b0a382a27a8ee60350091a6ddaf475fa05ef50dc35b5df6327"}, {file = "pydantic_core-2.23.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:33e3d65a85a2a4a0dc3b092b938a4062b1a05f3a9abde65ea93b233bca0e03f2"}, {file = "pydantic_core-2.23.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:128585782e5bfa515c590ccee4b727fb76925dd04a98864182b22e89a4e6ed36"}, {file = "pydantic_core-2.23.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:68665f4c17edcceecc112dfed5dbe6f92261fb9d6054b47d01bf6371a6196126"}, {file = "pydantic_core-2.23.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:20152074317d9bed6b7a95ade3b7d6054845d70584216160860425f4fbd5ee9e"}, {file = "pydantic_core-2.23.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:9261d3ce84fa1d38ed649c3638feefeae23d32ba9182963e465d58d62203bd24"}, {file = "pydantic_core-2.23.4-cp312-none-win32.whl", hash = "sha256:4ba762ed58e8d68657fc1281e9bb72e1c3e79cc5d464be146e260c541ec12d84"}, {file = "pydantic_core-2.23.4-cp312-none-win_amd64.whl", hash = "sha256:97df63000f4fea395b2824da80e169731088656d1818a11b95f3b173747b6cd9"}, {file = "pydantic_core-2.23.4-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:7530e201d10d7d14abce4fb54cfe5b94a0aefc87da539d0346a484ead376c3cc"}, {file = "pydantic_core-2.23.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:df933278128ea1cd77772673c73954e53a1c95a4fdf41eef97c2b779271bd0bd"}, {file = "pydantic_core-2.23.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0cb3da3fd1b6a5d0279a01877713dbda118a2a4fc6f0d821a57da2e464793f05"}, {file = "pydantic_core-2.23.4-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:42c6dcb030aefb668a2b7009c85b27f90e51e6a3b4d5c9bc4c57631292015b0d"}, {file = "pydantic_core-2.23.4-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:696dd8d674d6ce621ab9d45b205df149399e4bb9aa34102c970b721554828510"}, {file = "pydantic_core-2.23.4-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2971bb5ffe72cc0f555c13e19b23c85b654dd2a8f7ab493c262071377bfce9f6"}, {file = "pydantic_core-2.23.4-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8394d940e5d400d04cad4f75c0598665cbb81aecefaca82ca85bd28264af7f9b"}, {file = "pydantic_core-2.23.4-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:0dff76e0602ca7d4cdaacc1ac4c005e0ce0dcfe095d5b5259163a80d3a10d327"}, {file = "pydantic_core-2.23.4-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:7d32706badfe136888bdea71c0def994644e09fff0bfe47441deaed8e96fdbc6"}, {file = "pydantic_core-2.23.4-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:ed541d70698978a20eb63d8c5d72f2cc6d7079d9d90f6b50bad07826f1320f5f"}, {file = "pydantic_core-2.23.4-cp313-none-win32.whl", hash = "sha256:3d5639516376dce1940ea36edf408c554475369f5da2abd45d44621cb616f769"}, {file = "pydantic_core-2.23.4-cp313-none-win_amd64.whl", hash = "sha256:5a1504ad17ba4210df3a045132a7baeeba5a200e930f57512ee02909fc5c4cb5"}, {file = "pydantic_core-2.23.4-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:d4488a93b071c04dc20f5cecc3631fc78b9789dd72483ba15d423b5b3689b555"}, {file = "pydantic_core-2.23.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:81965a16b675b35e1d09dd14df53f190f9129c0202356ed44ab2728b1c905658"}, {file = "pydantic_core-2.23.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4ffa2ebd4c8530079140dd2d7f794a9d9a73cbb8e9d59ffe24c63436efa8f271"}, {file = "pydantic_core-2.23.4-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:61817945f2fe7d166e75fbfb28004034b48e44878177fc54d81688e7b85a3665"}, {file = "pydantic_core-2.23.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:29d2c342c4bc01b88402d60189f3df065fb0dda3654744d5a165a5288a657368"}, {file = "pydantic_core-2.23.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5e11661ce0fd30a6790e8bcdf263b9ec5988e95e63cf901972107efc49218b13"}, {file = "pydantic_core-2.23.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9d18368b137c6295db49ce7218b1a9ba15c5bc254c96d7c9f9e924a9bc7825ad"}, {file = "pydantic_core-2.23.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:ec4e55f79b1c4ffb2eecd8a0cfba9955a2588497d96851f4c8f99aa4a1d39b12"}, {file = "pydantic_core-2.23.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:374a5e5049eda9e0a44c696c7ade3ff355f06b1fe0bb945ea3cac2bc336478a2"}, {file = "pydantic_core-2.23.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:5c364564d17da23db1106787675fc7af45f2f7b58b4173bfdd105564e132e6fb"}, {file = "pydantic_core-2.23.4-cp38-none-win32.whl", hash = "sha256:d7a80d21d613eec45e3d41eb22f8f94ddc758a6c4720842dc74c0581f54993d6"}, {file = "pydantic_core-2.23.4-cp38-none-win_amd64.whl", hash = "sha256:5f5ff8d839f4566a474a969508fe1c5e59c31c80d9e140566f9a37bba7b8d556"}, {file = "pydantic_core-2.23.4-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:a4fa4fc04dff799089689f4fd502ce7d59de529fc2f40a2c8836886c03e0175a"}, {file = "pydantic_core-2.23.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0a7df63886be5e270da67e0966cf4afbae86069501d35c8c1b3b6c168f42cb36"}, {file = "pydantic_core-2.23.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dcedcd19a557e182628afa1d553c3895a9f825b936415d0dbd3cd0bbcfd29b4b"}, {file = "pydantic_core-2.23.4-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5f54b118ce5de9ac21c363d9b3caa6c800341e8c47a508787e5868c6b79c9323"}, {file = "pydantic_core-2.23.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:86d2f57d3e1379a9525c5ab067b27dbb8a0642fb5d454e17a9ac434f9ce523e3"}, {file = "pydantic_core-2.23.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:de6d1d1b9e5101508cb37ab0d972357cac5235f5c6533d1071964c47139257df"}, {file = "pydantic_core-2.23.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1278e0d324f6908e872730c9102b0112477a7f7cf88b308e4fc36ce1bdb6d58c"}, {file = "pydantic_core-2.23.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:9a6b5099eeec78827553827f4c6b8615978bb4b6a88e5d9b93eddf8bb6790f55"}, {file = "pydantic_core-2.23.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:e55541f756f9b3ee346b840103f32779c695a19826a4c442b7954550a0972040"}, {file = "pydantic_core-2.23.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:a5c7ba8ffb6d6f8f2ab08743be203654bb1aaa8c9dcb09f82ddd34eadb695605"}, {file = "pydantic_core-2.23.4-cp39-none-win32.whl", hash = "sha256:37b0fe330e4a58d3c58b24d91d1eb102aeec675a3db4c292ec3928ecd892a9a6"}, {file = "pydantic_core-2.23.4-cp39-none-win_amd64.whl", hash = "sha256:1498bec4c05c9c787bde9125cfdcc63a41004ff167f495063191b863399b1a29"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:f455ee30a9d61d3e1a15abd5068827773d6e4dc513e795f380cdd59932c782d5"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:1e90d2e3bd2c3863d48525d297cd143fe541be8bbf6f579504b9712cb6b643ec"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2e203fdf807ac7e12ab59ca2bfcabb38c7cf0b33c41efeb00f8e5da1d86af480"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e08277a400de01bc72436a0ccd02bdf596631411f592ad985dcee21445bd0068"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f220b0eea5965dec25480b6333c788fb72ce5f9129e8759ef876a1d805d00801"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:d06b0c8da4f16d1d1e352134427cb194a0a6e19ad5db9161bf32b2113409e728"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:ba1a0996f6c2773bd83e63f18914c1de3c9dd26d55f4ac302a7efe93fb8e7433"}, {file = "pydantic_core-2.23.4-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:9a5bce9d23aac8f0cf0836ecfc033896aa8443b501c58d0602dbfd5bd5b37753"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:78ddaaa81421a29574a682b3179d4cf9e6d405a09b99d93ddcf7e5239c742e21"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:883a91b5dd7d26492ff2f04f40fbb652de40fcc0afe07e8129e8ae779c2110eb"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:88ad334a15b32a791ea935af224b9de1bf99bcd62fabf745d5f3442199d86d59"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:233710f069d251feb12a56da21e14cca67994eab08362207785cf8c598e74577"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:19442362866a753485ba5e4be408964644dd6a09123d9416c54cd49171f50744"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:624e278a7d29b6445e4e813af92af37820fafb6dcc55c012c834f9e26f9aaaef"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f5ef8f42bec47f21d07668a043f077d507e5bf4e668d5c6dfe6aaba89de1a5b8"}, {file = "pydantic_core-2.23.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:aea443fffa9fbe3af1a9ba721a87f926fe548d32cab71d188a6ede77d0ff244e"}, {file = "pydantic_core-2.23.4.tar.gz", hash = "sha256:2584f7cf844ac4d970fba483a717dbe10c1c1c96a969bf65d61ffe94df1b2863"}, ] [package.dependencies] typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0" [[package]] name = "pydantic-settings" version = "2.5.2" description = "Settings management using Pydantic" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "pydantic_settings-2.5.2-py3-none-any.whl", hash = "sha256:2c912e55fd5794a59bf8c832b9de832dcfdf4778d79ff79b708744eed499a907"}, {file = "pydantic_settings-2.5.2.tar.gz", hash = "sha256:f90b139682bee4d2065273d5185d71d37ea46cfe57e1b5ae184fc6a0b2484ca0"}, ] [package.dependencies] pydantic = ">=2.7.0" python-dotenv = ">=0.21.0" [package.extras] azure-key-vault = ["azure-identity (>=1.16.0)", "azure-keyvault-secrets (>=4.8.0)"] toml = ["tomli (>=2.0.1)"] yaml = ["pyyaml (>=6.0.1)"] [[package]] name = "pygments" version = "2.19.2" description = "Pygments is a syntax highlighting package written in Python." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b"}, {file = "pygments-2.19.2.tar.gz", hash = "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887"}, ] [package.extras] windows-terminal = ["colorama (>=0.4.6)"] [[package]] name = "pyjwt" version = "2.8.0" description = "JSON Web Token implementation in Python" optional = false python-versions = ">=3.7" groups = ["main"] files = [ {file = "PyJWT-2.8.0-py3-none-any.whl", hash = "sha256:59127c392cc44c2da5bb3192169a91f429924e17aff6534d70fdc02ab3e04320"}, {file = "PyJWT-2.8.0.tar.gz", hash = "sha256:57e28d156e3d5c10088e0c68abb90bfac3df82b40a71bd0daa20c65ccd5c23de"}, ] [package.extras] crypto = ["cryptography (>=3.4.0)"] dev = ["coverage[toml] (==5.0.4)", "cryptography (>=3.4.0)", "pre-commit", "pytest (>=6.0.0,<7.0.0)", "sphinx (>=4.5.0,<5.0.0)", "sphinx-rtd-theme", "zope.interface"] docs = ["sphinx (>=4.5.0,<5.0.0)", "sphinx-rtd-theme", "zope.interface"] tests = ["coverage[toml] (==5.0.4)", "pytest (>=6.0.0,<7.0.0)"] [[package]] name = "pyparsing" version = "3.1.2" description = "pyparsing module - Classes and methods to define and execute parsing grammars" optional = false python-versions = ">=3.6.8" groups = ["dev"] files = [ {file = "pyparsing-3.1.2-py3-none-any.whl", hash = "sha256:f9db75911801ed778fe61bb643079ff86601aca99fcae6345aa67292038fb742"}, {file = "pyparsing-3.1.2.tar.gz", hash = "sha256:a1bac0ce561155ecc3ed78ca94d3c9378656ad4c94c1270de543f621420f94ad"}, ] [package.extras] diagrams = ["jinja2", "railroad-diagrams"] [[package]] name = "pytest" version = "8.4.1" description = "pytest: simple powerful testing with Python" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "pytest-8.4.1-py3-none-any.whl", hash = "sha256:539c70ba6fcead8e78eebbf1115e8b589e7565830d7d006a8723f19ac8a0afb7"}, {file = "pytest-8.4.1.tar.gz", hash = "sha256:7c67fd69174877359ed9371ec3af8a3d2b04741818c51e5e99cc1742251fa93c"}, ] [package.dependencies] colorama = {version = ">=0.4", markers = "sys_platform == \"win32\""} iniconfig = ">=1" packaging = ">=20" pluggy = ">=1.5,<2" pygments = ">=2.7.2" [package.extras] dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "requests", "setuptools", "xmlschema"] [[package]] name = "pytest-cov" version = "5.0.0" description = "Pytest plugin for measuring coverage." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "pytest-cov-5.0.0.tar.gz", hash = "sha256:5837b58e9f6ebd335b0f8060eecce69b662415b16dc503883a02f45dfeb14857"}, {file = "pytest_cov-5.0.0-py3-none-any.whl", hash = "sha256:4f0764a1219df53214206bf1feea4633c3b558a2925c8b59f144f682861ce652"}, ] [package.dependencies] coverage = {version = ">=5.2.1", extras = ["toml"]} pytest = ">=4.6" [package.extras] testing = ["fields", "hunter", "process-tests", "pytest-xdist", "virtualenv"] [[package]] name = "pytest-env" version = "1.1.3" description = "pytest plugin that allows you to add environment variables." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "pytest_env-1.1.3-py3-none-any.whl", hash = "sha256:aada77e6d09fcfb04540a6e462c58533c37df35fa853da78707b17ec04d17dfc"}, {file = "pytest_env-1.1.3.tar.gz", hash = "sha256:fcd7dc23bb71efd3d35632bde1bbe5ee8c8dc4489d6617fb010674880d96216b"}, ] [package.dependencies] pytest = ">=7.4.3" [package.extras] test = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "pytest-mock (>=3.12)"] [[package]] name = "pytest-mock" version = "3.12.0" description = "Thin-wrapper around the mock package for easier use with pytest" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "pytest-mock-3.12.0.tar.gz", hash = "sha256:31a40f038c22cad32287bb43932054451ff5583ff094bca6f675df2f8bc1a6e9"}, {file = "pytest_mock-3.12.0-py3-none-any.whl", hash = "sha256:0972719a7263072da3a21c7f4773069bcc7486027d7e8e1f81d98a47e701bc4f"}, ] [package.dependencies] pytest = ">=5.0" [package.extras] dev = ["pre-commit", "pytest-asyncio", "tox"] [[package]] name = "python-dateutil" version = "2.9.0.post0" description = "Extensions to the standard Python datetime module" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" groups = ["dev"] files = [ {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, ] [package.dependencies] six = ">=1.5" [[package]] name = "python-dotenv" version = "1.0.1" description = "Read key-value pairs from a .env file and set them as environment variables" optional = false python-versions = ">=3.8" groups = ["main"] files = [ {file = "python-dotenv-1.0.1.tar.gz", hash = "sha256:e324ee90a023d808f1959c46bcbc04446a10ced277783dc6ee09987c37ec10ca"}, {file = "python_dotenv-1.0.1-py3-none-any.whl", hash = "sha256:f7b63ef50f1b690dddf550d03497b66d609393b40b564ed0d674909a68ebf16a"}, ] [package.extras] cli = ["click (>=5.0)"] [[package]] name = "pywin32" version = "306" description = "Python for Window Extensions" optional = false python-versions = "*" groups = ["dev"] markers = "sys_platform == \"win32\"" files = [ {file = "pywin32-306-cp310-cp310-win32.whl", hash = "sha256:06d3420a5155ba65f0b72f2699b5bacf3109f36acbe8923765c22938a69dfc8d"}, {file = "pywin32-306-cp310-cp310-win_amd64.whl", hash = "sha256:84f4471dbca1887ea3803d8848a1616429ac94a4a8d05f4bc9c5dcfd42ca99c8"}, {file = "pywin32-306-cp311-cp311-win32.whl", hash = "sha256:e65028133d15b64d2ed8f06dd9fbc268352478d4f9289e69c190ecd6818b6407"}, {file = "pywin32-306-cp311-cp311-win_amd64.whl", hash = "sha256:a7639f51c184c0272e93f244eb24dafca9b1855707d94c192d4a0b4c01e1100e"}, {file = "pywin32-306-cp311-cp311-win_arm64.whl", hash = "sha256:70dba0c913d19f942a2db25217d9a1b726c278f483a919f1abfed79c9cf64d3a"}, {file = "pywin32-306-cp312-cp312-win32.whl", hash = "sha256:383229d515657f4e3ed1343da8be101000562bf514591ff383ae940cad65458b"}, {file = "pywin32-306-cp312-cp312-win_amd64.whl", hash = "sha256:37257794c1ad39ee9be652da0462dc2e394c8159dfd913a8a4e8eb6fd346da0e"}, {file = "pywin32-306-cp312-cp312-win_arm64.whl", hash = "sha256:5821ec52f6d321aa59e2db7e0a35b997de60c201943557d108af9d4ae1ec7040"}, {file = "pywin32-306-cp37-cp37m-win32.whl", hash = "sha256:1c73ea9a0d2283d889001998059f5eaaba3b6238f767c9cf2833b13e6a685f65"}, {file = "pywin32-306-cp37-cp37m-win_amd64.whl", hash = "sha256:72c5f621542d7bdd4fdb716227be0dd3f8565c11b280be6315b06ace35487d36"}, {file = "pywin32-306-cp38-cp38-win32.whl", hash = "sha256:e4c092e2589b5cf0d365849e73e02c391c1349958c5ac3e9d5ccb9a28e017b3a"}, {file = "pywin32-306-cp38-cp38-win_amd64.whl", hash = "sha256:e8ac1ae3601bee6ca9f7cb4b5363bf1c0badb935ef243c4733ff9a393b1690c0"}, {file = "pywin32-306-cp39-cp39-win32.whl", hash = "sha256:e25fd5b485b55ac9c057f67d94bc203f3f6595078d1fb3b458c9c28b7153a802"}, {file = "pywin32-306-cp39-cp39-win_amd64.whl", hash = "sha256:39b61c15272833b5c329a2989999dcae836b1eed650252ab1b7bfbe1d59f30f4"}, ] [[package]] name = "pyyaml" version = "6.0.1" description = "YAML parser and emitter for Python" optional = false python-versions = ">=3.6" groups = ["dev"] files = [ {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"}, {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"}, {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"}, {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"}, {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"}, {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"}, {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"}, {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"}, {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"}, {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"}, {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, ] [[package]] name = "requests" version = "2.32.4" description = "Python HTTP for Humans." optional = false python-versions = ">=3.8" groups = ["main", "dev"] files = [ {file = "requests-2.32.4-py3-none-any.whl", hash = "sha256:27babd3cda2a6d50b30443204ee89830707d396671944c998b5975b031ac2b2c"}, {file = "requests-2.32.4.tar.gz", hash = "sha256:27d0316682c8a29834d3264820024b62a36942083d52caf2f14c0591336d3422"}, ] [package.dependencies] certifi = ">=2017.4.17" charset_normalizer = ">=2,<4" idna = ">=2.5,<4" urllib3 = ">=1.21.1,<3" [package.extras] socks = ["PySocks (>=1.5.6,!=1.5.7)"] use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"] [[package]] name = "responses" version = "0.25.0" description = "A utility library for mocking out the `requests` Python library." optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "responses-0.25.0-py3-none-any.whl", hash = "sha256:2f0b9c2b6437db4b528619a77e5d565e4ec2a9532162ac1a131a83529db7be1a"}, {file = "responses-0.25.0.tar.gz", hash = "sha256:01ae6a02b4f34e39bffceb0fc6786b67a25eae919c6368d05eabc8d9576c2a66"}, ] [package.dependencies] pyyaml = "*" requests = ">=2.30.0,<3.0" urllib3 = ">=1.25.10,<3.0" [package.extras] tests = ["coverage (>=6.0.0)", "flake8", "mypy", "pytest (>=7.0.0)", "pytest-asyncio", "pytest-cov", "pytest-httpserver", "tomli ; python_version < \"3.11\"", "tomli-w", "types-PyYAML", "types-requests"] [[package]] name = "ruff" version = "0.3.3" description = "An extremely fast Python linter and code formatter, written in Rust." optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "ruff-0.3.3-py3-none-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl", hash = "sha256:973a0e388b7bc2e9148c7f9be8b8c6ae7471b9be37e1cc732f8f44a6f6d7720d"}, {file = "ruff-0.3.3-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:cfa60d23269d6e2031129b053fdb4e5a7b0637fc6c9c0586737b962b2f834493"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1eca7ff7a47043cf6ce5c7f45f603b09121a7cc047447744b029d1b719278eb5"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e7d3f6762217c1da954de24b4a1a70515630d29f71e268ec5000afe81377642d"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b24c19e8598916d9c6f5a5437671f55ee93c212a2c4c569605dc3842b6820386"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:5a6cbf216b69c7090f0fe4669501a27326c34e119068c1494f35aaf4cc683778"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:352e95ead6964974b234e16ba8a66dad102ec7bf8ac064a23f95371d8b198aab"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d6ab88c81c4040a817aa432484e838aaddf8bfd7ca70e4e615482757acb64f8"}, {file = "ruff-0.3.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:79bca3a03a759cc773fca69e0bdeac8abd1c13c31b798d5bb3c9da4a03144a9f"}, {file = "ruff-0.3.3-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:2700a804d5336bcffe063fd789ca2c7b02b552d2e323a336700abb8ae9e6a3f8"}, {file = "ruff-0.3.3-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:fd66469f1a18fdb9d32e22b79f486223052ddf057dc56dea0caaf1a47bdfaf4e"}, {file = "ruff-0.3.3-py3-none-musllinux_1_2_i686.whl", hash = "sha256:45817af234605525cdf6317005923bf532514e1ea3d9270acf61ca2440691376"}, {file = "ruff-0.3.3-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:0da458989ce0159555ef224d5b7c24d3d2e4bf4c300b85467b08c3261c6bc6a8"}, {file = "ruff-0.3.3-py3-none-win32.whl", hash = "sha256:f2831ec6a580a97f1ea82ea1eda0401c3cdf512cf2045fa3c85e8ef109e87de0"}, {file = "ruff-0.3.3-py3-none-win_amd64.whl", hash = "sha256:be90bcae57c24d9f9d023b12d627e958eb55f595428bafcb7fec0791ad25ddfc"}, {file = "ruff-0.3.3-py3-none-win_arm64.whl", hash = "sha256:0171aab5fecdc54383993389710a3d1227f2da124d76a2784a7098e818f92d61"}, {file = "ruff-0.3.3.tar.gz", hash = "sha256:38671be06f57a2f8aba957d9f701ea889aa5736be806f18c0cd03d6ff0cbca8d"}, ] [[package]] name = "s3transfer" version = "0.14.0" description = "An Amazon S3 Transfer Manager" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "s3transfer-0.14.0-py3-none-any.whl", hash = "sha256:ea3b790c7077558ed1f02a3072fb3cb992bbbd253392f4b6e9e8976941c7d456"}, {file = "s3transfer-0.14.0.tar.gz", hash = "sha256:eff12264e7c8b4985074ccce27a3b38a485bb7f7422cc8046fee9be4983e4125"}, ] [package.dependencies] botocore = ">=1.37.4,<2.0a.0" [package.extras] crt = ["botocore[crt] (>=1.37.4,<2.0a.0)"] [[package]] name = "setuptools" version = "78.1.1" description = "Easily download, build, install, upgrade, and uninstall Python packages" optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "setuptools-78.1.1-py3-none-any.whl", hash = "sha256:c3a9c4211ff4c309edb8b8c4f1cbfa7ae324c4ba9f91ff254e3d305b9fd54561"}, {file = "setuptools-78.1.1.tar.gz", hash = "sha256:fcc17fd9cd898242f6b4adfaca46137a9edef687f43e6f78469692a5e70d851d"}, ] [package.extras] check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1) ; sys_platform != \"cygwin\"", "ruff (>=0.8.0) ; sys_platform != \"cygwin\""] core = ["importlib_metadata (>=6) ; python_version < \"3.10\"", "jaraco.functools (>=4)", "jaraco.text (>=3.7)", "more_itertools", "more_itertools (>=8.8)", "packaging (>=24.2)", "platformdirs (>=4.2.2)", "tomli (>=2.0.1) ; python_version < \"3.11\"", "wheel (>=0.43.0)"] cover = ["pytest-cov"] doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "pyproject-hooks (!=1.1)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier", "towncrier (<24.7)"] enabler = ["pytest-enabler (>=2.2)"] test = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "ini2toml[lite] (>=0.14)", "jaraco.develop (>=7.21) ; python_version >= \"3.9\" and sys_platform != \"cygwin\"", "jaraco.envs (>=2.2)", "jaraco.path (>=3.7.2)", "jaraco.test (>=5.5)", "packaging (>=24.2)", "pip (>=19.1)", "pyproject-hooks (!=1.1)", "pytest (>=6,!=8.1.*)", "pytest-home (>=0.5)", "pytest-perf ; sys_platform != \"cygwin\"", "pytest-subprocess", "pytest-timeout", "pytest-xdist (>=3)", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel (>=0.44.0)"] type = ["importlib_metadata (>=7.0.2) ; python_version < \"3.10\"", "jaraco.develop (>=7.21) ; sys_platform != \"cygwin\"", "mypy (==1.14.*)", "pytest-mypy"] [[package]] name = "sh" version = "2.0.6" description = "Python subprocess replacement" optional = false python-versions = ">=3.8.1,<4.0" groups = ["dev"] files = [ {file = "sh-2.0.6-py3-none-any.whl", hash = "sha256:ced8f2e081a858b66a46ace3703dec243779abbd5a1887ba7e3c34f34da70cd2"}, {file = "sh-2.0.6.tar.gz", hash = "sha256:9b2998f313f201c777e2c0061f0b1367497097ef13388595be147e2a00bf7ba1"}, ] [[package]] name = "six" version = "1.16.0" description = "Python 2 and 3 compatibility utilities" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" groups = ["dev"] files = [ {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, ] [[package]] name = "termcolor" version = "2.4.0" description = "ANSI color formatting for output in terminal" optional = false python-versions = ">=3.8" groups = ["dev"] files = [ {file = "termcolor-2.4.0-py3-none-any.whl", hash = "sha256:9297c0df9c99445c2412e832e882a7884038a25617c60cea2ad69488d4040d63"}, {file = "termcolor-2.4.0.tar.gz", hash = "sha256:aab9e56047c8ac41ed798fa36d892a37aca6b3e9159f3e0c24bc64a9b3ac7b7a"}, ] [package.extras] tests = ["pytest", "pytest-cov"] [[package]] name = "types-awscrt" version = "0.20.5" description = "Type annotations and code completion for awscrt" optional = false python-versions = ">=3.7,<4.0" groups = ["main"] files = [ {file = "types_awscrt-0.20.5-py3-none-any.whl", hash = "sha256:79d5bfb01f64701b6cf442e89a37d9c4dc6dbb79a46f2f611739b2418d30ecfd"}, {file = "types_awscrt-0.20.5.tar.gz", hash = "sha256:61811bbf4de95248939f9276a434be93d2b95f6ccfe8aa94e56999e9778cfcc2"}, ] [[package]] name = "types-s3transfer" version = "0.10.0" description = "Type annotations and code completion for s3transfer" optional = false python-versions = ">=3.7,<4.0" groups = ["main"] files = [ {file = "types_s3transfer-0.10.0-py3-none-any.whl", hash = "sha256:44fcdf0097b924a9aab1ee4baa1179081a9559ca62a88c807e2b256893ce688f"}, {file = "types_s3transfer-0.10.0.tar.gz", hash = "sha256:35e4998c25df7f8985ad69dedc8e4860e8af3b43b7615e940d53c00d413bdc69"}, ] [[package]] name = "typing-extensions" version = "4.12.2" description = "Backported and Experimental Type Hints for Python 3.8+" optional = false python-versions = ">=3.8" groups = ["main", "dev"] files = [ {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"}, {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"}, ] [[package]] name = "urllib3" version = "2.5.0" description = "HTTP library with thread-safe connection pooling, file post, and more." optional = false python-versions = ">=3.9" groups = ["main", "dev"] files = [ {file = "urllib3-2.5.0-py3-none-any.whl", hash = "sha256:e6b01673c0fa6a13e374b50871808eb3bf7046c4b125b216f6bf1cc604cff0dc"}, {file = "urllib3-2.5.0.tar.gz", hash = "sha256:3fc47733c7e419d4bc3f6b3dc2b4f890bb743906a30d56ba4a5bfa4bbff92760"}, ] [package.extras] brotli = ["brotli (>=1.0.9) ; platform_python_implementation == \"CPython\"", "brotlicffi (>=0.8.0) ; platform_python_implementation != \"CPython\""] h2 = ["h2 (>=4,<5)"] socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] zstd = ["zstandard (>=0.18.0)"] [[package]] name = "virtualenv" version = "20.26.6" description = "Virtual Python Environment builder" optional = false python-versions = ">=3.7" groups = ["dev"] files = [ {file = "virtualenv-20.26.6-py3-none-any.whl", hash = "sha256:7345cc5b25405607a624d8418154577459c3e0277f5466dd79c49d5e492995f2"}, {file = "virtualenv-20.26.6.tar.gz", hash = "sha256:280aede09a2a5c317e409a00102e7077c6432c5a38f0ef938e643805a7ad2c48"}, ] [package.dependencies] distlib = ">=0.3.7,<1" filelock = ">=3.12.2,<4" platformdirs = ">=3.9.1,<5" [package.extras] docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8) ; platform_python_implementation == \"PyPy\" or platform_python_implementation == \"CPython\" and sys_platform == \"win32\" and python_version >= \"3.13\"", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10) ; platform_python_implementation == \"CPython\""] [[package]] name = "werkzeug" version = "3.1.3" description = "The comprehensive WSGI web application library." optional = false python-versions = ">=3.9" groups = ["dev"] files = [ {file = "werkzeug-3.1.3-py3-none-any.whl", hash = "sha256:54b78bf3716d19a65be4fceccc0d1d7b89e608834989dfae50ea87564639213e"}, {file = "werkzeug-3.1.3.tar.gz", hash = "sha256:60723ce945c19328679790e3282cc758aa4a6040e4bb330f53d30fa546d44746"}, ] [package.dependencies] MarkupSafe = ">=2.1.1" [package.extras] watchdog = ["watchdog (>=2.3)"] [[package]] name = "xmltodict" version = "0.13.0" description = "Makes working with XML feel like you are working with JSON" optional = false python-versions = ">=3.4" groups = ["dev"] files = [ {file = "xmltodict-0.13.0-py2.py3-none-any.whl", hash = "sha256:aa89e8fd76320154a40d19a0df04a4695fb9dc5ba977cbb68ab3e4eb225e7852"}, {file = "xmltodict-0.13.0.tar.gz", hash = "sha256:341595a488e3e01a85a9d8911d8912fd922ede5fecc4dce437eb4b6c8d037e56"}, ] [metadata] lock-version = "2.1" python-versions = "^3.12" content-hash = "271e47c0f480bfd99d294c43c634c02613abc61d2652e9e39c76ac1e55a520f0" NRLF-3.0.31/poetry.toml000066400000000000000000000000401511201605300145420ustar00rootroot00000000000000[virtualenvs] in-project = true NRLF-3.0.31/postman_collection.json000066400000000000000000001041351511201605300171240ustar00rootroot00000000000000{ "info": { "_postman_id": "b5669e36-79c3-417d-b459-a71cd54a3009", "name": "NRLF", "description": "Data:-\n\nCustodian is Y05868, NHS number is 3495456481, Pointer type 736253002 (Mental Health Crisis Plan)\n\nInstructions:-\n\nThere are 2 sets of tests Producer, with all the Producer interactions and Consumer, with all the Consumer interactions.\n\nUse POST Create to create some pointers so you can then search, read, update and delete them. Over time pointers may be deleted so its best to use a Search command to see what pointers are available and note down their 'id' so they can be used within other interactions.\n\nFor POST Create Supersede then a pointer to supersede should be identified and updated within the 'relatesTo' segment within the request. The supersede must be for the same patient and pointer type.\n\nThe document attachment is purely a test website. The postman collection will not retrieve documents as SSP is required for retrieval.\n\nNo token is needed when sending the request as the Sandbox does not require this.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "33474807", "_collection_link": "https://cellsigma.postman.co/workspace/My-Workspace~a0c5ee7e-14ee-44f6-8976-a715e9e3c391/collection/33474807-b5669e36-79c3-417d-b459-a71cd54a3009?action=share&source=collection_link&creator=33474807" }, "item": [ { "name": "Producer", "item": [ { "name": "POST Create Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "create-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"current\",\n \"type\": {\n \"coding\": [\n {\n \"code\": \"736253002\",\n \"display\": \"Mental health crisis plan\",\n \"system\": \"http://snomed.info/sct\"\n }\n ]\n },\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"734163000\",\n \"display\": \"Care plan\",\n \"system\": \"http://snomed.info/sct\"\n }\n ]\n }\n ],\n \"subject\": {\n \"identifier\": {\n \"value\": \"3495456481\",\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\"\n }\n },\n \"date\": \"2024-10-29T13:23:28+00:00\",\n \"author\": [\n {\n \"identifier\": {\n \"value\": \"Y05868\",\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"\n }\n }\n ],\n \"custodian\": {\n \"identifier\": {\n \"value\": \"Y05868\",\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"\n }\n },\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"application/pdf\",\n \"language\": \"en-US\",\n \"url\": \"https://example.org/my-doc.pdf\",\n \"creation\": \"2024-10-28T15:26:00+01:00\",\n \"hash\": \"2jmj7l5rSw0yVb/vlWAYkK/YBwk=\",\n \"title\": \"Physical\",\n \"size\":\"1000\"\n },\n \"format\": {\n \"code\": \"urn:nhs-ic:unstructured\",\n \"display\": \"Unstructured Document\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode\"\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability\",\n \"code\": \"static\",\n \"display\": \"Static\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"context\": {\n \"period\": {\n \"start\": \"2024-03-06T13:34:00+01:00\",\n \"end\":\"2026-03-06T13:34:00+01:00\"\n },\n \"practiceSetting\": {\n \"coding\": [\n {\n \"system\": \"http://snomed.info/sct\",\n \"code\": \"788002001\",\n \"display\": \"Adult mental health service\"\n }\n ]\n },\n \"related\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhsSpineASID\",\n \"value\": \"200000001991\"\n }\n }\n ]\n },\n \"resourceType\": \"DocumentReference\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference" ] } }, "response": [] }, { "name": "POST Create Supersede Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "create-supersede-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"current\",\n \"type\": {\n \"coding\": [\n {\n \"code\": \"736253002\",\n \"display\": \"Mental health crisis plan\",\n \"system\": \"http://snomed.info/sct\"\n }\n ]\n },\n \"relatesTo\": [\n {\n \"code\": \"replaces\",\n \"target\": {\n \"type\": \"DocumentReference\",\n \"identifier\": {\n \"value\": \"Y05868-98dbebaf-c32d-4771-b5ac-f0610a024c31\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"734163000\",\n \"display\": \"Care plan\",\n \"system\": \"http://snomed.info/sct\"\n }\n ]\n }\n ],\n \"subject\": {\n \"identifier\": {\n \"value\": \"3495456481\",\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\"\n }\n },\n \"date\": \"2024-10-29T13:23:28+00:00\",\n \"author\": [\n {\n \"identifier\": {\n \"value\": \"Y05868\",\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"\n }\n }\n ],\n \"custodian\": {\n \"identifier\": {\n \"value\": \"Y05868\",\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"\n }\n },\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"application/pdf\",\n \"language\": \"en-US\",\n \"url\": \"https://example.org/my-doc.pdf\",\n \"creation\": \"2024-10-28T15:26:00+01:00\",\n \"hash\": \"2jmj7l5rSw0yVb/vlWAYkK/YBwk=\",\n \"title\": \"Physical\",\n \"size\":\"1000\"\n },\n \"format\": {\n \"code\": \"urn:nhs-ic:unstructured\",\n \"display\": \"Unstructured Document\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode\"\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability\",\n \"code\": \"static\",\n \"display\": \"Static\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"context\": {\n \"period\": {\n \"start\": \"2024-03-06T13:34:00+01:00\",\n \"end\":\"2026-03-06T13:34:00+01:00\"\n },\n \"practiceSetting\": {\n \"coding\": [\n {\n \"system\": \"http://snomed.info/sct\",\n \"code\": \"788002001\",\n \"display\": \"Adult mental health service\"\n }\n ]\n },\n \"related\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhsSpineASID\",\n \"value\": \"200000001991\"\n }\n }\n ]\n },\n \"resourceType\": \"DocumentReference\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference" ] } }, "response": [] }, { "name": "PUT Update Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "PUT", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "update-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"current\",\n \"id\": \"Y05868-2341fb51-fa25-4190-802c-858768029765\",\n \"type\": {\n \"coding\": [\n {\n \"code\": \"736253002\",\n \"display\": \"Mental health crisis plan\",\n \"system\": \"http://snomed.info/sct\"\n }\n ]\n },\n \"masterIdentifier\": {\n \"system\": \"urn:ietf:rfc:3986\",\n \"value\": \"urn:oid:1.3.6.1.4.1.21367.2005.4.1\"\n },\n \"relatesTo\": [\n {\n \"code\": \"replaces\",\n \"target\": {\n \"type\": \"DocumentReference\",\n \"identifier\": {\n \"value\": \"Y05868-df3f632a-94a5-4f9b-81dd-b76df52273b3\"\n }\n }\n }\n ],\n \"category\": [\n {\n \"coding\": [\n {\n \"code\": \"734163000\",\n \"display\": \"Care plan\",\n \"system\": \"http://snomed.info/sct\"\n }\n ]\n }\n ],\n \"subject\": {\n \"identifier\": {\n \"value\": \"3495456481\",\n \"system\": \"https://fhir.nhs.uk/Id/nhs-number\"\n }\n },\n \"date\": \"2025-01-29T13:23:28+00:00\",\n \"author\": [\n {\n \"identifier\": {\n \"value\": \"RJ11\",\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"\n }\n }\n ],\n \"custodian\": {\n \"identifier\": {\n \"value\": \"Y05868\",\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\"\n }\n },\n \"content\": [\n {\n \"attachment\": {\n \"contentType\": \"application/pdf\",\n \"language\": \"en-US\",\n \"url\": \"https://example.org/my-doc-updated.pdf\",\n \"creation\": \"2025-01-27T15:26:00+01:00\",\n \"hash\": \"2jmj7l5rSw0yVb/vlWAYkK/YBwk=\",\n \"title\": \"Physical\",\n \"size\":\"1000\"\n },\n \"format\": {\n \"code\": \"urn:nhs-ic:unstructured\",\n \"display\": \"Unstructured Document\",\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode\"\n },\n \"extension\": [\n {\n \"url\": \"https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability\",\n \"valueCodeableConcept\": {\n \"coding\": [\n {\n \"system\": \"https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability\",\n \"code\": \"static\",\n \"display\": \"Static\"\n }\n ]\n }\n }\n ]\n }\n ],\n \"context\": {\n \"period\": {\n \"start\": \"2025-03-06T13:34:00+01:00\",\n \"end\":\"2026-04-06T13:34:00+01:00\"\n },\n \"practiceSetting\": {\n \"coding\": [\n {\n \"system\": \"http://snomed.info/sct\",\n \"code\": \"788002001\",\n \"display\": \"Adult mental health service\"\n }\n ]\n },\n \"related\": [\n {\n \"identifier\": {\n \"system\": \"https://fhir.nhs.uk/Id/nhsSpineASID\",\n \"value\": \"200000001991\"\n }\n }\n ]\n },\n \"resourceType\": \"DocumentReference\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference/Y05868-2341fb51-fa25-4190-802c-858768029765", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference", "Y05868-2341fb51-fa25-4190-802c-858768029765" ] } }, "response": [] }, { "name": "POST Search Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "POST", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "search-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "body": { "mode": "raw", "raw": "{\"subject:identifier\":\"https://fhir.nhs.uk/Id/nhs-number|3495456481\",\n\"type\":\"http://snomed.info/sct|736253002\"}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference/_search", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference", "_search" ] } }, "response": [] }, { "name": "GET Search Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "search-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|3495456481&type=http://snomed.info/sct|736253002", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference" ], "query": [ { "key": "subject:identifier", "value": "https://fhir.nhs.uk/Id/nhs-number|3495456481" }, { "key": "type", "value": "http://snomed.info/sct|736253002" } ] } }, "response": [] }, { "name": "GET Read Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "GET", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "read-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference/Y05868-8552f0d6-c915-4f6a-810d-9d3da3943c94", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference", "Y05868-8552f0d6-c915-4f6a-810d-9d3da3943c94" ] } }, "response": [] }, { "name": "DEL Delete Pointer", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "method": "DELETE", "header": [ { "key": "nhsd-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "x-correlation-id", "value": "nrl-producer-api-sandbox", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" }, { "key": "Authorization", "value": "auth", "type": "text" }, { "key": "x-request-id", "value": "delete-pointer-test", "type": "text" }, { "key": "accept", "value": "version=1.0", "type": "text" } ], "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/producer/FHIR/R4/DocumentReference/Y05868-aae5cc20-9074-43d4-babc-94eddf890dfe", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "producer", "FHIR", "R4", "DocumentReference", "Y05868-aae5cc20-9074-43d4-babc-94eddf890dfe" ] } }, "response": [] } ] }, { "name": "Consumer", "item": [ { "name": "GET Search", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "SazYuPaGhA1uaWr3HCq7U7cZilhM", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "version=1.0", "type": "text" }, { "key": "x-correlation-id", "value": "consumer-get-search", "type": "text" }, { "key": "x-request-id", "value": "search-pointer", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" } ], "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|3495456481&type=http://snomed.info/sct|736253002&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|Y05868", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "consumer", "FHIR", "R4", "DocumentReference" ], "query": [ { "key": "subject:identifier", "value": "https://fhir.nhs.uk/Id/nhs-number|3495456481" }, { "key": "type", "value": "http://snomed.info/sct|736253002" }, { "key": "custodian:identifier", "value": "https://fhir.nhs.uk/Id/ods-organization-code|Y05868" }, { "key": "next-page-token", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "POST Search", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "gwAJySqy0SySAHwN71GixPSbCLHV", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json; version=1.0", "type": "text" }, { "key": "x-correlation-id", "value": "consumer-post-search", "type": "text" }, { "key": "x-request-id", "value": "search-pointer", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" } ], "body": { "mode": "raw", "raw": "{\"type\":\"http://snomed.info/sct|736253002\",\n\"subject:identifier\":\"https://fhir.nhs.uk/Id/nhs-number|3495456481\",\n\"custodian:identifier\":\"https://fhir.nhs.uk/Id/ods-organization-code|Y05868\"}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference/_search", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "consumer", "FHIR", "R4", "DocumentReference", "_search" ] } }, "response": [] }, { "name": "GET count", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "bpt9fauEItb5fn1xEWJOy7aQsGxn", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "version=1.0", "type": "text" }, { "key": "x-correlation-id", "value": "consumer-count", "type": "text" }, { "key": "x-request-id", "value": "count-pointer", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" } ], "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference/_count?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|3495456481", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "consumer", "FHIR", "R4", "DocumentReference", "_count" ], "query": [ { "key": "subject:identifier", "value": "https://fhir.nhs.uk/Id/nhs-number|3495456481" } ] } }, "response": [] }, { "name": "GET Read", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "bpt9fauEItb5fn1xEWJOy7aQsGxn", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "version=1.0", "type": "text" }, { "key": "x-correlation-id", "value": "consumer-read", "type": "text" }, { "key": "x-request-id", "value": "read-pointer", "type": "text" }, { "key": "NHSD-End-User-Organisation-ODS", "value": "Y05868", "type": "text" } ], "url": { "raw": "https://sandbox.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference/Y05868-26b5c8bf-864b-4eb1-928f-4bafb6d9b7b8", "protocol": "https", "host": ["sandbox", "api", "service", "nhs", "uk"], "path": [ "record-locator", "consumer", "FHIR", "R4", "DocumentReference", "Y05868-26b5c8bf-864b-4eb1-928f-4bafb6d9b7b8" ] } }, "response": [] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.globals.set('now', new Date().toISOString().substr(0, 19));", "pm.globals.set('randomNumber', Math.floor(Math.random() * 100));", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [""] } } ], "variable": [ { "key": "APIGEE_BASE_URL", "value": "https://int.api.service.nhs.uk", "type": "string" }, { "key": "APIGEE_PRODUCER_URL", "value": "{{APIGEE_BASE_URL}}/nrl-producer-api/FHIR/R4", "type": "string" }, { "key": "APIGEE_CONSUMER_URL", "value": "{{APIGEE_BASE_URL}}/nrl-consumer-api/FHIR/R4", "type": "string" }, { "key": "ODS_CODE", "value": "!! CHANGE THIS VALUE !!", "type": "string" }, { "key": "ACCESS_TOKEN", "value": "!! CHANGE THIS VALUE !!" }, { "key": "DOCUMENT_TYPE", "value": "{{SNOMED_MENTAL_HEALTH_CRISIS_PLAN}}", "type": "string" }, { "key": "DOCUMENT_TYPE_SET", "value": "https%3A%2F%2Fsnomed.info%2Fict%7C{{DOCUMENT_TYPE}}", "type": "string" }, { "key": "VERSION", "value": "1", "type": "string" }, { "key": "X_REQUEST_ID", "value": "DEMO", "type": "string" }, { "key": "X_CORRELATION_ID", "value": "DEMO", "type": "string" }, { "key": "NHSD_CORRELATION_ID", "value": "{{X_CORRELATION_ID}}", "type": "string" }, { "key": "NHS_NUMBER", "value": "9278693472", "type": "string" }, { "key": "NHS_NUMBER_ALT", "value": "9448646348", "type": "string" }, { "key": "NHS_NUMBER_MISSING", "value": "9000000033", "type": "string" }, { "key": "SUBJECT", "value": "https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C{{NHS_NUMBER}}", "type": "string" }, { "key": "LOCAL_DOCUMENT_ID", "value": "DEMO_0000000001", "type": "string" }, { "key": "DOCUMENT_ID", "value": "{{ODS_CODE}}-{{LOCAL_DOCUMENT_ID}}", "type": "string" }, { "key": "SNOMED_CODE_APPOINTMENT", "value": "749001000000101", "type": "string" }, { "key": "SNOMED_EMERGENCY_HEALTH_CARE_PLAN", "value": "887701000000100", "type": "string" }, { "key": "SNOMED_MENTAL_HEALTH_CRISIS_PLAN", "value": "736253002", "type": "string" }, { "key": "SNOMED_END_OF_LIFE_CARE_COORDINATION_SUMMARY", "value": "861421000000109", "type": "string" }, { "key": "ACCEPT", "value": "application/json; version={{VERSION}}", "type": "string" } ] } NRLF-3.0.31/pyproject.toml000066400000000000000000000047401511201605300152520ustar00rootroot00000000000000[tool.poetry] name = "nrlf-api" version = "1.0.0" description = "" authors = ["NHS Digital"] license = "MIT" readme = "README.md" package-mode = false [tool.poetry.dependencies] python = "^3.12" nhs-number = "1.3.4" aws-lambda-powertools = "^2.35.1" requests = "^2.32.4" boto3-stubs = {extras = ["dynamodb", "firehose", "kinesis", "lambda", "rds", "s3"], version = "^1.40.59"} pyjwt = "^2.8.0" pydantic = "^2.9.2" pydantic-settings = "^2.5.2" [tool.poetry.group.dev.dependencies] layers = {path = "layer", develop = true} nrlf-converter = {url = "https://github.com/NHSDigital/nrlf-converter/releases/download/0.0.9/nrlf_converter-0.0.9-py3-none-any.whl"} pytest = "^8.4.1" pytest-mock = "^3.12.0" pytest-cov = "^5.0.0" boto3 = "^1.40.66" sh = "^2.0.6" moto = {extras = ["dynamodb", "s3"], version = "^5.1.9"} behave = "^1.2.6" pyyaml = "^6.0.1" pre-commit = "^4.2.0" ruff = "^0.3.2" fire = "^0.7.0" gherkin-official = "^28.0.0" allure-pytest = "^2.13.5" allure-behave = "^2.13.3" freezegun = "^1.5.4" pytest-env = "^1.1.3" matplotlib = "^3.8.4" freeze-uuid = "^0.3.0" datamodel-code-generator = "^0.26.1" [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" [tool.isort] profile = "black" [tool.sqlfluff.core] dialect = "postgres" [tool.sqlfluff.rules.capitalisation.identifiers] capitalisation_policy = "consistent" [tool.ruff] line-length = 100 [tool.ruff.lint] select = [ "E", # Pycodestyle Error "W", # Pycodestyle Warning "F", # Pyflakes "I", # isort "UP", # pyupgrade "B", # flake8-bugbear "C4", # flake8-comprehensions "DTZ", # flake8-datetimez "PIE", # flake8-pie "T20", # flake8-print "PYI", # flake8-pyi "PT", # flake8-pytest-style "RET", # flake8-return "SIM", # flake8-simplify "TID", # flake8-tidy-imports "PL", # pylint "PERF", # perflint ] ignore = [ "E501", # line too long "PLR2004" # Magic values ] [tool.ruff.format] docstring-code-format = true docstring-code-line-length = 80 [tool.coverage.run] branch = true omit = [ "*/tests/*", "conftest.py" ] [tool.pytest.ini_options] env = [ "D:AWS_REGION=eu-west-2", "D:AWS_DEFAULT_REGION=eu-west-2", "D:ENVIRONMENT=pytest", "PREFIX=nrlf", "SPLUNK_INDEX=logs", "SOURCE=app", "AUTH_STORE=auth-store", "TABLE_NAME=unit-test-document-pointer" ] pythonpath = [".", "./scripts"] [tool.datamodel-codegen] target-python-version = "3.12" use-annotated = true use-double-quotes = true enum-field-as-literal = "all" NRLF-3.0.31/reports/000077500000000000000000000000001511201605300140275ustar00rootroot00000000000000NRLF-3.0.31/reports/calculate_pointer_stats.py000066400000000000000000000166471511201605300213320ustar00rootroot00000000000000import json from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire from nrlf.consumer.fhir.r4.model import DocumentReference from nrlf.core.logger import logger from nrlf.core.validators import DocumentReferenceValidator type PatientCounter = dict[int, int] type TypePatientCounter = dict[str, PatientCounter] type OrgTypePatientCounter = dict[str, TypePatientCounter] dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") logger.setLevel("ERROR") def _calc_type_stats(producer: str, type_str: str, stats: dict[str, Any]) -> None: stats["type_counts"] = stats.get("type_counts", {}) stats["type_counts"][type_str] = stats["type_counts"].get(type_str, 0) + 1 stats["producer_by_type_counts"][producer] = stats["producer_by_type_counts"].get( producer, {} ) stats["producer_by_type_counts"][producer][type_str] = ( stats["producer_by_type_counts"][producer].get(type_str, 0) + 1 ) def _calc_date_stats(created_on: str, stats: dict[str, Any]) -> None: month_created = created_on[:7] if created_on else "not-set" if month_created not in stats["created_by_month"]: stats["created_by_month"][month_created] = 1 else: stats["created_by_month"][month_created] += 1 def _calc_patient_counters( patient_number: str, producer: str, type_str: str, patient_counters: dict[str, Any] ) -> None: if patient_number not in patient_counters: patient_counters[patient_number] = { "count": 1, "types": {type_str: 1}, "orgs": {producer: {type_str: 1}}, } else: patient_counters[patient_number]["count"] += 1 patient_counters[patient_number]["types"][type_str] = ( patient_counters[patient_number]["types"].get(type_str, 0) + 1 ) patient_counters[patient_number]["orgs"][producer] = patient_counters[ patient_number ]["orgs"].get(producer, {}) patient_counters[patient_number]["orgs"][producer][type_str] = ( patient_counters[patient_number]["orgs"][producer].get(type_str, 0) + 1 ) def _get_patient_stats(patient_counters: dict[str, Any]) -> dict[str, Any]: total_pointers = 0 max_pointers = 0 min_pointers = 0 counts_with_pointers: PatientCounter = {} counts_with_types: TypePatientCounter = {} counts_with_orgs_types: OrgTypePatientCounter = {} for counters in patient_counters.values(): count = counters["count"] total_pointers += count max_pointers = max(max_pointers, count) min_pointers = min(min_pointers, count) if min_pointers else count counts_with_pointers[count] = counts_with_pointers.get(count, 0) + 1 for type, type_count in counters["types"].items(): counts_with_types[type] = counts_with_types.get(type, {}) counts_with_types[type][type_count] = ( counts_with_types[type].get(type_count, 0) + 1 ) for org, types in counters["orgs"].items(): counts_with_orgs_types[org] = counts_with_orgs_types.get(org, {}) for type, type_count in types.items(): counts_with_orgs_types[org][type] = counts_with_orgs_types[org].get( type, {} ) counts_with_orgs_types[org][type][type_count] = ( counts_with_orgs_types[org][type].get(type_count, 0) + 1 ) return { "avg_pointers_per_patient": ( total_pointers / len(patient_counters) if patient_counters else 0 ), "max_pointers_per_patient": max_pointers, "min_pointers_per_patient": min_pointers, "patient_counts_with_pointers": counts_with_pointers, "patient_counts_with_types": counts_with_types, "patient_counts_with_org_types": counts_with_orgs_types, } def _scan_and_get_stats( table_name: str, report_output_file: str = "" ) -> dict[str, float | int]: """ Calculate stats from the pointers table. Parameters: - table_name: The name of the pointers table to use. """ params: dict[str, Any] = { "TableName": table_name, "PaginationConfig": {"PageSize": 50}, } total_scanned_count = 0 start_time = datetime.now(tz=timezone.utc) stats: dict[str, Any] = { "fails_model": 0, "fails_validation": 0, "total_pointers": 0, "type_counts": {}, "producer_by_type_counts": {}, "created_by_month": {}, "patients_with_pointers": 0, "avg_pointers_per_patient": 0, "max_pointers_per_patient": 0, "min_pointers_per_patient": 0, "patient_counts_with_pointers": {}, "patient_counts_with_types": {}, "patient_counts_with_org_types": {}, } patient_counters: dict[str, Any] = {} for page in paginator.paginate(**params): for item in page["Items"]: document = item.get("document", {}).get("S", "") created_on = item.get("created_on", {}).get("S", "") # Do validations try: docref = DocumentReference.model_validate_json(document) except Exception: stats["fails_model"] += 1 continue result = DocumentReferenceValidator().validate(data=docref) if not result.is_valid: stats["fails_validation"] += 1 patient_number = ( docref.subject.identifier.value if docref.subject and docref.subject.identifier and docref.subject.identifier.value else "unknown" ) producer = ( docref.custodian.identifier.value if docref.custodian and docref.custodian.identifier and docref.custodian.identifier.value else "unknown" ) type_coding = ( docref.type.coding[0] if docref.type and docref.type.coding else None ) type_str = ( f"{type_coding.system}|{type_coding.code}" if type_coding else "unknown" ) _calc_type_stats(producer, type_str, stats) _calc_date_stats(created_on, stats) _calc_patient_counters(patient_number, producer, type_str, patient_counters) total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) # noqa if total_scanned_count % 100000 == 0: print(f"scanned={total_scanned_count}") # noqa end_time = datetime.now(tz=timezone.utc) stats["total_pointers"] = total_scanned_count stats["patients_with_pointers"] = len(patient_counters) stats["avg_pointers_per_patient"] = ( total_scanned_count / stats["patients_with_pointers"] if stats["patients_with_pointers"] > 0 else 0 ) patient_stats = _get_patient_stats(patient_counters) stats.update(patient_stats) print("Done") # noqa if report_output_file: with open(report_output_file, "w") as f: json.dump(stats, f, indent=2) print(f"Stats saved to {report_output_file}") # noqa return { "scanned_count": total_scanned_count, "took-secs": timedelta.total_seconds(end_time - start_time), "stats": json.dumps(stats, indent=2), } if __name__ == "__main__": fire.Fire(_scan_and_get_stats) NRLF-3.0.31/reports/count_pointers_for_custodian.py000066400000000000000000000034431511201605300223770ustar00rootroot00000000000000from datetime import datetime, timedelta, timezone from typing import Any, Optional import boto3 import fire dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") def _count_pointers( table_name: str, ods_code: str, created_date: Optional[str] = None ) -> dict[str, float]: """ Count the number of pointers for a given custodian (ODS code) in the pointers table. Parameters: - table_name: The name of the pointers table to use. - ods_code: The custodian ODS code to find pointers for. - created_date: The created date to filter pointers on. (optional) """ print(f"Counting pointers for {ods_code} in table {table_name}....") # noqa params: dict[str, Any] = { "TableName": table_name, "FilterExpression": "custodian = :ods_code", "ExpressionAttributeValues": {":ods_code": {"S": ods_code}}, "Select": "COUNT", "PaginationConfig": {"PageSize": 100}, } if created_date: params["FilterExpression"] += " AND starts_with(created_on, :created_date)" params["ExpressionAttributeValues"][":created_date"] = {"S": created_date} custodian_pointers_count = 0 total_scanned_count = 0 start_time = datetime.now(tz=timezone.utc) for page in paginator.paginate(**params): custodian_pointers_count += page["Count"] total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) # noqa end_time = datetime.now(tz=timezone.utc) print(" Done") # noqa return { "items_found": custodian_pointers_count, "scanned_count": total_scanned_count, "took-secs": timedelta.total_seconds(end_time - start_time), } if __name__ == "__main__": fire.Fire(_count_pointers) NRLF-3.0.31/reports/find_duplicate_pointers.py000066400000000000000000000074111511201605300213010ustar00rootroot00000000000000import json from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire from nrlf.core.logger import logger dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") logger.setLevel("ERROR") REQUIRED_ATTRIBUTES = [ "nhs_number", "custodian", "id", "master_identifier", "type_id", "created_on", ] def _get_duplicates( table_name: str, custodians: str | tuple[str], filename: str = "duplicates" ) -> Any: """ Get masterids for duplicate pointers in the given table for a list of custodians. Parameters: - table_name: The name of the pointers table to use. - custodians: The ODS codes of the custodian(s) to check. - filename: A name for the output text file containing the list of affected pointers. """ custodian_list = ( custodians.split(",") if isinstance(custodians, str) else list(custodians) ) print( # noqa f"Finding duplicate pointers for custodians {custodian_list} in table {table_name}...." ) required_attributes = REQUIRED_ATTRIBUTES expression_names_str = ",".join( [f":param{custodian}" for custodian in custodian_list] ) expression_values_list = { f":param{custodian}": {"S": custodian} for custodian in custodian_list } params: dict[str, Any] = { "TableName": table_name, "PaginationConfig": {"PageSize": 50}, "FilterExpression": f"custodian IN ({expression_names_str})", "ExpressionAttributeValues": expression_values_list, "ProjectionExpression": ",".join(required_attributes), } pointers_by_key = {} total_scanned_count = 0 duplicate_count = 0 duplicates_set = set() start_time = datetime.now(tz=timezone.utc) for page in paginator.paginate(**params): for item in page["Items"]: pointer_id = item.get("id", {}).get("S", "no-id") pointer_type = item.get("type_id", {}).get("S", "no-type") master_id = item.get("master_identifier", {}).get("S", "no-master-id") custodian = item.get("custodian", {}).get("S", "no-custodian") patient_id = item.get("nhs_number", {}).get("S", "no-patient-id") created_on = item.get("created_on", {}).get("S", "no-creation-datetime") pointer_data = { "id": pointer_id, "master_id": master_id, "datetime": created_on, } px_type_ods_key = f"{custodian}-{patient_id}-{pointer_type}" if px_type_ods_key not in pointers_by_key: pointers_by_key[px_type_ods_key] = [pointer_data] else: pointers_by_key[px_type_ods_key].append(pointer_data) duplicate_count += 1 duplicates_set.add(px_type_ods_key) total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) # noqa if total_scanned_count % 100000 == 0: print( # noqa f"scanned={total_scanned_count} found={duplicate_count} potential duplicates " ) end_time = datetime.now(tz=timezone.utc) print(" Table scan completed") # noqa output_pointers = {} for key in sorted(duplicates_set): output_pointers[key] = pointers_by_key[key] print(f"Writing pointers to file ./{filename}.txt ...") # noqa with open(f"{filename}.txt", "w") as f: f.write(json.dumps(output_pointers, indent=2)) return { "output_file": f"{filename}.txt", "duplicates-found": duplicate_count, "scanned-count": total_scanned_count, "took-secs": timedelta.total_seconds(end_time - start_time), } if __name__ == "__main__": fire.Fire(_get_duplicates) NRLF-3.0.31/reports/find_invalid_pointers.py000066400000000000000000000045221511201605300207550ustar00rootroot00000000000000from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire from nrlf.consumer.fhir.r4.model import DocumentReference from nrlf.core.logger import logger from nrlf.core.validators import DocumentReferenceValidator dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") logger.setLevel("ERROR") def _validate_document(document: str): docref = DocumentReference.model_validate_json(document) validator = DocumentReferenceValidator() result = validator.validate(data=docref) if not result.is_valid: raise RuntimeError("Failed to validate document: " + str(result.issues)) def _find_invalid_pointers(table_name: str) -> dict[str, float | int]: """ Find pointers in the given table that are invalid. Parameters: - table_name: The name of the pointers table to use. """ print(f"Finding invalid pointers in table {table_name}....") # noqa params: dict[str, Any] = { "TableName": table_name, "PaginationConfig": {"PageSize": 50}, } invalid_pointers = [] total_scanned_count = 0 start_time = datetime.now(tz=timezone.utc) for page in paginator.paginate(**params): for item in page["Items"]: pointer_id = item.get("id", {}).get("S") document = item.get("document", {}).get("S", "") try: _validate_document(document) except Exception as exc: invalid_pointers.append((pointer_id, exc)) total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) # noqa if total_scanned_count % 100000 == 0: print( # noqa f"scanned={total_scanned_count} invalid={len(invalid_pointers)}" ) end_time = datetime.now(tz=timezone.utc) print(" Done") # noqa print("Writing invalid_pointers to file ./invalid_pointers.txt ...") # noqa with open("invalid_pointers.txt", "w") as f: for _id, err in invalid_pointers: f.write(f"{_id}: {err}\n") return { "invalid_pointers": len(invalid_pointers), "scanned_count": total_scanned_count, "took-secs": timedelta.total_seconds(end_time - start_time), } if __name__ == "__main__": fire.Fire(_find_invalid_pointers) NRLF-3.0.31/reports/get_pointer_masterids_for_custodian.py000066400000000000000000000062441511201605300237200ustar00rootroot00000000000000import json import os from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire INCLUDE_PATIENT_IDS = os.environ.get("INCLUDE_PATIENT_IDS", "false").lower() == "true" dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") def _get_masterids_for_custodians(table_name: str, custodians: str | tuple[str]) -> Any: """ Get masterids for pointers in the given table for a list of custodians. Parameters: - table_name: The name of the pointers table to use. """ custodian_list = ( custodians.split(",") if isinstance(custodians, str) else list(custodians) ) print( # noqa f"Getting masterids for custodians {custodian_list} in table {table_name}...." ) required_attributes = ["id", "type_id", "master_identifier", "custodian"] if INCLUDE_PATIENT_IDS: required_attributes.append("nhs_number") expression_names_str = ",".join( [f":param{custodian}" for custodian in custodian_list] ) expression_values_list = { f":param{custodian}": {"S": custodian} for custodian in custodian_list } params: dict[str, Any] = { "TableName": table_name, "PaginationConfig": {"PageSize": 50}, "FilterExpression": f"custodian IN ({expression_names_str})", "ExpressionAttributeValues": expression_values_list, "ProjectionExpression": ",".join(required_attributes), } pointers_info: list[dict[str, str]] = [] total_scanned_count = 0 start_time = datetime.now(tz=timezone.utc) for page in paginator.paginate(**params): for item in page["Items"]: pointer_id = item.get("id", {}).get("S", "no-id") pointer_type = item.get("type_id", {}).get("S", "no-type") master_id = item.get("master_identifier", {}).get("S", "no-master-id") custodian = item.get("custodian", {}).get("S", "no-custodian") patient_id = item.get("nhs_number", {}).get("S", "no-patient-id") pointers_info.append( { "nrl-id": pointer_id, "pointer-type": pointer_type, "master_identifier": master_id, "custodian": custodian, "patient_id": patient_id if INCLUDE_PATIENT_IDS else "not-included", } ) total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) # noqa if total_scanned_count % 100000 == 0: print(f"scanned={total_scanned_count} found={len(pointers_info)} ") # noqa end_time = datetime.now(tz=timezone.utc) print(" Done") # noqa print(f"Writing pointers to file ./pointer-masterids.txt ...") # noqa with open("pointer-masterids.txt", "w") as f: f.write(json.dumps(pointers_info, indent=2)) return { "output-file": "pointer-masterids.txt", "pointers-found": len(pointers_info), "scanned-count": total_scanned_count, "took-secs": timedelta.total_seconds(end_time - start_time), } if __name__ == "__main__": fire.Fire(_get_masterids_for_custodians) NRLF-3.0.31/reports/tests/000077500000000000000000000000001511201605300151715ustar00rootroot00000000000000NRLF-3.0.31/reports/tests/test_calculate_pointer_stats.py000066400000000000000000000126061511201605300235220ustar00rootroot00000000000000from typing import Any from reports.calculate_pointer_stats import ( _calc_date_stats, _calc_patient_counters, _calc_type_stats, _get_patient_stats, ) def test_calc_type_stats_first_counts(): stats: dict[str, Any] = { "type_counts": {}, "producer_by_type_counts": {}, } producer = "test_producer" type_str = "test_type" _calc_type_stats(producer, type_str, stats) assert stats["type_counts"] == {type_str: 1} assert stats["producer_by_type_counts"] == {producer: {type_str: 1}} def test_calc_type_stats_increment_counts(): stats: dict[str, Any] = { "type_counts": {"test_type": 1}, "producer_by_type_counts": {"test_producer": {"test_type": 1}}, } producer = "test_producer" type_str = "test_type" _calc_type_stats(producer, type_str, stats) assert stats["type_counts"] == {type_str: 2} assert stats["producer_by_type_counts"] == {producer: {type_str: 2}} def test_calc_date_stats_first_counts(): stats: dict[str, Any] = { "created_by_month": {}, } created_on = "2025-01-01" _calc_date_stats(created_on, stats) assert stats["created_by_month"] == {"2025-01": 1} def test_calc_date_stats_increment_counts(): stats: dict[str, Any] = { "created_by_month": {"2025-01": 1}, } created_on = "2025-01-01" _calc_date_stats(created_on, stats) assert stats["created_by_month"] == {"2025-01": 2} def test_calc_patient_counters_first_counts(): patient_counters: dict[str, Any] = {} patient_number = "12345" producer = "test_producer" type_str = "test_type" _calc_patient_counters(patient_number, producer, type_str, patient_counters) assert patient_counters == { patient_number: { "count": 1, "types": {type_str: 1}, "orgs": {producer: {type_str: 1}}, } } def test_calc_patient_counters_increment_counts(): patient_counters: dict[str, Any] = { "12345": { "count": 1, "types": {"test_type": 1}, "orgs": {"test_producer": {"test_type": 1}}, } } patient_number = "12345" producer = "test_producer" type_str = "test_type" _calc_patient_counters(patient_number, producer, type_str, patient_counters) assert patient_counters == { "12345": { "count": 2, "types": {"test_type": 2}, "orgs": {"test_producer": {"test_type": 2}}, } } def test_calc_patient_counters_new_producer_same_type(): patient_counters: dict[str, Any] = { "12345": { "count": 1, "types": {"test_type": 1}, "orgs": {"test_producer": {"test_type": 1}}, } } patient_number = "12345" producer = "new_producer" type_str = "test_type" _calc_patient_counters(patient_number, producer, type_str, patient_counters) assert patient_counters == { "12345": { "count": 2, "types": {"test_type": 2}, "orgs": { "test_producer": {"test_type": 1}, "new_producer": {"test_type": 1}, }, } } def test_calc_patient_counters_new_producer_new_type(): patient_counters: dict[str, Any] = { "12345": { "count": 1, "types": {"test_type": 1}, "orgs": {"test_producer": {"test_type": 1}}, } } patient_number = "12345" producer = "new_producer" type_str = "new_test_type" _calc_patient_counters(patient_number, producer, type_str, patient_counters) assert patient_counters == { "12345": { "count": 2, "types": {"test_type": 1, "new_test_type": 1}, "orgs": { "test_producer": {"test_type": 1}, "new_producer": {"new_test_type": 1}, }, } } def test_calc_patient_counters_existing_producer_new_type(): patient_counters: dict[str, Any] = { "12345": { "count": 1, "types": {"test_type": 1}, "orgs": {"test_producer": {"test_type": 1}}, } } patient_number = "12345" producer = "test_producer" type_str = "new_test_type" _calc_patient_counters(patient_number, producer, type_str, patient_counters) assert patient_counters == { "12345": { "count": 2, "types": {"test_type": 1, "new_test_type": 1}, "orgs": {"test_producer": {"test_type": 1, "new_test_type": 1}}, } } def test_get_patient_stats(): patient_counters: dict[str, Any] = { "12345": { "count": 3, "types": {"type1": 2, "type2": 1}, "orgs": {"org1": {"type1": 1, "type2": 1}, "org2": {"type1": 1}}, }, "67890": { "count": 1, "types": {"type1": 1}, "orgs": {"org1": {"type1": 1}}, }, } result = _get_patient_stats(patient_counters) assert result["avg_pointers_per_patient"] == 2 assert result["max_pointers_per_patient"] == 3 assert result["min_pointers_per_patient"] == 1 assert result["patient_counts_with_pointers"] == {1: 1, 3: 1} assert result["patient_counts_with_types"] == { "type1": {1: 1, 2: 1}, "type2": {1: 1}, } assert result["patient_counts_with_org_types"] == { "org1": {"type1": {1: 2}, "type2": {1: 1}}, "org2": {"type1": {1: 1}}, } NRLF-3.0.31/resources/000077500000000000000000000000001511201605300143435ustar00rootroot00000000000000NRLF-3.0.31/resources/fhir/000077500000000000000000000000001511201605300152735ustar00rootroot00000000000000NRLF-3.0.31/resources/fhir/NRLF-ContentStability-ValueSet.json000066400000000000000000000017031511201605300237530ustar00rootroot00000000000000{ "resourceType": "ValueSet", "id": "NRLF-ContentStability", "url": "https://fhir.nhs.uk/England/ValueSet/England-NRLContentStability", "version": "1.0.0", "name": "NRLF Content Stability", "status": "draft", "date": "2025-01-28T00:00:00+00:00", "publisher": "NHS Digital", "contact": { "name": "NRL Team at NHS Digital", "telecom": { "system": "email", "value": "nrls@nhs.net", "use": "work" } }, "description": "A code from the NRL Content Stability coding system to represent the stability of the content.", "copyright": "Copyright 2024 NHS Digital.", "compose": { "include": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "concept": [ { "code": "static", "display": "Static" }, { "code": "dynamic", "display": "Dynamic" } ] } ] } } NRLF-3.0.31/resources/fhir/NRLF-DocumentReference.json000066400000000000000000000161321511201605300223250ustar00rootroot00000000000000{ "resourceType": "StructureDefinition", "url": "https://fhir.nhs.uk/England/StructureDefinition/NRLF-DocumentReference", "name": "NRLF-DocumentReference", "status": "draft", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "DocumentReference", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference", "derivation": "constraint", "differential": { "element": [ { "id": "DocumentReference.type", "path": "DocumentReference.type", "short": "Kind of document (SNOMED code)", "definition": "Specifies the particular kind of document referenced.", "comment": "Key metadata element describing the document that describes the exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.", "requirements": "NRL assigns permissions and indexes for search by document type and category.", "min": 1, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType" } }, { "id": "DocumentReference.type.coding", "path": "DocumentReference.type.coding", "min": 1, "max": "1" }, { "id": "DocumentReference.type.coding.system", "path": "DocumentReference.type.coding.system", "min": 1 }, { "id": "DocumentReference.type.coding.code", "path": "DocumentReference.type.coding.code", "min": 1 }, { "id": "DocumentReference.type.coding.display", "path": "DocumentReference.type.coding.display", "min": 1 }, { "id": "DocumentReference.category", "path": "DocumentReference.category", "requirements": "NRL assigns permissions and indexes for search by document type and category.", "min": 1, "max": "1", "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-NRLRecordCategory" } }, { "id": "DocumentReference.category.coding", "path": "DocumentReference.category.coding", "min": 1, "max": "1" }, { "id": "DocumentReference.category.coding.system", "path": "DocumentReference.category.coding.system", "min": 1 }, { "id": "DocumentReference.category.coding.code", "path": "DocumentReference.category.coding.code", "min": 1 }, { "id": "DocumentReference.category.coding.display", "path": "DocumentReference.category.coding.display", "min": 1 }, { "id": "DocumentReference.subject", "path": "DocumentReference.subject", "definition": "The patient to which the document pertains, as identified by NHS number.", "min": 1, "type": [ { "code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Patient"] } ] }, { "id": "DocumentReference.subject.identifier", "path": "DocumentReference.subject.identifier", "min": 1 }, { "id": "DocumentReference.subject.identifier.system", "path": "DocumentReference.subject.identifier.system", "min": 1, "fixedUri": "https://fhir.nhs.uk/Id/nhs-number" }, { "id": "DocumentReference.subject.identifier.value", "path": "DocumentReference.subject.identifier.value", "definition": "The patient's NHS number.", "min": 1 }, { "id": "DocumentReference.author", "path": "DocumentReference.author", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization" ] } ] }, { "id": "DocumentReference.author.identifier", "path": "DocumentReference.author.identifier", "min": 1 }, { "id": "DocumentReference.author.identifier.system", "path": "DocumentReference.author.identifier.system", "min": 1, "fixedUri": "https://fhir.nhs.uk/Id/ods-organization-code" }, { "id": "DocumentReference.author.identifier.value", "path": "DocumentReference.author.identifier.value", "definition": "The ODS code for the author organisation", "min": 1 }, { "id": "DocumentReference.custodian", "path": "DocumentReference.custodian", "min": 1 }, { "id": "DocumentReference.custodian.identifier", "path": "DocumentReference.custodian.identifier", "min": 1 }, { "id": "DocumentReference.custodian.identifier.system", "path": "DocumentReference.custodian.identifier.system", "min": 1, "fixedUri": "https://fhir.nhs.uk/Id/ods-organization-code" }, { "id": "DocumentReference.custodian.identifier.value", "path": "DocumentReference.custodian.identifier.value", "definition": "The ODS code of the custodian organisation.", "min": 1 }, { "id": "DocumentReference.content.attachment.contentType", "path": "DocumentReference.content.attachment.contentType", "min": 1 }, { "id": "DocumentReference.content.attachment.url", "path": "DocumentReference.content.attachment.url", "min": 1 }, { "id": "DocumentReference.content.format", "path": "DocumentReference.content.format", "min": 1, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-NRLFormatCode" } }, { "id": "DocumentReference.content.format.system", "path": "DocumentReference.content.format.system", "min": 1 }, { "id": "DocumentReference.content.format.code", "path": "DocumentReference.content.format.code", "min": 1 }, { "id": "DocumentReference.content.format.display", "path": "DocumentReference.content.format.display", "min": 1 }, { "id": "DocumentReference.context.practiceSetting", "path": "DocumentReference.context.practiceSetting", "min": 1, "binding": { "strength": "required", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-NRLPracticeSetting" } }, { "id": "DocumentReference.context.practiceSetting.coding.system", "path": "DocumentReference.context.practiceSetting.coding.system", "min": 1 }, { "id": "DocumentReference.context.practiceSetting.coding.code", "path": "DocumentReference.context.practiceSetting.coding.code", "min": 1 }, { "id": "DocumentReference.context.practiceSetting.coding.display", "path": "DocumentReference.context.practiceSetting.coding.display", "min": 1 } ] } } NRLF-3.0.31/resources/fhir/NRLF-FormatCode-ValueSet.json000066400000000000000000000022101511201605300224710ustar00rootroot00000000000000{ "resourceType": "ValueSet", "id": "NRLF-FormatCode", "url": "https://fhir.nhs.uk/England/ValueSet/England-NRLFormatCode", "version": "1.0.3", "name": "NRLF Format Code", "status": "draft", "date": "2025-05-22T00:00:00+00:00", "publisher": "NHS Digital", "contact": { "name": "NRL Team at NHS Digital", "telecom": { "system": "email", "value": "nrls@nhs.net", "use": "work" } }, "description": "A ValueSet that identifies the format of the content of the target document or record of a National Record Locator pointer.", "copyright": "Copyright © 2024 NHS Digital", "compose": { "include": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "concept": [ { "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, { "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, { "code": "urn:nhs-ic:structured", "display": "Structured Document" } ] } ] } } NRLF-3.0.31/resources/fhir/NRLF-PracticeSetting-ValueSet.json000066400000000000000000001517071511201605300235560ustar00rootroot00000000000000{ "resourceType": "ValueSet", "id": "NRLF-PracticeSetting", "url": "https://fhir.nhs.uk/England/ValueSet/England-NRLPracticeSetting", "version": "1.1.3", "name": "NRLF Record Practice Setting", "status": "draft", "date": "2025-05-22T00:00:00+00:00", "publisher": "NHS Digital", "contact": { "name": "NRL Team at NHS Digital", "telecom": { "system": "email", "value": "nrls@nhs.net", "use": "work" } }, "description": "A code from the SNOMED Clinical Terminology UK coding system to represent the NRL clinical practice setting.", "copyright": "Copyright 2024 NHS Digital. This value set includes content from SNOMED CT, which is copyright 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement.", "compose": { "include": [ { "system": "http://snomed.info/sct", "concept": [ { "code": "2471000175109", "display": "Employee health service" }, { "code": "828331000000102", "display": "Homeopathy service" }, { "code": "893041000000108", "display": "Transient ischaemic attack service" }, { "code": "893391000000101", "display": "Adult cystic fibrosis service" }, { "code": "828811000000104", "display": "Child psychiatry service" }, { "code": "741073001", "display": "Neonatal intensive care service" }, { "code": "3801000175108", "display": "Pediatric pulmonology service" }, { "code": "893521000000108", "display": "Respiratory physiology service" }, { "code": "892801000000107", "display": "Audiological medicine service" }, { "code": "892571000000101", "display": "Medical oncology service" }, { "code": "893421000000107", "display": "Tropical medicine service" }, { "code": "1060971000000108", "display": "General practice service" }, { "code": "907271000000106", "display": "Genetics laboratory service" }, { "code": "224891009", "display": "Healthcare services" }, { "code": "893771000000104", "display": "Paediatric respiratory medicine service" }, { "code": "893591000000106", "display": "Paediatric metabolic disease service" }, { "code": "892771000000109", "display": "Cardiothoracic transplantation service" }, { "code": "92151000000102", "display": "Mental health crisis resolution team" }, { "code": "893141000000109", "display": "Nephrology service" }, { "code": "829981000000108", "display": "Community child health service" }, { "code": "733459009", "display": "Cardiac rehabilitation service" }, { "code": "893971000000101", "display": "Paediatric burns care service" }, { "code": "931851000000100", "display": "Oral pathology service" }, { "code": "3771000175106", "display": "Pediatric gastroenterology service" }, { "code": "893621000000109", "display": "Paediatric ear nose and throat service" }, { "code": "828281000000107", "display": "Eating disorders service" }, { "code": "893121000000102", "display": "Spinal surgery service" }, { "code": "892751000000100", "display": "Clinical immunology and allergy service" }, { "code": "893601000000100", "display": "Paediatric medical oncology service" }, { "code": "3751000175100", "display": "Pediatric emergency medical service" }, { "code": "893951000000105", "display": "Paediatric cardiology service" }, { "code": "931831000000107", "display": "Oral medicine service" }, { "code": "829961000000104", "display": "Out of hours service" }, { "code": "911381000000108", "display": "Telehealthcare service" }, { "code": "828181000000101", "display": "Community sexual and reproductive health" }, { "code": "2451000175103", "display": "Perinatology service" }, { "code": "893851000000100", "display": "Paediatric neurosurgery service" }, { "code": "109201000000109", "display": "Substance misuse team" }, { "code": "893671000000108", "display": "Paediatric urology service" }, { "code": "932271000000104", "display": "Oral and maxillofacial surgery service" }, { "code": "444933003", "display": "Home hospice service" }, { "code": "444913002", "display": "Diabetes mellitus service" }, { "code": "892601000000108", "display": "Intermediate care service" }, { "code": "893801000000101", "display": "Paediatric ophthalmology service" }, { "code": "911231000000103", "display": "Remote health monitoring service" }, { "code": "893091000000103", "display": "Infectious diseases service" }, { "code": "893221000000106", "display": "Specialist rehabilitation service" }, { "code": "828381000000103", "display": "Well woman service" }, { "code": "907301000000109", "display": "National Health Service 111 service" }, { "code": "828511000000102", "display": "National Health Service 24" }, { "code": "893701000000107", "display": "Paediatric thoracic surgery service" }, { "code": "828861000000102", "display": "Programmed pulmonary rehabilitation service" }, { "code": "931781000000102", "display": "Acute medicine service" }, { "code": "827641000000101", "display": "Anticoagulant service" }, { "code": "893201000000102", "display": "Sport and exercise medicine service" }, { "code": "278032008", "display": "Preventive service" }, { "code": "892731000000107", "display": "Dental medicine service" }, { "code": "893451000000102", "display": "Respite care service" }, { "code": "2351000175106", "display": "Sports medicine service" }, { "code": "893271000000105", "display": "Medical virology service" }, { "code": "708168004", "display": "Mental health service" }, { "code": "708169007", "display": "Respiratory therapy service" }, { "code": "708171007", "display": "Vascular ultrasound service" }, { "code": "708170008", "display": "Nursing service" }, { "code": "708173005", "display": "Obstetric ultrasound service" }, { "code": "708172000", "display": "Cardiac ultrasound service" }, { "code": "708175003", "display": "Diagnostic imaging service" }, { "code": "708178001", "display": "Cytogenetics service" }, { "code": "708174004", "display": "Interventional radiology service" }, { "code": "708179009", "display": "Molecular pathology service" }, { "code": "708183009", "display": "Anatomic pathology service" }, { "code": "708182004", "display": "Histology service" }, { "code": "708180007", "display": "Dermatopathology service" }, { "code": "708187005", "display": "Surgical pathology service" }, { "code": "708185002", "display": "Virology service" }, { "code": "708184003", "display": "Clinical pathology service" }, { "code": "708188000", "display": "Serology service" }, { "code": "708194008", "display": "Blood bank service" }, { "code": "708196005", "display": "Hematology service" }, { "code": "708191000", "display": "Toxicology service" }, { "code": "708190004", "display": "Immunology service" }, { "code": "708193002", "display": "Coagulation service" }, { "code": "89301000000108", "display": "Community mental health team" }, { "code": "893301000000108", "display": "Local specialist rehabilitation service" }, { "code": "893651000000104", "display": "Paediatric clinical immunology and allergy service" }, { "code": "893171000000103", "display": "Clinical neurophysiology service" }, { "code": "711332004", "display": "Allergy service" }, { "code": "893151000000107", "display": "Nuclear medicine service" }, { "code": "894001000000107", "display": "Paediatric audiological medicine service" }, { "code": "892781000000106", "display": "Burns care service" }, { "code": "3781000175109", "display": "Pediatric infectious disease service" }, { "code": "893631000000106", "display": "Paediatric diabetic medicine service" }, { "code": "827621000000108", "display": "Addiction service" }, { "code": "893531000000105", "display": "Psychiatric intensive care service" }, { "code": "893881000000106", "display": "Paediatric maxillofacial surgery service" }, { "code": "893051000000106", "display": "Clinical allergy service" }, { "code": "893351000000109", "display": "Complex specialised rehabilitation service" }, { "code": "893001000000105", "display": "Clinical genetics service" }, { "code": "908981000000101", "display": "Remote triage and advice service" }, { "code": "931811000000104", "display": "Histopathology service" }, { "code": "1079481000000104", "display": "Perinatal psychiatry service" }, { "code": "893251000000101", "display": "Mental health recovery and rehabilitation service" }, { "code": "3531000175102", "display": "Geriatric service" }, { "code": "736622005", "display": "Aboriginal health service" }, { "code": "983641000000106", "display": "Fracture liaison service" }, { "code": "893711000000109", "display": "Neonatal critical care service" }, { "code": "828521000000108", "display": "National Health Service Direct" }, { "code": "892761000000102", "display": "Clinical haematology service" }, { "code": "901221000000102", "display": "Perinatal mental health service" }, { "code": "706902008", "display": "Mycology service" }, { "code": "706901001", "display": "Bacteriology service" }, { "code": "706903003", "display": "Mycobacteriology service" }, { "code": "706900000", "display": "Parasitology service" }, { "code": "893131000000100", "display": "Genitourinary medicine service" }, { "code": "413294000", "display": "Community health services" }, { "code": "413299005", "display": "Early years services" }, { "code": "828291000000109", "display": "Dispensing optometry service" }, { "code": "413331009", "display": "Voluntary services" }, { "code": "61831000000105", "display": "Periodontics service" }, { "code": "893231000000108", "display": "Podiatric surgery service" }, { "code": "893581000000109", "display": "Well baby service" }, { "code": "893911000000106", "display": "Paediatric gastrointestinal surgery service" }, { "code": "395104009", "display": "Cancer primary healthcare multidisciplinary team" }, { "code": "892711000000104", "display": "Gynaecological oncology service" }, { "code": "893331000000102", "display": "Dementia assessment service" }, { "code": "892611000000105", "display": "Hepatology service" }, { "code": "893681000000105", "display": "Paediatric trauma and orthopaedics service" }, { "code": "395086005", "display": "Community specialist palliative care" }, { "code": "395092004", "display": "Specialist palliative care" }, { "code": "710028007", "display": "Maxillofacial surgery service" }, { "code": "892811000000109", "display": "Adult mental health service" }, { "code": "828821000000105", "display": "Adolescent psychiatry service" }, { "code": "983341000000102", "display": "Pharmacy First service" }, { "code": "893431000000109", "display": "Trauma and orthopaedics service" }, { "code": "893781000000102", "display": "Paediatric plastic surgery service" }, { "code": "892581000000104", "display": "Learning disability service" }, { "code": "893661000000101", "display": "Paediatric clinical haematology service" }, { "code": "893311000000105", "display": "Haemophilia service" }, { "code": "373654008", "display": "Medical referral service" }, { "code": "893081000000100", "display": "Respiratory medicine service" }, { "code": "911221000000100", "display": "Remote care environment monitoring service" }, { "code": "409971007", "display": "Emergency medical services" }, { "code": "828371000000100", "display": "Well man service" }, { "code": "963151000000104", "display": "Diabetic medicine service" }, { "code": "893761000000106", "display": "Paediatric rheumatology service" }, { "code": "932841000000106", "display": "Public health dentistry service" }, { "code": "893861000000102", "display": "Paediatric neurodisability service" }, { "code": "92191000000105", "display": "Early intervention in psychosis team" }, { "code": "722424008", "display": "Physical medicine and rehabilitation service" }, { "code": "89311000000105", "display": "Crisis prevention assessment and treatment team" }, { "code": "722393008", "display": "Legal medicine service" }, { "code": "722352000", "display": "Vascular medicine service" }, { "code": "722170006", "display": "Chiropractic service" }, { "code": "722174002", "display": "Pulmonary medicine service" }, { "code": "722175001", "display": "Psychosomatic medicine service" }, { "code": "722176000", "display": "Dentistry service" }, { "code": "722140001", "display": "Physiotherapy service" }, { "code": "892561000000108", "display": "Medical ophthalmology service" }, { "code": "714088003", "display": "Midwifery service" }, { "code": "714089006", "display": "Community midwifery service" }, { "code": "3761000175103", "display": "Pediatric endocrinology service" }, { "code": "893611000000103", "display": "Paediatric epilepsy service" }, { "code": "893961000000108", "display": "Paediatric cardiac surgery service" }, { "code": "931841000000103", "display": "Oral microbiology service" }, { "code": "91901000000109", "display": "Assertive outreach team" }, { "code": "828191000000104", "display": "Dental hygiene service" }, { "code": "893031000000104", "display": "Clinical immunology service" }, { "code": "893381000000103", "display": "Clinical psychology service" }, { "code": "2461000175101", "display": "Pulmonary rehabilitation service" }, { "code": "893161000000105", "display": "Neurology service" }, { "code": "828201000000102", "display": "Dental surgery assistance service" }, { "code": "1079491000000102", "display": "Paediatric diabetes service" }, { "code": "893261000000103", "display": "Mental health dual diagnosis service" }, { "code": "310031001", "display": "Family planning service" }, { "code": "310032008", "display": "Intensive care service" }, { "code": "310030000", "display": "Endoscopy service" }, { "code": "310034009", "display": "Pediatric intensive care service" }, { "code": "310033003", "display": "Adult intensive care service" }, { "code": "310025004", "display": "Complementary therapy service" }, { "code": "310024000", "display": "Colposcopy service" }, { "code": "310027007", "display": "Mental health counseling service" }, { "code": "310026003", "display": "Counseling service" }, { "code": "310029005", "display": "Domiciliary visit service" }, { "code": "310028002", "display": "Diagnostic investigation service" }, { "code": "310020009", "display": "Hearing therapy service" }, { "code": "310022001", "display": "Clinical oncology service" }, { "code": "310021008", "display": "Assistive listening device service" }, { "code": "310023006", "display": "Radiotherapy service" }, { "code": "310017001", "display": "Pediatric hearing aid service" }, { "code": "310016005", "display": "Adult hearing aid service" }, { "code": "310015009", "display": "Hearing aid service" }, { "code": "310014008", "display": "Pediatric cochlear implant service" }, { "code": "310013002", "display": "Adult cochlear implant service" }, { "code": "310012007", "display": "Cochlear implant service" }, { "code": "310011000", "display": "Aural rehabilitation service" }, { "code": "310010004", "display": "Distraction test audiological screening service" }, { "code": "310019003", "display": "Tinnitus management service" }, { "code": "310018006", "display": "Speech-reading training service" }, { "code": "310001007", "display": "Anesthetic service" }, { "code": "310000008", "display": "Accident and Emergency service" }, { "code": "310003005", "display": "Child assessment service" }, { "code": "310002000", "display": "Assessment service" }, { "code": "310008001", "display": "Audiological screening service" }, { "code": "310009009", "display": "Neonatal audiological screening service" }, { "code": "310005003", "display": "Diagnostic audiology service" }, { "code": "310004004", "display": "Audiological service" }, { "code": "310007006", "display": "Pediatric diagnostic audiology service" }, { "code": "310006002", "display": "Adult diagnostic audiology service" }, { "code": "310085001", "display": "Drama therapy service" }, { "code": "310086000", "display": "Music therapy service" }, { "code": "310083008", "display": "Art therapy service" }, { "code": "310082003", "display": "Arts therapy services" }, { "code": "310084002", "display": "Dance therapy service" }, { "code": "310089007", "display": "Hospital-based podiatry service" }, { "code": "310087009", "display": "Podiatry service" }, { "code": "310088004", "display": "Community-based podiatry service" }, { "code": "310080006", "display": "Pharmacy service" }, { "code": "310081005", "display": "Professional allied to medicine service" }, { "code": "310079008", "display": "Neuropathology service" }, { "code": "310078000", "display": "Medical microbiology service" }, { "code": "310071006", "display": "Pain management service" }, { "code": "310070007", "display": "Special care baby service" }, { "code": "310072004", "display": "Acute pain service" }, { "code": "310073009", "display": "Palliative care service" }, { "code": "310076001", "display": "Clinical biochemistry service" }, { "code": "310074003", "display": "Pathology service" }, { "code": "310064001", "display": "Occupational health service" }, { "code": "310063007", "display": "Obstetrics service" }, { "code": "310066004", "display": "Pediatric service" }, { "code": "310065000", "display": "Open access service" }, { "code": "310068003", "display": "Pediatric neurology service" }, { "code": "310067008", "display": "Community pediatric service" }, { "code": "310069006", "display": "Pediatric oncology service" }, { "code": "310061009", "display": "Gynecology service" }, { "code": "310062002", "display": "Pregnancy termination service" }, { "code": "310060005", "display": "Obstetrics and gynecology service" }, { "code": "310099002", "display": "Child physiotherapy service" }, { "code": "310098005", "display": "Hospital-based physiotherapy service" }, { "code": "310091004", "display": "Community-based dietetics service" }, { "code": "310090003", "display": "Dietetics service" }, { "code": "310096009", "display": "Hospital-based occupational therapy service" }, { "code": "310094007", "display": "Community-based occupational therapy service" }, { "code": "310095008", "display": "Social services occupational therapy service" }, { "code": "310093001", "display": "Occupational therapy service" }, { "code": "310092006", "display": "Hospital-based dietetics service" }, { "code": "310120006", "display": "Mental handicap psychiatry service" }, { "code": "310121005", "display": "Psychogeriatric service" }, { "code": "310126000", "display": "Breast screening service" }, { "code": "310128004", "display": "Computerized tomography service" }, { "code": "310127009", "display": "Magnetic resonance imaging service" }, { "code": "310129007", "display": "Rehabilitation service" }, { "code": "310122003", "display": "Rehabilitation psychiatry service" }, { "code": "310123008", "display": "Psychology service" }, { "code": "310124002", "display": "Psychotherapy service" }, { "code": "310125001", "display": "Radiology service" }, { "code": "310117003", "display": "Child and adolescent psychiatry service" }, { "code": "310116007", "display": "Psychiatry service" }, { "code": "310119000", "display": "Liaison psychiatry service" }, { "code": "310118008", "display": "Forensic psychiatry service" }, { "code": "310114005", "display": "Community surgical fitting service" }, { "code": "310112009", "display": "Surgical fitting service" }, { "code": "310115006", "display": "Public health service" }, { "code": "310113004", "display": "Hospital surgical fitting service" }, { "code": "310110001", "display": "Hospital orthotics service" }, { "code": "310111002", "display": "Community orthotics service" }, { "code": "310109006", "display": "Orthotics service" }, { "code": "310108003", "display": "Community orthoptics service" }, { "code": "310105000", "display": "Optometry service" }, { "code": "310107008", "display": "Hospital orthoptics service" }, { "code": "310106004", "display": "Orthoptics service" }, { "code": "310104001", "display": "Child speech and language therapy service" }, { "code": "310103007", "display": "Hospital-based speech and language therapy service" }, { "code": "310102002", "display": "Community-based speech and language therapy service" }, { "code": "310141000", "display": "Thoracic surgery service" }, { "code": "310143002", "display": "Dental surgery service" }, { "code": "310142007", "display": "Cardiac surgery service" }, { "code": "310144008", "display": "General dental surgery service" }, { "code": "310145009", "display": "Oral surgery service" }, { "code": "310146005", "display": "Orthodontics service" }, { "code": "310147001", "display": "Pediatric dentistry service" }, { "code": "310148006", "display": "Restorative dentistry service" }, { "code": "310149003", "display": "Ear, nose and throat service" }, { "code": "310140004", "display": "Cardiothoracic surgery service" }, { "code": "310131003", "display": "Community rehabilitation service" }, { "code": "310130002", "display": "Head injury rehabilitation service" }, { "code": "310134006", "display": "Social services" }, { "code": "310135007", "display": "Social services department customer services" }, { "code": "310132005", "display": "Young disabled service" }, { "code": "310133000", "display": "Swallow clinic" }, { "code": "310139001", "display": "Breast surgery service" }, { "code": "310138009", "display": "Surgical service" }, { "code": "310136008", "display": "Social services department duty team" }, { "code": "310137004", "display": "Stroke service" }, { "code": "310101009", "display": "Speech and language therapy service" }, { "code": "310100005", "display": "Play therapy service" }, { "code": "734862008", "display": "Endodontic service" }, { "code": "734863003", "display": "Prosthodontic service" }, { "code": "310168000", "display": "Vascular surgery service" }, { "code": "310169008", "display": "Ultrasonography service" }, { "code": "310165002", "display": "Transplant surgery service" }, { "code": "310167005", "display": "Urology service" }, { "code": "310166001", "display": "Trauma surgery service" }, { "code": "310163009", "display": "Pediatric surgical service" }, { "code": "310164003", "display": "Plastic surgery service" }, { "code": "310161006", "display": "Orthopedic service" }, { "code": "310162004", "display": "Pancreatic surgery service" }, { "code": "310160007", "display": "Ophthalmology service" }, { "code": "310151004", "display": "Gastrointestinal surgery service" }, { "code": "310152006", "display": "General gastrointestinal surgery service" }, { "code": "310153001", "display": "Upper gastrointestinal surgery service" }, { "code": "310155008", "display": "Colorectal surgery service" }, { "code": "310150003", "display": "Endocrine surgery service" }, { "code": "310157000", "display": "Hand surgery service" }, { "code": "310156009", "display": "General surgical service" }, { "code": "310159002", "display": "Neurosurgical service" }, { "code": "310158005", "display": "Hepatobiliary surgical service" }, { "code": "828301000000108", "display": "Electrocardiography service" }, { "code": "310200001", "display": "Cytology service" }, { "code": "734920002", "display": "Diabetes mellitus education service" }, { "code": "829951000000102", "display": "Industrial therapy service" }, { "code": "931821000000105", "display": "School nursing service" }, { "code": "893941000000107", "display": "Paediatric dermatology service" }, { "code": "892741000000103", "display": "Clinical microbiology service" }, { "code": "893211000000100", "display": "Spinal injuries service" }, { "code": "92221000000103", "display": "Mental health home treatment team" }, { "code": "3621000175101", "display": "Rheumatology service" }, { "code": "408451000", "display": "Community learning disabilities team" }, { "code": "408452007", "display": "Behavioral intervention team" }, { "code": "408458006", "display": "Specialist multidisciplinary team" }, { "code": "893341000000106", "display": "Congenital heart disease service" }, { "code": "445449000", "display": "Acute care hospice service" }, { "code": "1078501000000104", "display": "Health visiting service" }, { "code": "893691000000107", "display": "Paediatric transplantation surgery service" }, { "code": "892621000000104", "display": "Hepatobiliary and pancreatic surgery service" }, { "code": "2421000175108", "display": "Acute care inpatient service" }, { "code": "931801000000101", "display": "Community nursing service" }, { "code": "699478002", "display": "Surgical oncology service" }, { "code": "893791000000100", "display": "Paediatric pain management service" }, { "code": "893541000000101", "display": "Prosthetics service" }, { "code": "699650006", "display": "Community based physiotherapy service" }, { "code": "893891000000108", "display": "Paediatric interventional radiology service" }, { "code": "827631000000105", "display": "Emergency ambulance service" }, { "code": "827981000000103", "display": "Paediatric cystic fibrosis service" }, { "code": "892821000000103", "display": "Critical care medicine service" }, { "code": "700435004", "display": "Clinical physiology service" }, { "code": "700436003", "display": "Clinical pharmacology service" }, { "code": "700434000", "display": "Endocrinology service" }, { "code": "700221004", "display": "Care of elderly service" }, { "code": "700433006", "display": "Gastroenterology service" }, { "code": "700231006", "display": "Critical care physician service" }, { "code": "700232004", "display": "General medical service" }, { "code": "700241009", "display": "Dermatology service" }, { "code": "893061000000109", "display": "Cardiology service" }, { "code": "705150003", "display": "Domiciliary physiotherapy service" }, { "code": "932241000000105", "display": "Blood banking and transfusion service" }, { "code": "3791000175107", "display": "Pediatric nephrology service" }, { "code": "892791000000108", "display": "Blood and marrow transplantation service" }, { "code": "893641000000102", "display": "Palliative medicine service" }, { "code": "431051000124102", "display": "Dialysis service" }, { "code": "23951000087100", "display": "Opioid dependence service" }, { "code": "1323651000000109", "display": "Cardiac physiology service" }, { "code": "788126001", "display": "Prosthetic service" }, { "code": "788124003", "display": "Histopathology service" }, { "code": "788125002", "display": "Addiction service" }, { "code": "788123009", "display": "Radiation oncology service" }, { "code": "788122004", "display": "Sexual health service" }, { "code": "788128000", "display": "Critical care medicine service" }, { "code": "788127005", "display": "Child health service" }, { "code": "788121006", "display": "Clinical immunology and allergy service" }, { "code": "733921009", "display": "Transplant medicine service" }, { "code": "788001008", "display": "Infectious disease service" }, { "code": "788002001", "display": "Adult mental health service" }, { "code": "788003006", "display": "Nephrology service" }, { "code": "788009005", "display": "Nuclear medicine service" }, { "code": "788006003", "display": "Genetic laboratory service" }, { "code": "788004000", "display": "Clinical genetics service" }, { "code": "788005004", "display": "Neurology service" }, { "code": "788008002", "display": "Oral and maxillofacial surgery service" }, { "code": "788007007", "display": "General practice service" }, { "code": "1326391000000100", "display": "FNP (Family Nurse Partnership) service" }, { "code": "1186717003", "display": "Intellectual disability psychiatry service" }, { "code": "830149003", "display": "Clinical neurophysiology service" }, { "code": "224930009", "display": "Services" }, { "code": "830039004", "display": "Genitourinary medicine service" }, { "code": "830038007", "display": "Clinical allergy service" }, { "code": "830037002", "display": "Clinical immunology service" }, { "code": "1326421000000106", "display": "Safeguarding children team" }, { "code": "1323551000000105", "display": "Inherited metabolic medicine service" }, { "code": "28541000087101", "display": "Musculoskeletal service" }, { "code": "24271000087103", "display": "Adult chronic pain management service" }, { "code": "1240241000000109", "display": "Community sexual and reproductive health service" }, { "code": "897188002", "display": "Pediatric hematology service" }, { "code": "1323631000000102", "display": "Aviation and space medicine service" }, { "code": "1325831000000100", "display": "Post-COVID-19 syndrome service" }, { "code": "1323431000000104", "display": "Fetal medicine service" }, { "code": "24001000087103", "display": "Paediatric plastic surgery service" }, { "code": "24351000087104", "display": "Paediatric chronic pain management service" }, { "code": "1323881000000102", "display": "Stroke medicine service" }, { "code": "1323531000000103", "display": "Urological physiology service" }, { "code": "148621000000100", "display": "School aged immunisation service" }, { "code": "24101000087102", "display": "HIV (human immunodeficiency virus) social work service" }, { "code": "23911000087104", "display": "Medication review service" }, { "code": "1148679005", "display": "Specialist palliative care service" }, { "code": "773558007", "display": "Physical medicine service" }, { "code": "24051000087102", "display": "Breast surgical oncology service" }, { "code": "896974005", "display": "Transgender health service" }, { "code": "1323611000000105", "display": "Paediatric inherited metabolic medicine service" }, { "code": "1323661000000107", "display": "Paediatric audiovestibular medicine service" }, { "code": "24331000087108", "display": "Narcotic addiction service with chronic pain management" }, { "code": "1323561000000108", "display": "Gastrointestinal physiology service" }, { "code": "34911000087100", "display": "Amputation care service" }, { "code": "1231786003", "display": "Refugee healthcare service" }, { "code": "1163002007", "display": "Electrocardiography service" }, { "code": "1163004008", "display": "Hyperbaric medicine service" }, { "code": "1163003002", "display": "Colorectal cancer screening service" }, { "code": "1323841000000105", "display": "Paediatric palliative medicine service" }, { "code": "1163054002", "display": "Gastroscopy service" }, { "code": "1231392007", "display": "Paediatric orthopaedic service" }, { "code": "1231391000", "display": "Colonoscopy service" }, { "code": "1231393002", "display": "Spirometry service" }, { "code": "1231390004", "display": "Hand therapy service" }, { "code": "1231394008", "display": "Paediatric urology service" }, { "code": "24081000087105", "display": "HIV (human immunodeficiency virus) nurse practitioner service" }, { "code": "23941000087103", "display": "Narcotic addiction service" }, { "code": "1323641000000106", "display": "Audiovestibular medicine service" }, { "code": "840587001", "display": "Aerospace medical service" }, { "code": "840586005", "display": "Neonatal service" }, { "code": "840585009", "display": "Postnatal service" }, { "code": "816075004", "display": "Prosthetic and orthotic service" }, { "code": "1323921000000108", "display": "Neuropsychiatry service" }, { "code": "24011000087101", "display": "Vascular imaging service" }, { "code": "1323691000000101", "display": "General internal medical service" }, { "code": "23891000087102", "display": "Adult hematology service" }, { "code": "1323821000000103", "display": "Paediatric clinical pharmacology service" }, { "code": "789718008", "display": "Cardiology service" }, { "code": "789714005", "display": "Pediatric rheumatology service" }, { "code": "789715006", "display": "Paediatric respiratory therapy service" }, { "code": "789716007", "display": "Pediatric otolaryngology service" }, { "code": "789717003", "display": "Paediatric cardiology service" }, { "code": "148581000000100", "display": "Personal health record provider service" }, { "code": "792849008", "display": "Pediatric clinical genetics service" }, { "code": "792847005", "display": "Emergency ambulance service" }, { "code": "792848000", "display": "Internal medicine service" }, { "code": "1323621000000104", "display": "Medical psychotherapy service" }, { "code": "1323871000000104", "display": "Rehabilitation medicine service" }, { "code": "1230046007", "display": "Cervical cancer screening service" }, { "code": "1230045006", "display": "Cardiac diagnostic service" }, { "code": "1230044005", "display": "Cardiac specialist nursing service" }, { "code": "1362761000000103", "display": "Adult safeguarding team" }, { "code": "1323901000000104", "display": "Rare disease service" }, { "code": "1136421000168109", "display": "Sleep medicine service" }, { "code": "1323701000000101", "display": "Vascular physiology service" }, { "code": "24141000087104", "display": "Spine orthopedic surgery service" }, { "code": "1323571000000101", "display": "Orthogeriatric medicine service" }, { "code": "1323801000000107", "display": "Paediatric oral and maxillofacial surgery service" }, { "code": "23871000087101", "display": "Adult dermatology service" }, { "code": "1323601000000108", "display": "Ophthalmic and vision science service" }, { "code": "1234796008", "display": "Community nursing service" }, { "code": "23901000087101", "display": "Hepatology service" }, { "code": "1324191000000107", "display": "Intensive care medicine service" }, { "code": "2391000175104", "display": "Bariatric surgery service" }, { "code": "1323851000000108", "display": "Paediatric hepatology service" }, { "code": "24291000087104", "display": "Geriatric chronic pain management service" }, { "code": "1323501000000109", "display": "Special care dentistry service" }, { "code": "1423561000000102", "display": "Acute oncology service" }, { "code": "394802001", "display": "General medicine" } ] } ] } } NRLF-3.0.31/resources/fhir/NRLF-RecordCategory-ValueSet.json000066400000000000000000000033021511201605300233650ustar00rootroot00000000000000{ "resourceType": "ValueSet", "id": "NRLF-RecordCategory", "url": "https://fhir.nhs.uk/England/ValueSet/England-NRLRecordCategory", "version": "1.1.4", "name": "NRLF Record Category", "status": "draft", "date": "2025-08-14T00:00:00+00:00", "publisher": "NHS Digital", "contact": { "name": "NRL Team at NHS Digital", "telecom": { "system": "email", "value": "nrls@nhs.net", "use": "work" } }, "description": "A code from the SNOMED Clinical Terminology UK coding system to represent the NRL clinical record class.", "copyright": "Copyright 2024 NHS Digital. This value set includes content from SNOMED CT, which is copyright 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement.", "compose": { "include": [ { "system": "http://snomed.info/sct", "concept": [ { "code": "734163000", "display": "Care plan" }, { "code": "1102421000000108", "display": "Observations" }, { "code": "823651000000106", "display": "Clinical note" }, { "code": "721981007", "display": "Diagnostic studies report" }, { "code": "103693007", "display": "Diagnostic procedure" }, { "code": "419891008", "display": "Record artifact" }, { "code": "716931000000107", "display": "Record headings" } ] } ] } } NRLF-3.0.31/resources/fhir/NRLF-RecordType-ValueSet.json000066400000000000000000000057021511201605300225370ustar00rootroot00000000000000{ "resourceType": "ValueSet", "id": "NRLF-RecordType", "url": "https://fhir.nhs.uk/England/ValueSet/England-NRLRecordType", "version": "1.1.4", "name": "NRLF Record Type", "status": "draft", "date": "2025-08-14T00:00:00+00:00", "publisher": "NHS Digital", "contact": { "name": "NRL Team at NHS Digital", "telecom": { "system": "email", "value": "nrls@nhs.net", "use": "work" } }, "description": "A code from the SNOMED Clinical Terminology UK coding system or another NHS coding system to represent the NRL clinical record type", "copyright": "Copyright 2024 NHS Digital. This value set includes content from SNOMED CT and other coding systems, which is copyright 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT and other coding systems is not covered by this agreement.", "compose": { "include": [ { "system": "http://snomed.info/sct", "concept": [ { "code": "736253002", "display": "Mental health crisis plan" }, { "code": "887701000000100", "display": "Emergency health care plan" }, { "code": "861421000000109", "display": "End of life care coordination summary" }, { "code": "1382601000000107", "display": "ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form" }, { "code": "1363501000000100", "display": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart" }, { "code": "325691000000100", "display": "Contingency plan" }, { "code": "736373009", "display": "End of life care plan" }, { "code": "16521000000101", "display": "Lloyd George record folder" }, { "code": "736366004", "display": "Advance care plan" }, { "code": "735324008", "display": "Treatment escalation plan" }, { "code": "824321000000109", "display": "Summary record" }, { "code": "2181441000000107", "display": "Personalised Care and Support Plan" }, { "code": "749001000000101", "display": "Appointment" }, { "code": "887181000000106", "display": "Clinical summary" } ] }, { "system": "https://nicip.nhs.uk", "concept": [ { "code": "MAULR", "display": "MRA Upper Limb Rt" }, { "code": "MAXIB", "display": "MRI Axilla Both" } ] } ] } } NRLF-3.0.31/resources/fhir/NRLF-Retrieval-CodeSystem.json000066400000000000000000000053531511201605300227450ustar00rootroot00000000000000{ "resourceType": "CodeSystem", "id": "England-NRLRetrievalMechanism", "url": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "version": "1.1.0", "name": "EnglandNRLRetrievalMechanism", "title": "England NRL Retrieval Mechanism", "status": "draft", "experimental": false, "date": "2025-02-28", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] }, { "name": "NRL Team at NHS Digital", "telecom": [ { "system": "email", "value": "nrls@nhs.net", "use": "work" } ] } ], "description": "A CodeSystem to identify the means by which an NRL DocumentReference can be retrieved via its content.attachment url.", "copyright": "Copyright © 2025+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "content": "complete", "hierarchyMeaning": "is-a", "concept": [ { "code": "Direct", "display": "Direct", "definition": "This document can be directly retrieved via HTTP(s) at its public URL.", "concept": [ { "code": "InContext", "display": "Direct using In-Context", "definition": "This document can be retrieved in-context via the In-Context launch mechanism." } ] }, { "code": "Proxy", "display": "Proxy", "definition": "This document must be retrieved via a proxy.", "concept": [ { "code": "SSP", "display": "Spine Secure Proxy", "definition": "This document can be retrieved via Spine Secure Proxy by authorised organisations. The custodian's ASID will be needed and can be found in the context.related field." }, { "code": "LDR", "display": "Large Document Retrieval", "definition": "This document can be retrieved via the Large Document Retrieval proxy service." } ] } ] } NRLF-3.0.31/resources/fhir/NRLF-RetrievalMechanism-ValueSet.json000066400000000000000000000023531511201605300242400ustar00rootroot00000000000000{ "resourceType": "ValueSet", "id": "England-NRLRetrievalMechanism", "url": "https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism", "version": "1.1.0", "name": "EnglandNRLRetrievalMechanism", "title": "England NRL Retrieval Mechanism", "status": "draft", "date": "2025-02-28", "publisher": "NHS Digital", "contact": { "name": "NRL Team at NHS Digital", "telecom": { "system": "email", "value": "nrls@nhs.net", "use": "work" } }, "description": "A code to represent the means by which the document being referenced can be accessed (via the url in the content.attachment).", "copyright": "Copyright 2025 NHS Digital.", "compose": { "include": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "concept": [ { "code": "Direct", "display": "Direct" }, { "code": "SSP", "display": "Spine Secure Proxy" }, { "code": "LDR", "display": "Large Document Retrieval" }, { "code": "InContext", "display": "Direct using In-Context" } ] } ] } } NRLF-3.0.31/resources/nrl-authorised-organisations-and-actors-catalogue.xlsx000066400000000000000000000367401511201605300271060ustar00rootroot00000000000000PK!A7n[Content_Types].xml (Tn0W?DV[$xX$(}'fQU%Ql[&<&YB@l.YO$` r=HEV5 ӵLb.j""%5 3NB?C%*=YK)ub8xR-JWQ23V$sU.)PI]h:C@im2 3 1 g/#ݺʸ2 x|`G㮶u_;ѐUOղwj s4ȥ-ZeN xe|o, 1ysi޺s V788wa:  CrhݝAPK!U0#L _rels/.rels (MO0 HݐBKwAH!T~I$ݿ'TG~i~`P+UjkO N6&;$Miz'%6~{ss|e6 r61ѹcybv_XiHY|%rOk.O/ `rbJum˲&-# V\XP<۲W&D:N`2s@)|%xj S V@_ִ;<bꬒ@<ц42zf\ G4&X:/9@#c#cقP=+|U hk%}ssˋm ]wWH5`*RM1 |.]VcӾVb4r@j[?*{Zs1# ; !0Z\IbU+ NUVz.k,H)tՁf9nRB 743sFKigD.4ťv L:L;}*aUv 1/1ׅ\)}A o4i'|[a讧! 5GQR=!INYN>Akȵ^8S>CݻYB:{%3HhllG@+Pay(r4 <ϊ?F4w'Kdh V+-Xvv?&,ӆlO;!'n.N8zss~X9IlqGm/S{'˿PK!>xl/_rels/workbook.xml.rels (RMK0 0wvt/"Uɴ)&!3~*]XK/oyv5+zl;obG s>,8(%"D҆4j0u2jsMY˴S쭂 )fCy I< y!+EfMyk K5=|t G)s墙UtB),fPK!IX^xl/worksheets/sheet1.xml_o0';D~'DZQPJTl&qfw$@mbs }]9OL*. aGk(xЧ(AҤ)H%SNGaL;@hT6ZSStj\Ѳ>)rV2Rئߏu!ʒSt[Fw*V ^|ܶ#*+^q}Ptzn$ Pg/3dJ5R(Qj^zI/#O'n ^g  _ 0ny"'qp>F"LGi0s?M˛VLHVfhyW3>sSgUj"9߄(1kٮ+!M-|4?p*h߳R/XUe T'vZ E}m{XcYƷgPW;Fꫝ1&qfF(M=sw.!VSCwrٽNJBT_x7JI`3@ %SN*$cIEI#{{u(vG+}0KVAّX\{ƙ#Tg;T tb3EQπ ١8(xS:w_Ó0M)?gOr6_E5x%%jgFf.Eɏ$[7KȈ8ls)_ o߿}zqv7oÿrCy?~^]ǟwz}{y}?˸?ƕ>v7x~קㇿ>=~x ā G&81ē'_EL<3Qęۘ ?L}LL X@ ҋW ' baOΚ;H3Gp}@5>y +/Wfy GTïFnXt8A <F@UHAz[$YwB =YAx3"!*Gr<#s'F&0Jy G0Cِ`Jk1<2w#a0)7zf$jb/',%_=tvX tjbN zG.Iv G`8zd.iJ Rh:LSÐU l`V':Sc<kعOׇ%cX!SP0%DoAS gwi;H< e7[;-U@j-Pg.!0"*=!Ը/1;`"W 9Î$HEb/gS450^0#'M9/~TMG`(3WT Vb(U/:n(c}T?%LI%֡bK0_Y<3`e`jtb`zp|-^z'|&`'` (M:VT+ jE!@p9'~)'PۏӚQ_D0 *{#a!i:ձ>JdY)@g t@-PcZ YlzZ8{&'<[@E} `((`>34ឱ()` : PcC]1X F'q3[3`,+aVj`20i Lk`:s10`f`xs=0WBgL$yM==g|%Vg135%%VmyL%0AbI_@D([\DIE7m7SK2SK(qiav1| [ꊡC^}_ñ": !mV!}_ZCY^DIiscsS2PY) &sG?ʝ-9n{W}oQ͐{1APixj:uY]6gU4sH2=X$N8ŗw +}F/4-VpӮ:bƪ#͙#švWոZS;jDИsXC/YQSo15v7NY }E^Jg.L/OΔUܻk㜹}:k[y\f ;zH 76%.\Z=bZl;TP^Yh4zPK!`A"xl/theme/theme1.xmlZ͏@]{a9Ч7z]HI^p@R+ KiKz(h1`#MZ,茠V(1M3&δjbI<&f] RbX*ϫ޻[S{dKrc)(l׃~`j7j>‘7|l,8;t;ͦѰ.=ł'j_ch Ê&HS3^DC*SJq% a@po,.Ik^D i>HMU{Z7߼xy/ e2U!New_ɍeշzXj)^W_/_:N%zcx@c ?IL"L- nꑊ,3Ol>e\g׳Hu0-1υ\% OV=Xq1p=*J]*h2($ QH q<WTe%Ol+Dleמ诖Vh%|`e!qlǪO2I5)J+dȒsx8اnTbtPxfe iGt{OiKKw7Yc.t] $73k"`&#WW)m(z'늟,yjVK/^r~Sn-mnKٷo ۂ涠q}a)Z=,(cgjȑ4 51 iLniy`  o"B(0]̥U/%J6TrMi>c>ڝg&X~O8TnAoCݰ]V놀 d6Dk3s~Xt,ZU;j[{7רg#5\)sƻ9]Ow4׽. 7E8% +)doyt?p7upEOb N"rKʙ%xC3v2N!x~l /3%6%R 2'hoÁ%&d:tB~i붗bAf҈tv )>K_ۃ$_Ϣ%x!@{wN%ök;SC"cF8R< eKmmP˟ kR~֖+NiZiEolvbXezlsxD̢aQ{JOsݶo;Ħ4og| NW,;f ܙ2=ƷS>_Lf&.JT,_uU9y5@VVYقzEk-nMkE[]mNunf˞ڤac)ڵ"9;r/+WpVv^}6U굺_i7zJѨF@OEqȾ|i[?o ́ם|P57@o @+*aЬanzA=ش0?Ǎ^64ۣ~8F|ss[uGPK!G; xl/styles.xmlXo6~A໣\۰\IaɀeHQ6N"{]a~H}w;qʅtɕD\n"}<4TT("g%yEim3@2"[cɖ崼P&S:z㖅f4-qS.&nN$5[@\w_9LXBc}%a>6Ye)~_"t{mS7$^E2]VD>Ǖqa.89-i*R mܠ2W"Ĭ`@X40O]4Ҝ3yIr gDh@zo ;>RQ /hu'_}{^0irusMu* [1B<i&aZn2anQWߥb$b()*-GȘJo;ht]{/L;d @XB94*;,e[8C`:J%.7ojɈnS2{xFL0Ikp*Gq[ł31Ϸ: vÜ03 y6inz`~PPK!;m2KB#xl/worksheets/_rels/sheet1.xml.rels0ECx{օ CS7"Ubۗ{ep6<f,Ժch{-A8 -Iy0Ьjm_/N,}W:=RY}H9EbAwk}m PK!$v'xl/printerSettings/printerSettings1.bin`He(bg`pfҥ ) @L<€ M8R4?CdL0X%P,@ a|tAah1( 0- ;0 &".`̠r= (<(QoJ۸\(`X |] 9 ,+0e`u `NĔ̼tהT̪T\8JMc`p)-IR~!I9 A9% f@R. ~A ĂP #G=B7 D+CHfp9`ijHV%$$3,*:{mwFOZ]"YB[q*neyޤiAS&] !m{C/l&?:WVm麵vy\ VT?;*\GgOV(M]bpm!A: rj<폛RUvU'G'0?udWw/^)ȱ6KV\ .zt/ė/O؏֯Ac7/>{m\'mGT8&XWX921ˀ d àf.?O` Ee!P ,Ј6@8P){ }CkI Mj)F|U9!0!0!0!0!0!0!0!0#%PK!uDBdocProps/core.xml (|R]o0 |`Ȳu1Y6,͊%Cij%CbW')(_l:/~~~)+̓Ep9ycǛFg\K'bI2[.9X^,apX$of=oFOBB/0edǸ%ڣ+cN5Z caI_} PK!f>CdocProps/app.xml (n0 n(@VzXI3'ӱP[2D6Hmuz#>R>MvD>B-0X/C( uBRI)@jl"QZ`I^Ǫo{n1+GPbyMjt\et==N[eJ{]+ξ6FE#t[tFSuZm ѯs/m>5^qL?KPH V6&Ct>D5"0p;g$8o Fw_x9'Fgg7w`I)ZǶp]Ɨ Ͷ\tSrS#&dҺ_.㟰˫E)0_PK-!A7n[Content_Types].xmlPK-!U0#L _rels/.relsPK-!b xl/workbook.xmlPK-!> xl/_rels/workbook.xml.relsPK-!IX^ xl/worksheets/sheet1.xmlPK-!`A" xl/theme/theme1.xmlPK-!G; $xl/styles.xmlPK-!o(xl/sharedStrings.xmlPK-!;m2KB#.xl/worksheets/_rels/sheet1.xml.relsPK-!$v'/xl/printerSettings/printerSettings1.binPK-!uDB4docProps/core.xmlPK-!f>C7docProps/app.xmlPK &:NRLF-3.0.31/scripts/000077500000000000000000000000001511201605300140205ustar00rootroot00000000000000NRLF-3.0.31/scripts/activate_stack.py000066400000000000000000000140211511201605300173550ustar00rootroot00000000000000#!/usr/bin/env python import json import sys import traceback import aws_session_assume import fire CONFIG_LOCK_STATE = "lock-state" CONFIG_INACTIVE_STACK = "inactive-stack" CONFIG_INACTIVE_VERSION = "inactive-version" CONFIG_ACTIVE_STACK = "active-stack" CONFIG_ACTIVE_VERSION = "active-version" CONFIG_DOMAIN_NAME = "domain-name" STATE_LOCKED = "locked" STATE_OPEN = "open" VALID_LOCK_STATES = [STATE_LOCKED, STATE_OPEN] def _parse_env_config(raw_config: str) -> dict: env_config = json.loads(raw_config) if not all( key in env_config for key in [ CONFIG_LOCK_STATE, CONFIG_INACTIVE_STACK, CONFIG_INACTIVE_VERSION, CONFIG_ACTIVE_STACK, CONFIG_ACTIVE_VERSION, CONFIG_DOMAIN_NAME, ] ): raise ValueError( f"Environment config must contain keys: {CONFIG_LOCK_STATE}, {CONFIG_INACTIVE_STACK}, {CONFIG_INACTIVE_VERSION}, {CONFIG_ACTIVE_STACK}, {CONFIG_ACTIVE_VERSION}, {CONFIG_DOMAIN_NAME}" ) if env_config[CONFIG_LOCK_STATE] not in VALID_LOCK_STATES: raise ValueError( f"Invalid lock state: {env_config[CONFIG_LOCK_STATE]}. Must be one of: {VALID_LOCK_STATES}" ) return env_config def _swap_config(config: dict[str, str], key1: str, key2: str): config[key1], config[key2] = config[key2], config[key1] def _set_lock_state( lock_state: str, environment_config: dict, parameters_key: str, sm: any ): if lock_state not in VALID_LOCK_STATES: raise ValueError(f"Invalid lock state: {lock_state}") print(f"Setting environment config lock state to {lock_state}....") environment_config[CONFIG_LOCK_STATE] = lock_state sm.put_secret_value( SecretId=parameters_key, SecretString=json.dumps(environment_config) ) print(f"Environment config lock state is now {lock_state}") def _update_and_unlock(environment_config: dict, parameters_key: str, sm: any): environment_config[CONFIG_LOCK_STATE] = STATE_OPEN print(f"Updating environment config to: {environment_config}") sm.put_secret_value( SecretId=parameters_key, SecretString=json.dumps(environment_config) ) def _switch_active_stack(stack_name: str, env_domain_name: str, session: any): # Change API mappings for APIGW print(f"Gathering data about APIs for {env_domain_name} for {stack_name}....") api_gw = session.client("apigateway") env_apis = { api["name"]: api["id"] for api in api_gw.get_rest_apis(limit=100)["items"] if api["name"].startswith(f"nhsd-nrlf--{stack_name}--") } if len(env_apis) != 2: raise ValueError( f"Expected 2 APIs for stack {stack_name}, got {env_apis.keys()}" ) api_gwv2 = session.client("apigatewayv2") existing_mappings = { mapping["ApiMappingKey"]: mapping["ApiMappingId"] for mapping in api_gwv2.get_api_mappings(DomainName=env_domain_name)["Items"] } if len(existing_mappings) != 2: raise ValueError( f"Expected 2 API mappings for domain {env_domain_name}, got {len(existing_mappings)}" ) if "consumer" not in existing_mappings or "producer" not in existing_mappings: raise ValueError( f"Expected API mappings for consumer and producer, got {existing_mappings.keys()}" ) print(f"Switching APIGW for {env_domain_name} to point to {stack_name}") api_gwv2.update_api_mapping( ApiId=env_apis[f"nhsd-nrlf--{stack_name}--consumer"], DomainName=env_domain_name, ApiMappingId=existing_mappings["consumer"], Stage="production", ) api_gwv2.update_api_mapping( ApiId=env_apis[f"nhsd-nrlf--{stack_name}--producer"], DomainName=env_domain_name, ApiMappingId=existing_mappings["producer"], Stage="production", ) def activate_stack(stack_name: str, env: str, session: any): sm = session.client("secretsmanager") parameters_key = f"nhsd-nrlf--{env}--env-config" response = sm.get_secret_value(SecretId=parameters_key) environment_config = _parse_env_config(response["SecretString"]) print(f"Got environment config for {env}: {environment_config}") current_active_stack = environment_config[CONFIG_ACTIVE_STACK] if current_active_stack == stack_name: print("Cannot activate stack, stack is already active", file=sys.stderr) sys.exit(1) lock_state = environment_config[CONFIG_LOCK_STATE] if lock_state != "open": print( f"Unable to activate stack as lock state is not open: {lock_state}", file=sys.stderr, ) sys.exit(1) _set_lock_state( STATE_LOCKED, environment_config=environment_config, parameters_key=parameters_key, sm=sm, ) try: domain_name = environment_config[CONFIG_DOMAIN_NAME] print(f"Activating stack {stack_name} for {domain_name}....") _switch_active_stack(stack_name, env_domain_name=domain_name, session=session) except Exception as err: print( "Failed to switch active stack. Unlocking and bailing out....", file=sys.stderr, ) _set_lock_state( STATE_OPEN, environment_config=environment_config, parameters_key=parameters_key, sm=sm, ) print(f"Failed to activate stack: {err}", file=sys.stderr) print(f"Stack trace: {traceback.format_exc()}", file=sys.stderr) sys.exit(1) print("Updating environment config and unlocking....") _swap_config(environment_config, CONFIG_INACTIVE_STACK, CONFIG_ACTIVE_STACK) _swap_config(environment_config, CONFIG_INACTIVE_VERSION, CONFIG_ACTIVE_VERSION) _update_and_unlock(environment_config, parameters_key=parameters_key, sm=sm) print(f"Complete. Stack {stack_name} is now the active stack for {env}") def main(stack_name: str, env: str): boto_session = aws_session_assume.get_boto_session(env) activate_stack(stack_name, env=env, session=boto_session) if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/scripts/add-perms-to-lambda.sh000077500000000000000000000012311511201605300200660ustar00rootroot00000000000000#!/bin/bash # Add s3 perms to permissions layer # set -o errexit -o pipefail -o nounset dist_path="$(pwd)/$1" mkdir -p "${dist_path}/nrlf_permissions-layer/python/nrlf_permissions" cp -r "${dist_path}/nrlf_permissions"/* "${dist_path}/nrlf_permissions-layer/python/nrlf_permissions" cd "${dist_path}/nrlf_permissions-layer/" && \ rm -f ${dist_path}/nrlf_permissions.zip && \ zip -q -r "${dist_path}/nrlf_permissions.zip" . \ -x **tests**\* **scripts**\* **__pycache__**\* rm -rf "${dist_path}/nrlf_permissions-layer" rm -rf "${dist_path}/nrlf_permissions" echo "✅ New Layer Zip Created with S3 Permissions: ${dist_path}/nrlf_permissions.zip" NRLF-3.0.31/scripts/are_resources_shared_for_stack.py000066400000000000000000000012101511201605300226060ustar00rootroot00000000000000#!/usr/bin/env python # Get if the stack should share resources import fire persistent_environments = [ "dev-1", "dev-2", "dev-sandbox-1", "dev-sandbox-2", "qa-1", "qa-2", "qa-sandbox-1", "qa-sandbox-2", "ref-1", "ref-2", "perftest-1", "perftest-2", "int-1", "int-2", "int-sandbox-1", "int-sandbox-2", "prod-1", "prod-2", ] def uses_shared_resources(stack_name: str) -> bool: return stack_name in persistent_environments def main(stack_name) -> str: return "true" if uses_shared_resources(stack_name) else "false" if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/scripts/aws_session_assume.py000066400000000000000000000024541511201605300203110ustar00rootroot00000000000000#!/usr/bin/env python import boto3 _AWS_ACCOUNT_FOR_ENV = { "dev": "dev", "dev-sandbox": "dev", "qa": "test", "qa-sandbox": "test", "ref": "test", "perftest": "test", "int": "test", "int-sandbox": "test", "prod": "prod", } def get_account_name(env: str): if env not in _AWS_ACCOUNT_FOR_ENV: raise ValueError(f"Invalid environment: {env}") return _AWS_ACCOUNT_FOR_ENV[env] def get_account_id(env: str): account_name = get_account_name(env) secretsmanager = boto3.client("secretsmanager", region_name="eu-west-2") secret_id = f"nhsd-nrlf--mgmt--{account_name}-account-id" result = secretsmanager.get_secret_value(SecretId=secret_id) account_id = result["SecretString"] return account_id def get_boto_session(env: str) -> boto3.Session: account_id = get_account_id(env) sts = boto3.client("sts", region_name="eu-west-2") result = sts.assume_role( RoleArn=f"arn:aws:iam::{account_id}:role/terraform", RoleSessionName="get-account-id", DurationSeconds=900, ) credentials = result["Credentials"] return boto3.Session( aws_access_key_id=credentials["AccessKeyId"], aws_secret_access_key=credentials["SecretAccessKey"], aws_session_token=credentials["SessionToken"], ) NRLF-3.0.31/scripts/bootstrap.sh000077500000000000000000000242211511201605300163750ustar00rootroot00000000000000#!/bin/bash # Setup mgmt and non-mgmt AWS accounts for NRLF set -o errexit -o nounset -o pipefail AWS_REGION_NAME="eu-west-2" PROFILE_PREFIX="nhsd-nrlf" TERRAFORM_ROLE_NAME="terraform" MGMT_ACCOUNT_ID_LOCATION="${PROFILE_PREFIX}--mgmt--mgmt-account-id" PROD_ACCOUNT_ID_LOCATION="${PROFILE_PREFIX}--mgmt--prod-account-id" TEST_ACCOUNT_ID_LOCATION="${PROFILE_PREFIX}--mgmt--test-account-id" TEST_BACKUP_ACCOUNT_ID_LOCATION="${PROFILE_PREFIX}--mgmt--test-backup-account-id" DEV_ACCOUNT_ID_LOCATION="${PROFILE_PREFIX}--mgmt--dev-account-id" function _bootstrap_help() { echo echo "bootstrap.sh [options]" echo echo "commands:" echo " help - this help screen" echo " create-mgmt - Creates required aws resource for terraform access in mgmt account" echo " delete-mgmt - Deletes required aws resource for terraform access in mgmt account" echo " create-non-mgmt - Creates required aws resource for terraform access in non-mgmt account" echo " delete-non-mgmt - Deletes required aws resource for terraform access in non-mgmt account" echo " destroy-non-mgmt - Destroys a workspace completely in non-mgmt (Dev) account. ONLY USE IF TERRAFORM DESTROY HAS NOT COMPLETED" echo return 1 } function _check_mgmt() { if [ "$(aws iam list-account-aliases --query 'AccountAliases[0]' --output text)" != "nhsd-ddc-spine-nrlf-mgmt" ]; then echo "Please log in as the mgmt account" >&2 return 1 fi } function _check_non_mgmt() { if [[ "$(aws iam list-account-aliases --query 'AccountAliases[0]' --output text)" == 'nhsd-ddc-spine-nrlf-mgmt' ]]; then echo "Please log in as a non-mgmt account" >&2 return 1 fi } function _bootstrap() { local command=$1 local admin_policy_arn="arn:aws:iam::aws:policy/AdministratorAccess" local truststore_bucket_name="${PROFILE_PREFIX}--truststore" local state_bucket_name="${PROFILE_PREFIX}--terraform-state" local state_lock_table_name="${PROFILE_PREFIX}--terraform-state-lock" case $command in "create-mgmt") _check_mgmt || return 1 cd terraform/bootstrap/mgmt aws s3api create-bucket --bucket "${truststore_bucket_name}" --region us-east-1 --create-bucket-configuration LocationConstraint="${AWS_REGION_NAME}" aws s3api create-bucket --bucket "${state_bucket_name}" --region us-east-1 --create-bucket-configuration LocationConstraint="${AWS_REGION_NAME}" aws s3api put-public-access-block --bucket "${state_bucket_name}" --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true" aws dynamodb create-table --cli-input-json file://locktable.json --region "${AWS_REGION_NAME}" aws secretsmanager create-secret --name "${MGMT_ACCOUNT_ID_LOCATION}" aws secretsmanager create-secret --name "${DEV_ACCOUNT_ID_LOCATION}" aws secretsmanager create-secret --name "${TEST_ACCOUNT_ID_LOCATION}" aws secretsmanager create-secret --name "${TEST_BACKUP_ACCOUNT_ID_LOCATION}" aws secretsmanager create-secret --name "${PROD_ACCOUNT_ID_LOCATION}" aws secretsmanager create-secret --name "${PROFILE_PREFIX}--codebuild-github-pat" ;; #---------------- "delete-mgmt") _check_mgmt || return 1 cd terraform/bootstrap/mgmt aws dynamodb delete-table --table-name "${state_lock_table_name}" || return 1 local versioned_objects versioned_objects=$(aws s3api list-object-versions \ --bucket "${state_bucket_name}" \ --output=json \ --query='{Objects: Versions[].{Key:Key,VersionId:VersionId}}') || return 1 aws s3api delete-objects \ --bucket "${state_bucket_name}" \ --delete "${versioned_objects}" || echo "Ignore the previous warning - an empty bucket is a good thing" echo "Waiting for bucket contents to be deleted..." && sleep 10 aws s3 rb "s3://${state_bucket_name}" || echo "Bucket could not be deleted at this time. You should go to the AWS Console and delete the bucket manually." aws secretsmanager delete-secret --secret-id "${MGMT_ACCOUNT_ID_LOCATION}" aws secretsmanager delete-secret --secret-id "${DEV_ACCOUNT_ID_LOCATION}" aws secretsmanager delete-secret --secret-id "${TEST_ACCOUNT_ID_LOCATION}" aws secretsmanager delete-secret --secret-id "${TEST_BACKUP_ACCOUNT_ID_LOCATION}" aws secretsmanager delete-secret --secret-id "${PROD_ACCOUNT_ID_LOCATION}" aws secretsmanager delete-secret --secret-id "${PROFILE_PREFIX}--codebuild-github-pat" ;; #---------------- "create-non-mgmt") _check_non_mgmt || return 1 cd terraform/bootstrap/non-mgmt local tf_assume_role_policy local mgmt_account_id set +e mgmt_account_id=$(aws secretsmanager get-secret-value --secret-id "${MGMT_ACCOUNT_ID_LOCATION}" --query SecretString --output text) if [ "${mgmt_account_id}" == "" ]; then aws secretsmanager create-secret --name "${MGMT_ACCOUNT_ID_LOCATION}" echo "Please set ${MGMT_ACCOUNT_ID_LOCATION} in the Secrets Manager and rerun the script" exit 1 fi set -e tf_assume_role_policy=$(awk "{sub(/REPLACEME/,\"${mgmt_account_id}\")}1" terraform-trust-policy.json) aws iam create-role --role-name "${TERRAFORM_ROLE_NAME}" --assume-role-policy-document "${tf_assume_role_policy}" || return 1 aws iam attach-role-policy --policy-arn "${admin_policy_arn}" --role-name "${TERRAFORM_ROLE_NAME}" || return 1 ;; #---------------- "delete-non-mgmt") _check_non_mgmt || return 1 aws iam detach-role-policy --policy-arn "${admin_policy_arn}" --role-name "${TERRAFORM_ROLE_NAME}" || return 1 aws iam delete-role --role-name "${TERRAFORM_ROLE_NAME}" || return 1 echo "Deleted role ${TERRAFORM_ROLE_NAME} and associated policy ${admin_policy_arn}" ;; #---------------- "destroy-non-mgmt") _check_non_mgmt || return 1 # TODO: Reintroduce the admin check - but should be fine for all developers # if [[ "$(aws sts get-caller-identity)" != *dev* || "$(aws sts get-caller-identity)" != *NHSDAdminRole* ]]; then # echo "Please log in as dev with an Admin account" >&2 # return 1 # fi local workspace workspace=$2 # Fetch the resources using the AWS CLI command aws resourcegroupstaggingapi get-resources --tag-filters Key=workspace,Values="$2" | jq -c '.ResourceTagMappingList[]' | while IFS= read -r item; do arn=$(jq -r '.ResourceARN' <<< "$item") case $arn in arn:aws:lambda* ) echo "Deleting... : $arn" aws lambda delete-function --function-name $arn ;; arn:aws:kms* ) echo "Disabling... : $arn" aws kms disable-key --key-id $arn echo "Deleting... ': $arn" aws kms schedule-key-deletion --key-id $arn --pending-window-in-days 7 ;; arn:aws:logs* ) echo "Deleting... : $arn" new_var=$(echo "$arn" | awk -F':' '{print $NF}') aws logs delete-log-group --log-group-name $new_var ;; arn:aws:secretsmanager* ) echo "Deleting... : $arn" aws secretsmanager delete-secret --secret-id $arn ;; arn:aws:apigateway* ) echo "Deleting domain-name... : $workspace" aws apigateway delete-domain-name --domain-name "$workspace.api.record-locator.dev.national.nhs.uk" echo "Deleting... : $arn" ag_id=$(echo "$arn" | awk -F'/restapis/' '{print $2}' | awk -F'/' '{print $1}') aws apigateway delete-rest-api --rest-api-id $ag_id ;; arn:aws:dynamodb* ) echo "Deleting... : $arn" new_var=$(echo "$arn" | awk -F':' '{print $NF}') table=$(echo "$arn" | awk -F'/' '{print $NF}') aws dynamodb delete-table --table-name $table ;; arn:aws:s3* ) echo "Deleting... : $arn" new_var=$(echo "$arn" | awk -F':' '{print $NF}') local versioned_objects versioned_objects=$(aws s3api list-object-versions \ --bucket "${new_var}" \ --output=json \ --query='{Objects: Versions[].{Key:Key,VersionId:VersionId}}') || return 1 aws s3api delete-objects \ --bucket "${new_var}" \ --delete "${versioned_objects}" || echo "Ignore the previous warning - an empty bucket is a good thing" echo "Waiting for bucket contents to be deleted..." && sleep 10 aws s3 rb "s3://${new_var}" --force || echo "Bucket could not be deleted at this time. You should go to the AWS Console and delete the bucket manually." ;; arn:aws:ssm* ) echo "Deleting... : $arn" new_var=$(echo "$arn" | awk -F':' '{print $NF}') suffix=$(echo "$arn" | awk -F'/' '{print $NF}') name=$(echo "$new_var" | awk -F'/' '{print $(NF-1)}') aws ssm delete-parameter --name $name/$suffix ;; arn:aws:acm* ) echo "Deleting... : $arn" aws acm delete-certificate --certificate-arn $arn ;; arn:aws:firehose* ) echo "Deleting... : $arn" new_var=$(echo "$arn" | awk -F':' '{print $NF}') name=$(echo "$new_var" | awk -F'/' '{print $NF}') aws firehose delete-delivery-stream --delivery-stream-name $name ;; * ) echo "Unknown ARN type: $arn" ;; esac done ;; #---------------- *) _bootstrap_help ;; esac } _bootstrap "${@:1}" NRLF-3.0.31/scripts/build-lambda-dependency-layer.sh000077500000000000000000000014671511201605300221320ustar00rootroot00000000000000#!/bin/bash # Build a lambda layer # set -o errexit -o pipefail -o nounset dist_path="$(pwd)/$1" mkdir -p "${dist_path}/dependency_layer/python" poetry export -f requirements.txt --without-hashes --output "${dist_path}/dependency_layer/requirements.txt" pip install \ --platform manylinux2014_x86_64 \ --target="${dist_path}/dependency_layer/python" \ --implementation cp \ --python-version 3.12 \ --only-binary=:all: --upgrade \ -r "${dist_path}/dependency_layer/requirements.txt" cd "${dist_path}/dependency_layer/" && \ rm -f "${dist_path}/dependency_layer.zip" && \ zip -q -r "${dist_path}/dependency_layer.zip" . \ -x **tests**\* **scripts**\* **__pycache__**\* rm -rf "${dist_path}/dependency_layer" echo "✅ Dependency Layer created: ${dist_path}/dependency_layer.zip" NRLF-3.0.31/scripts/build-lambda-layer.sh000077500000000000000000000011731511201605300200100ustar00rootroot00000000000000#!/bin/bash # Build a lambda layer # set -o errexit -o pipefail -o nounset layer_src_path="$1" dist_path="$(pwd)/$2" package_name="$(basename $layer_src_path)" mkdir -p "${dist_path}/${package_name}-layer/python/${package_name}" cp -r "${layer_src_path}"/* "${dist_path}/${package_name}-layer/python/${package_name}" cd "${dist_path}/${package_name}-layer/" && \ rm -f ${dist_path}/${package_name}.zip && \ zip -q -r "${dist_path}/${package_name}.zip" . \ -x **tests**\* **scripts**\* **__pycache__**\* rm -rf "${dist_path}/${package_name}-layer" echo "✅ Lambda Layer created: ${dist_path}/${package_name}.zip" NRLF-3.0.31/scripts/build-lambda-package.sh000077500000000000000000000007131511201605300202660ustar00rootroot00000000000000#!/bin/bash # Build a lambda package # set -o errexit -o pipefail -o nounset api_src_path="$1" dist_path="$(pwd)/$2" api_type=$(basename $(dirname $api_src_path)) package_name="${api_type}-$(basename $api_src_path)" cd "${api_src_path}" && \ rm -f ${dist_path}/${package_name}.zip && \ zip -q -r "${dist_path}/${package_name}.zip" . \ -x tests**\* scripts**\* **__pycache__**\* echo "✅ Package created: ${dist_path}/${package_name}.zip" NRLF-3.0.31/scripts/check-build-environment.sh000077500000000000000000000017661511201605300211050ustar00rootroot00000000000000#!/bin/bash # Check that the build environment is set up correctly, and warn about issues # set -o errexit -o pipefail -o nounset : "${SHOULD_WARN_ONLY:="false"}" function success() { [ "${SHOULD_WARN_ONLY}" == "true" ] && return local message="$1" echo " ✅ ${message}" } function warning() { local message="$1" echo -e " ⚠️ \e[31m${message}\e[39m" } echo echo "Checking build environment...." BUILD_DEPENDENCIES=" allure behave pre-commit jq poetry pytest python terraform yq zip " for dep in ${BUILD_DEPENDENCIES}; do set +e dep_path="$(which ${dep} 2> /dev/null)" set -e if [ -n "${dep_path}" -a -x "${dep_path}" ] then success "${dep} found at ${dep_path}" else warning "${dep} not found ${dep_path}" fi done if [[ "${CI:='false'}" != 'true' && "${POETRY_ACTIVE:=0}" != "1" ]]; then warning "Poetry is not active. Run 'poetry shell' to activate it." else success "Poetry is active" fi NRLF-3.0.31/scripts/check-deploy-environment.sh000077500000000000000000000047131511201605300212750ustar00rootroot00000000000000#!/bin/bash # Check that the deployment environment is set up correctly, and warn about issues # set -o errexit -o pipefail -o nounset : "${SHOULD_WARN_ONLY:="false"}" : "${ENV:="dev"}" : "${ENV_ACCOUNT_NAME:="dev"}" : "${TF_WORKSPACE_NAME:=""}" function success() { [ "${SHOULD_WARN_ONLY}" == "true" ] && return local message="$1" echo " ✅ ${message}" } function warning() { local message="$1" echo -e " ⚠️ \e[31m${message}\e[39m" } echo echo "Checking deployment environment...." DEPLOY_DEPENDENCIES=" aws jq terraform " for dep in ${DEPLOY_DEPENDENCIES}; do set +e dep_path="$(which ${dep} 2> /dev/null)" set -e if [ -n "${dep_path}" -a -x "${dep_path}" ] then success "${dep} found at ${dep_path}" else warning "${dep} not found ${dep_path}" fi done # Check the mgmt account has the environments account id set +e env_account_id="$(aws secretsmanager get-secret-value --secret-id nhsd-nrlf--mgmt--${ENV_ACCOUNT_NAME}-account-id --query SecretString --output text)" set -e if [ -n "${env_account_id}" ] then success "${ENV_ACCOUNT_NAME} account id found in mgmt account" else warning "${ENV_ACCOUNT_NAME} account id not found in mgmt account. Check you are logged into the NRLF mgmt account." fi # Check the Terraform workspace is set set +e tf_workspace="$(cd terraform/infrastructure && terraform workspace show)" set -e is_using_shared_resources="$(poetry run python ./scripts/are_resources_shared_for_stack.py ${tf_workspace})" if [ "${is_using_shared_resources}" == "true" ] then warning "Will use shared resources for stack '${tf_workspace}'" else success "Not using shared resources for stack '${tf_workspace}'" fi # Check the Terraform workspace value case "${tf_workspace}" in dev-*|qa-*|int-*|ref-*|prod-*) warning "Terraform workspace set to persistent environment '${tf_workspace}'" if [[ "${tf_workspace}" =~ "${ENV}-" ]] then success "Terraform workspace '${tf_workspace}' matches deployment environment '${ENV}'" else warning "Terraform workspace '${tf_workspace}' does not match deployment environment '${ENV}'" fi ;; *-sandbox-*) warning "Terraform workspace set to sandbox environment '${tf_workspace}'" ;; default) warning "Terraform workspace set to '${tf_workspace}'" ;; *) success "Terraform workspace set to '${tf_workspace}'" ;; esac NRLF-3.0.31/scripts/commit-msg.py000077500000000000000000000053231511201605300164540ustar00rootroot00000000000000#!/usr/bin/env python import re import subprocess import sys OK_C = "\033[92m" WARN_C = "\033[93m" FAIL_C = "\033[91m" END_C = "\033[0m" JIRA_REGEX = "(SPII|PCRM|NEMS|KF|IGWAY|NRL|APM|APMSPII|SPY3|SPINECLI)\-(\d+)" # Example match: SPII-12345 FEATURE_REGEX = ( "feature\/\w+\-(\w+\-\d+)\-" # Example match: feature/das-SPII-12345-foo ) OLD_FEATURE_REGEX = "feature\/\w+\-(\d+)\-" # Example match: feature/das-12345-foo sys.stdin = open("/dev/tty") # Ensure that input can be taken by hook MSG_FILE = sys.argv[1] # commit-msg hook provides file name as first arg def appendToCommitMessage(jiraId): print("Appended {0} to commit message.".format(jiraId)) with open(MSG_FILE, "a") as f: f.write("{0}".format(jiraId)) def prependToCommitMessage(jiraId): print("Prepended {} to commit message.".format(jiraId)) with open(MSG_FILE, "r") as f: text = f.read() text = "{} {}".format(jiraId, text) with open(MSG_FILE, "w") as f: f.write(text) # Check if JIRA ID already exists in commit message print("I am doing something") with open(MSG_FILE, "r") as f: msg = "" for line in f: if not line.startswith("#"): msg += line.rstrip() if msg == "": # No commit message let Git fail the commot sys.exit(0) commitMatch = re.search(JIRA_REGEX, msg) if commitMatch: print( "JIRA {0}{1}-{2}{3} referenced by commit message.".format( OK_C, commitMatch.group(1), commitMatch.group(2), END_C ) ) sys.exit(0) print(WARN_C + "No JIRA ID referenced by commit message." + END_C) # Check if KEY-n+ can be used from branch name branch = subprocess.check_output("git rev-parse --abbrev-ref HEAD", shell=True) branchMatch = re.search(FEATURE_REGEX, str(branch)) if branchMatch: response = input( "Use {0}{1}{2} from branch name? (y/n) ".format( OK_C, branchMatch.group(1), END_C ) ) if response.strip().lower().startswith("y"): prependToCommitMessage(branchMatch.group(1)) sys.exit(0) oldBranchMatch = re.search(OLD_FEATURE_REGEX, str(branch)) if oldBranchMatch: jiraId = "SPII-{}".format(oldBranchMatch.group(1)) response = input( "Use {0}{1}{2} from branch name? (y/n) ".format(OK_C, jiraId, END_C) ) if response.strip().lower().startswith("y"): prependToCommitMessage(jiraId) sys.exit(0) # All else fails ask what they want to use jiraId = input("Please enter the JIRA ID (for example SPII-1234 or NEMS-123): ") if not re.search(JIRA_REGEX, jiraId): print(FAIL_C + "Did not provide valid JIRA ID. Commit Aborted." + END_C) sys.exit(1) else: prependToCommitMessage(jiraId) sys.exit(0) NRLF-3.0.31/scripts/delete_all_invalid_pointers.py000066400000000000000000000112501511201605300221140ustar00rootroot00000000000000from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire from nrlf.consumer.fhir.r4.model import DocumentReference from nrlf.core.logger import logger from nrlf.core.validators import DocumentReferenceValidator dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") resource = boto3.resource("dynamodb") logger.setLevel("ERROR") def _validate_document(document: str): docref = DocumentReference.model_validate_json(document) validator = DocumentReferenceValidator() result = validator.validate(data=docref) if not result.is_valid: raise RuntimeError("Failed to validate document: " + str(result.issues)) def _find_invalid_pointers(table_name: str) -> dict[str, Any]: print(f"Finding invalid pointers to delete in table {table_name}....") params: dict[str, Any] = { "TableName": table_name, "PaginationConfig": {"PageSize": 50}, } invalid_pointers = [] total_scanned_count = 0 start_time = datetime.now(tz=timezone.utc) for page in paginator.paginate(**params): for item in page["Items"]: pointer_id = item.get("id", {}).get("S") document = item.get("document", {}).get("S", "") try: _validate_document(document) except Exception as exc: invalid_pointers.append((pointer_id, exc)) total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) if total_scanned_count % 100000 == 0: print(f"scanned={total_scanned_count} invalid={len(invalid_pointers)}") end_time = datetime.now(tz=timezone.utc) print(f" Done. Found {len(invalid_pointers)} invalid pointers") if len(invalid_pointers) > 0: print("Writing invalid pointers IDs to file ./invalid_pointers.txt ...") with open("invalid_pointers.txt", "w") as f: for _id, err in invalid_pointers: f.write(f"{_id}: {err}\n") return { "invalid_pointers": invalid_pointers, "scanned_count": total_scanned_count, "find-took-secs": timedelta.total_seconds(end_time - start_time), } def _delete_pointers(table_name: str, pointers_to_delete: list[str]) -> dict[str, Any]: """ Delete the provided pointers from the given table. """ start_time = datetime.now(tz=timezone.utc) print("Deleting invalid pointers...") pointers_deleted = 0 failed_to_delete = 0 for _batch_id in range(0, len(pointers_to_delete), 25): batch = [ { "DeleteRequest": { "Key": { "pk": {"S": f"D#{pointer_id}"}, "sk": {"S": f"D#{pointer_id}"}, } } } for pointer_id in pointers_to_delete[_batch_id : _batch_id + 25] ] result = dynamodb.batch_write_item(RequestItems={table_name: batch}) unprocessed_items = len(result.get("UnprocessedItems", [])) pointers_deleted += len(batch) - unprocessed_items failed_to_delete += unprocessed_items if pointers_deleted % 1000 == 0: print(".", end="", flush=True) end_time = datetime.now(tz=timezone.utc) print(" Done") return { "pointers_to_delete": len(pointers_to_delete), "deleted_pointers": pointers_deleted, "failed_deletes": failed_to_delete, "deletes-took-secs": timedelta.total_seconds(end_time - start_time), } def _find_and_delete_invalid_pointers(table_name: str) -> dict[str, float | int]: """ Find and delete any pointers in the given table that are invalid based on the FHIR model and NRLF validators. Parameters: - table_name: The name of the pointers table to find and delete pointer from. """ find_result = _find_invalid_pointers(table_name) if len(find_result["invalid_pointers"]) == 0: return { "invalid_pointers": 0, "scanned_count": find_result["scanned_count"], "find-took-secs": find_result["find-took-secs"], } confirmation_input = input( "Would you like to delete all the invalid pointers? (yes/no): " ) if confirmation_input != "yes": print("Invalid pointers NOT deleted.") find_result.pop("invalid_pointers") return find_result pointers_to_delete = [_id for _id, _ in find_result["invalid_pointers"]] delete_result = _delete_pointers(table_name, pointers_to_delete) find_result.pop("invalid_pointers") return {**find_result, **delete_result} if __name__ == "__main__": fire.Fire(_find_and_delete_invalid_pointers) NRLF-3.0.31/scripts/delete_pointers_by_id.py000077500000000000000000000317121511201605300207340ustar00rootroot00000000000000#!/usr/bin/env python import json import os import tempfile from dataclasses import dataclass from datetime import datetime, timedelta, timezone from typing import Any, Dict, List import boto3 import fire dynamodb = boto3.client("dynamodb") def _load_pointers_from_file(pointers_file: str) -> list[str]: """ Read pointers from a file. Supports: - JSON array of objects with an "id" field - line-delimited plain text (one id per line) Returns a list of pointer id strings. Prints a warning for skipped malformed JSON entries. """ with open(pointers_file, "r") as file: content = file.read().strip() if not content: return [] if content.startswith("[") or content.startswith("{"): return _parse_json_pointers(content, pointers_file) return _parse_plain_text_pointers(content) def _parse_json_pointers(content: str, pointers_file: str) -> list[str]: try: data = json.loads(content) except json.JSONDecodeError as e: raise ValueError(f"Failed to parse JSON file {pointers_file}: {e}") from e if not isinstance(data, list): raise ValueError("JSON file must contain an array of objects") parsed_ids: list[str] = [] skipped_count = 0 for item in data: if _is_valid_pointer(item): parsed_ids.append(item["id"].strip()) else: skipped_count += 1 if skipped_count: print( f"Warning: skipped {skipped_count} malformed entries in JSON file {pointers_file}" ) return parsed_ids def _is_valid_pointer(item: Any) -> bool: return ( isinstance(item, dict) and "id" in item and isinstance(item["id"], str) and item["id"].strip() ) def _parse_plain_text_pointers(content: str) -> list[str]: return [line.strip() for line in content.splitlines() if line.strip()] @dataclass class PointerDeletionContext: pointers_to_delete: list[str] ods_code: str matched_pointers: list[str] mismatched_pointers: list[str] not_found_pointers: list[str] pointers_deleted: list[str] failed_deletes: list[str] start_time: datetime end_time: datetime output_filename: str def _build_and_write_result(ctx: PointerDeletionContext) -> Dict[str, Any]: result = { "pointers_to_delete": len(ctx.pointers_to_delete), "ods_code": ctx.ods_code, "ods_code_matched": { "count": len(ctx.matched_pointers), "ids": ctx.matched_pointers, }, "ods_code_mismatched": { "count": len(ctx.mismatched_pointers), "ids": ctx.mismatched_pointers, }, "pointer_not_found": { "count": len(ctx.not_found_pointers), "ids": ctx.not_found_pointers, }, "deleted_pointers": { "count": len(ctx.pointers_deleted), "ids": ctx.pointers_deleted, }, "failed_deletes": {"count": len(ctx.failed_deletes), "ids": ctx.failed_deletes}, "deletes-took-secs": timedelta.total_seconds(ctx.end_time - ctx.start_time), "output_filename": ctx.output_filename, } script_dir = os.path.dirname(os.path.abspath(__file__)) or "." output_file_path = os.path.join(script_dir, ctx.output_filename) try: _write_result_file(result, output_file_path) except Exception as exc: result["_output_error"] = ( f"Failed to write result file {ctx.output_filename}: {exc}" ) _print_summary(result) return result def _write_result_file(result: Dict[str, Any], output_file: str) -> None: out_dir = os.path.dirname(os.path.abspath(output_file)) or "." with tempfile.NamedTemporaryFile( "w", delete=False, dir=out_dir, prefix=".tmp_delete_results_", suffix=".json" ) as tf: json.dump(result, tf, indent=2) tf.flush() os.fsync(tf.fileno()) os.replace(tf.name, output_file) def _print_summary(result: Dict[str, Any]) -> None: def count_from(field): val = result.get(field) if isinstance(val, dict): return val.get("count", 0) if isinstance(val, list): return len(val) return 0 print("*******************************************************") print("Summary:") print(f" pointers_to_delete: {result.get('pointers_to_delete')}") print(f" ods_code_matched: {count_from('ods_code_matched')}") print(f" ods_code_mismatched:{count_from('ods_code_mismatched')}") print(f" pointer_not_found: {count_from('pointer_not_found')}") print(f" deleted_pointers: {count_from('deleted_pointers')}") print(f" failed_deletes: {count_from('failed_deletes')}") if "deletes-took-secs" in result: print(f" deletes-took-secs: {result.get('deletes-took-secs')}") if "_output_error" in result: print(f" output_error: {result['_output_error']}") elif "output_filename" in result: print(f" See output file for full results: {result.get('output_filename')}") print("*******************************************************") def _check_pointers_match_ods_code( ods_code: str, pointer_ids: List[str] ) -> tuple[List[str], List[str]]: matched = [] mismatched = [] for pointer_id in pointer_ids: if pointer_id.startswith(f"{ods_code}-"): matched.append(pointer_id) else: mismatched.append(pointer_id) return matched, mismatched def _batch_get_existing_pointers( table_name: str, pointer_ids: List[str] ) -> tuple[List[str], List[str]]: """ Check which pointers exist using BatchGetItem (max 100 items per request). Returns (existing_ids, not_found_ids) """ existing = [] not_found = [] for batch_idx in range(0, len(pointer_ids), 100): batch_ids = pointer_ids[batch_idx : batch_idx + 100] keys = [ { "pk": {"S": f"D#{pointer_id}"}, "sk": {"S": f"D#{pointer_id}"}, } for pointer_id in batch_ids ] response = dynamodb.batch_get_item(RequestItems={table_name: {"Keys": keys}}) found_ids = { item["pk"]["S"][2:] for item in response.get("Responses", {}).get(table_name, []) } for pointer_id in batch_ids: if pointer_id in found_ids: existing.append(pointer_id) else: not_found.append(pointer_id) return existing, not_found def _batch_delete_pointers( table_name: str, pointer_ids: List[str] ) -> tuple[List[str], List[str]]: """ Delete pointers using BatchWriteItem (max 25 items per request). """ pointers_deleted = [] failed_deletes_set: set[str] = set() for _batch_id in range(0, len(pointer_ids), 25): batch_ptrs = pointer_ids[_batch_id : _batch_id + 25] batch = [ { "DeleteRequest": { "Key": { "pk": {"S": f"D#{pointer_id}"}, "sk": {"S": f"D#{pointer_id}"}, } } } for pointer_id in batch_ptrs ] result = dynamodb.batch_write_item(RequestItems={table_name: batch}) unprocessed = result.get("UnprocessedItems", {}).get(table_name, []) # Collect unprocessed IDs for item in unprocessed: pk_val = item["DeleteRequest"]["Key"]["pk"]["S"] failed_deletes_set.add(pk_val[2:]) # Remove "D#" # Only count successfully deleted items (batch size minus unprocessed) successfully_deleted = [p for p in batch_ptrs if p not in failed_deletes_set] pointers_deleted.extend(successfully_deleted) if len(pointers_deleted) % 1000 == 0 and len(pointers_deleted) > 0: print(".", end="", flush=True) return pointers_deleted, sorted(failed_deletes_set) def _delete_pointers_by_id( table_name: str, ods_code: str, pointers_to_delete: List[str] | None = None, pointers_file: str | None = None, ) -> None: """ Delete pointers from DynamoDB table. Can accept pointers as: - list of strings: pointers_to_delete=["id1", "id2"] - JSON file: pointers_file=/path/to/pointers.json (array of objects with "id" field) - text file: pointers_file=/path/to/ids.txt (one id per line) Parameters: - table_name: DynamoDB table name - ods_code: ODS code of the organisation that the pointers belong to - pointers_to_delete: list of pointer ids to delete - pointers_file: path to JSON file (array of objects with "id" field) or text file (one id per line) Sample usage: - Delete by list of ids: python delete_pointers_by_id.py --table_name MyTable --ods_code ABC123 --pointers_to_delete '["ABC123-12345678910", "ABC123-109876543210"]' - Delete by JSON file: python delete_pointers_by_id.py --table_name MyTable --ods_code ABC123 --pointers_file /path/to/pointers.json - Delete by text file: python delete_pointers_by_id.py --table_name MyTable --ods_code ABC123 --pointers_file /path/to/ids.txt """ if pointers_to_delete is None and pointers_file is None: raise ValueError("Provide either pointers_to_delete or pointers_file") if pointers_to_delete is not None and pointers_file is not None: raise ValueError("Provide either pointers_to_delete or pointers_file, not both") if pointers_file: pointers_to_delete = _load_pointers_from_file(pointers_file) start_time = datetime.now(tz=timezone.utc) timestamp = start_time.strftime("%Y%m%dT%H%M%SZ") output_filename = f"delete_results_{ods_code}_{timestamp}.json" if not pointers_to_delete: end_time = datetime.now(tz=timezone.utc) _build_and_write_result( PointerDeletionContext( pointers_to_delete=pointers_to_delete, ods_code=ods_code, matched_pointers=[], mismatched_pointers=[], not_found_pointers=[], pointers_deleted=[], failed_deletes=[], start_time=start_time, end_time=end_time, output_filename=output_filename, ) ) return print( f"Validating {len(pointers_to_delete)} pointers against ODS code {ods_code}..." ) matched_pointers, mismatched_pointers = _check_pointers_match_ods_code( ods_code, pointers_to_delete ) print( f"Validate pointer's ODS code: {len(matched_pointers)} matched, {len(mismatched_pointers)} mismatched" ) if not matched_pointers: print(f"None of the pointer IDs are a match for ODS code {ods_code}. Exiting.") end_time = datetime.now(tz=timezone.utc) _build_and_write_result( PointerDeletionContext( pointers_to_delete=pointers_to_delete, ods_code=ods_code, matched_pointers=matched_pointers, mismatched_pointers=mismatched_pointers, not_found_pointers=[], pointers_deleted=[], failed_deletes=[], start_time=start_time, end_time=end_time, output_filename=output_filename, ) ) return print(f"Checking existence of {len(matched_pointers)} pointers in {table_name}...") existing_pointers, not_found_pointers = _batch_get_existing_pointers( table_name, matched_pointers ) print( f"Found {len(existing_pointers)} existing pointers to delete, {len(not_found_pointers)} not found." ) if not existing_pointers: print("No pointers found to delete. Exiting.") end_time = datetime.now(tz=timezone.utc) _build_and_write_result( PointerDeletionContext( pointers_to_delete=pointers_to_delete, ods_code=ods_code, matched_pointers=matched_pointers, mismatched_pointers=mismatched_pointers, not_found_pointers=not_found_pointers, pointers_deleted=[], failed_deletes=[], start_time=start_time, end_time=end_time, output_filename=output_filename, ) ) return # Proceed with deletion using BatchWriteItem pointers_deleted, failed_deletes = _batch_delete_pointers( table_name, existing_pointers ) end_time = datetime.now(tz=timezone.utc) _build_and_write_result( PointerDeletionContext( pointers_to_delete=pointers_to_delete, ods_code=ods_code, matched_pointers=matched_pointers, mismatched_pointers=mismatched_pointers, not_found_pointers=not_found_pointers, pointers_deleted=pointers_deleted, failed_deletes=failed_deletes, start_time=start_time, end_time=end_time, output_filename=output_filename, ) ) print(" Done") if __name__ == "__main__": fire.Fire(_delete_pointers_by_id) NRLF-3.0.31/scripts/find_patients_with_org_pointers.py000066400000000000000000000053741511201605300230570ustar00rootroot00000000000000import json from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire from nrlf.consumer.fhir.r4.model import DocumentReference from nrlf.core.constants import PointerTypes from nrlf.core.logger import logger type PatientCounter = dict[int, int] type TypePatientCounter = dict[str, PatientCounter] type OrgTypePatientCounter = dict[str, TypePatientCounter] dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") logger.setLevel("ERROR") type_to_name = {pointer_type.value: pointer_type.name for pointer_type in PointerTypes} def _find_patients( table_name: str, number_of_patients: int = 1, number_of_pointers: int = 1, org_ods_code: str = "X26", pointer_type: str = PointerTypes.MENTAL_HEALTH_PLAN.value, ) -> dict[str, float | int]: print(f"Looking for {number_of_patients} patient(s)") # noqa print(f" with {number_of_pointers} or more pointers") # noqa print(f" of type {type_to_name[pointer_type]} ") # noqa print(f" produced by org {org_ods_code}") # noqa print(f" in table {table_name}") # noqa params: dict[str, Any] = { "TableName": table_name, "PaginationConfig": {"PageSize": 50}, "Select": "SPECIFIC_ATTRIBUTES", "AttributesToGet": ["custodian", "nhs_number", "type"], } total_scanned_count = 0 start_time = datetime.now(tz=timezone.utc) found_patients: set[str] = set() patient_counters: dict[str, Any] = {} for page in paginator.paginate(**params): for item in page["Items"]: patient_number = item.get("nhs_number", {}).get("S", "") producer = item.get("custodian", {}).get("S", "") type_str = item.get("type", {}).get("S", "") if producer != org_ods_code or type_str != pointer_type: continue patient_counters[patient_number] = ( patient_counters.get(patient_number, 0) + 1 ) if patient_counters[patient_number] >= number_of_pointers: found_patients.add(patient_number) if len(found_patients) >= number_of_patients: print(f"Found {len(found_patients)} patients") break total_scanned_count += page["ScannedCount"] if total_scanned_count % 1000 == 0: print(".", end="", flush=True) # noqa if total_scanned_count % 100000 == 0: print(f"scanned={total_scanned_count}") # noqa end_time = datetime.now(tz=timezone.utc) print("Done") # noqa return { "scanned_count": total_scanned_count, "took-secs": timedelta.total_seconds(end_time - start_time), "patients": str(found_patients), } if __name__ == "__main__": fire.Fire(_find_patients) NRLF-3.0.31/scripts/get-account-name-for-env.sh000077500000000000000000000007051511201605300210620ustar00rootroot00000000000000#!/bin/bash # Get the account name for the provided NRLF environment set -o errexit -o nounset -o pipefail if [ $# -ne 1 ]; then echo "Usage: get-account-name-for-env.sh " exit 1 fi env="$1" case "${env}" in dev|dev-sandbox) echo "dev" ;; qa|qa-sandbox|perftest|ref|int|int-sandbox) echo "test" ;; prod) echo "prod" ;; *) echo "Unknown" exit 1 esac exit 0 NRLF-3.0.31/scripts/get-current-info.sh000077500000000000000000000010471511201605300175510ustar00rootroot00000000000000#!/bin/bash # Get the current info about the codebase set -o errexit -o nounset -o pipefail BRANCH_NAME="$(git rev-parse --abbrev-ref HEAD)" TAG_NAME="$(git describe --tags || echo "no-tags")" SHORT_COMMIT_HASH="$(git rev-parse --short=8 HEAD)" if [ "${BRANCH_NAME}" == "HEAD" ]; then NRLF_VERSION="${TAG_NAME}@${SHORT_COMMIT_HASH}" else NRLF_VERSION="${BRANCH_NAME}@${SHORT_COMMIT_HASH}" fi cat << EOF { "version": "${NRLF_VERSION}", "tag": "${TAG_NAME}", "branch": "${BRANCH_NAME}", "commit": "${SHORT_COMMIT_HASH}" } EOF NRLF-3.0.31/scripts/get-envs-for-account.sh000077500000000000000000000011651511201605300203300ustar00rootroot00000000000000#!/bin/bash # Get the names of all environments in a provided NRL AWS account set -o errexit -o nounset -o pipefail if [[ $# -ne 1 ]]; then echo "Usage: get-envs-for-account.sh " exit 1 fi account="$1" case "${account}" in dev) envs_array=("dev" "dev-sandbox") echo ${envs_array[@]} ;; test) envs_array=("qa" "perftest" "ref" "int" "int-sandbox") # "qa-sandbox" currently broken echo ${envs_array[@]} ;; prod) envs_array=("prod") echo ${envs_array[@]} ;; *) echo "Unknown account ${account}" exit 1 esac NRLF-3.0.31/scripts/get_env_config.py000066400000000000000000000013511511201605300173460ustar00rootroot00000000000000#!/usr/bin/env python import json import sys import fire from aws_session_assume import get_boto_session def main(parameter_name: str, env: str): boto_session = get_boto_session(env) sm = boto_session.client("secretsmanager") secret_key = f"nhsd-nrlf--{env}--env-config" response = sm.get_secret_value(SecretId=secret_key) parameters = json.loads(response["SecretString"]) if parameter_name == "all": print(parameters) elif parameter_name in parameters: print(parameters[parameter_name]) else: print( f"Parameter {parameter_name} not found in environment config", file=sys.stderr, ) sys.exit(1) if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/scripts/get_s3_permissions.py000066400000000000000000000052241511201605300202140ustar00rootroot00000000000000#!/usr/bin/env python import json from os import path from pathlib import Path import fire from aws_session_assume import get_boto_session from nrlf.core.constants import PointerTypes def get_file_folders(s3_client, bucket_name, prefix=""): print("Getting file folders to download...") file_names = [] folders = [] default_kwargs = {"Bucket": bucket_name, "Prefix": prefix} next_token = "" while next_token is not None: updated_kwargs = default_kwargs.copy() if next_token != "": updated_kwargs["ContinuationToken"] = next_token response = s3_client.list_objects_v2(**updated_kwargs) contents = response.get("Contents") for result in contents: key = result.get("Key") if key[-1] == "/": folders.append(key) else: file_names.append(key) next_token = response.get("NextContinuationToken") return file_names, folders def add_test_files(folder, file_name, local_path): print("Adding test files to temporary directory...") folder_path = Path.joinpath(local_path, folder) # Create all folders in the path folder_path.mkdir(parents=True, exist_ok=True) file_path = Path.joinpath(folder_path, file_name) file_path.parent.mkdir(parents=True, exist_ok=True) with open(file_path, "w") as f: json.dump(PointerTypes.list(), f) def download_files(s3_client, bucket_name, local_path, file_names, folders): print(f"Downloading {len(file_names)} S3 files to temporary directory...") local_path = Path(local_path) for folder in folders: folder_path = Path.joinpath(local_path, folder) # Create all folders in the path folder_path.mkdir(parents=True, exist_ok=True) for file_name in file_names: file_path = Path.joinpath(local_path, file_name) # Create folder for parent directory file_path.parent.mkdir(parents=True, exist_ok=True) s3_client.download_file(bucket_name, file_name, str(file_path)) add_test_files("K6PerformanceTest", "Y05868.json", local_path) def main(use_shared_resources: str, env: str, workspace: str, path_to_store: str): stack_name = env if use_shared_resources else workspace bucket = f"nhsd-nrlf--{stack_name}-authorization-store" boto_session = get_boto_session(env) s3 = boto_session.client("s3") files, folders = get_file_folders(s3, bucket) download_files( s3, bucket, path.abspath(path.join(path_to_store + "/nrlf_permissions")), files, folders, ) print("Downloaded S3 permissions...") if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/scripts/manage_permissions.py000077500000000000000000000161071511201605300202650ustar00rootroot00000000000000#!/usr/bin/env python import json import os import fire from aws_session_assume import get_boto_session from nrlf.core.constants import TYPE_ATTRIBUTES nrl_env = os.getenv("ENV", "dev") nrl_auth_bucket_name = os.getenv( "NRL_AUTH_BUCKET_NAME", f"nhsd-nrlf--{nrl_env}-authorization-store" ) COMPARE_AND_CONFIRM = ( True if nrl_env == "prod" else os.getenv("COMPARE_AND_CONFIRM", "false").lower() == "true" ) print(f"Using NRL environment: {nrl_env}") print(f"Using NRL auth bucket: {nrl_auth_bucket_name}") print(f"Compare and confirm mode: {COMPARE_AND_CONFIRM}") print() def _get_s3_client(): boto_session = get_boto_session(nrl_env) return boto_session.client("s3") def _list_s3_keys(file_key_prefix: str) -> list[str]: s3 = _get_s3_client() paginator = s3.get_paginator("list_objects_v2") params = { "Bucket": nrl_auth_bucket_name, "Prefix": file_key_prefix, } page_iterator = paginator.paginate(**params) keys: list[str] = [] for page in page_iterator: if "Contents" in page: keys.extend([item["Key"] for item in page["Contents"]]) if not keys: print(f"No files found with prefix: {file_key_prefix}") return [] return keys def _get_perms_from_s3(file_key: str) -> str | None: s3 = _get_s3_client() try: item = s3.get_object(Bucket=nrl_auth_bucket_name, Key=file_key) except s3.exceptions.NoSuchKey: print(f"Permissions file {file_key} does not exist in the bucket.") return None if "Body" not in item: print(f"No body found for permissions file {file_key}.") return None return item["Body"].read().decode("utf-8") def list_apps() -> None: """ List all applications in the NRL environment. """ keys = _list_s3_keys("") apps = {key.split("/")[0] for key in keys} if not apps: print("No applications found in the bucket.") return print(f"There are {len(apps)} apps in {nrl_env} env:") for app in apps: print(f"- {app}") def list_orgs(app_id: str) -> None: """ List all organizations for a specific application. """ keys = _list_s3_keys(f"{app_id}/") orgs = [ key.split("/", maxsplit=2)[1].removesuffix(".json") for key in keys if key and key.endswith(".json") ] if not orgs: print(f"No organizations found for app {app_id}.") print(f"There are {len(orgs)} organizations for app {app_id}:") for org in orgs: print(f"- {org}") def list_allowed_types() -> None: """ List all pointer types that can be used in permissions. """ print("The following pointer-types are allowed:") for pointer_type, attributes in TYPE_ATTRIBUTES.items(): print("- %-45s (%s)" % (pointer_type, attributes["display"][:45])) def show_perms(app_id: str, org_ods: str) -> None: """ Show the permissions for a specific application and organization. """ perms = _get_perms_from_s3(f"{app_id}/{org_ods}.json") if not perms: print(f"No permissions file found for {app_id}/{org_ods}.") return pointertype_perms = json.loads(perms) if not pointertype_perms: print(f"No pointer-types found in permission file for {app_id}/{org_ods}.") return type_data = { pointertype_perm: TYPE_ATTRIBUTES.get( pointertype_perm, {"display": "Unknown type"} ) for pointertype_perm in pointertype_perms } types = [ "%-45s (%s)" % (type_data[pointertype_perm]["display"][:44], pointertype_perm) for pointertype_perm in pointertype_perms ] print(f"{app_id}/{org_ods} is allowed to access these pointer-types:") for type_display in types: print(f"- {type_display}") def set_perms(app_id: str, org_ods: str, *pointer_types: str) -> None: """ Set permissions for an application and organization to access specific pointer types. """ if not pointer_types: print( "No pointer types provided. Please specify at least one pointer type or use clear_perms command." ) return if len(pointer_types) == 1 and pointer_types[0] == "all": print("Setting permissions for access to all pointer types.") pointer_types = tuple(TYPE_ATTRIBUTES.keys()) unknown_types = [pt for pt in pointer_types if pt not in TYPE_ATTRIBUTES] if unknown_types: print(f"Error: Unknown pointer types provided: {', '.join(unknown_types)}") print() return permissions_content = json.dumps(pointer_types, indent=4) if COMPARE_AND_CONFIRM: current_perms = _get_perms_from_s3(f"{app_id}/{org_ods}.json") if current_perms == permissions_content: print( f"No changes needed for {app_id}/{org_ods}. Current permissions match the new ones." ) return print() print(f"Current permissions for {app_id}/{org_ods}:") print(current_perms if current_perms else "No permissions set.") print() print("New permissions to be set to:") print(f"{permissions_content}") print() confirm = ( input("Do you want to proceed with these changes? (yes/NO): ") .strip() .lower() ) if confirm != "yes": print("Operation cancelled at user request.") return s3 = _get_s3_client() s3.put_object( Bucket=nrl_auth_bucket_name, Key=f"{app_id}/{org_ods}.json", Body=permissions_content, ContentType="application/json", ) print() print(f"Set permissions for {app_id}/{org_ods}") print() show_perms(app_id, org_ods) def clear_perms(app_id: str, org_ods: str) -> None: """ Clear permissions for an application and organization. This will remove all permissions for the specified app and org. """ if COMPARE_AND_CONFIRM: current_perms = _get_perms_from_s3(f"{app_id}/{org_ods}.json") if not current_perms or current_perms == "[]": print( f"No need to clear permissions for {app_id}/{org_ods} as it currently has no permissions set." ) return print() print(f"Current permissions for {app_id}/{org_ods}:") print(current_perms) print() confirm = ( input("Are you SURE you want to clear these permissions? (yes/NO): ") .strip() .lower() ) if confirm != "yes": print("Operation cancelled at user request.") return s3 = _get_s3_client() s3.put_object( Bucket=nrl_auth_bucket_name, Key=f"{app_id}/{org_ods}.json", Body="[]", ContentType="application/json", ) print(f"Cleared permissions for {app_id}/{org_ods}.") if __name__ == "__main__": fire.Fire( { "list_apps": list_apps, "list_orgs": list_orgs, "list_allowed_types": list_allowed_types, "show_perms": show_perms, "set_perms": set_perms, "clear_perms": clear_perms, } ) NRLF-3.0.31/scripts/pull-lambda-code-for-stack.sh000077500000000000000000000040001511201605300213420ustar00rootroot00000000000000#!/bin/bash # Pull down all the lambda code for the named stack set -o errexit -o nounset -o pipefail : "${DIST_DIR:="./dist"}" if [ $# -ne 1 ] then echo "Error: stack-name argument is missing" 1>&2 echo "Usage: $0 " 1>&2 exit 1 fi stack_name="$1" function pull_lambda_code(){ local api_name="$1" local endpoint_name="$2" lambda_name="nhsd-nrlf--${stack_name}--api--${api_name}--${endpoint_name}" echo -n "- Downloading code for lambda ${lambda_name}.... " code_url="$(aws lambda get-function --function-name "${lambda_name}" | jq -r .Code.Location)" curl "${code_url}" 2>/dev/null > "${DIST_DIR}/${api_name}-${endpoint_name}.zip" echo "✅" } function pull_layer_code(){ local name="$1" layer_name="nhsd-nrlf--${stack_name}--${name}" layer_pkg_name="$(echo "${name}" | tr '-' '_').zip" layer_version="$(aws lambda list-layer-versions --layer-name "${layer_name}" | jq -r '.LayerVersions[0].Version')" echo -n "- Downloading code for layer ${layer_name} version ${layer_version}.... " code_url="$(aws lambda get-layer-version --layer-name "${layer_name}" --version-number "${layer_version}" | jq -r .Content.Location)" curl "${code_url}" 2>/dev/null > "${DIST_DIR}/${layer_pkg_name}" echo "✅" } mkdir -p "${DIST_DIR}" echo echo "Pulling code for consumer API lambdas...." for endpoint_path in api/consumer/* do if [ ! -d "${endpoint_path}" ] then continue fi endpoint_name="$(basename "${endpoint_path}")" pull_lambda_code "consumer" "${endpoint_name}" done echo echo "Pulling code for producer API lambdas...." for endpoint_path in api/producer/* do if [ ! -d "${endpoint_path}" ] then continue fi endpoint_name="$(basename "${endpoint_path}")" pull_lambda_code "producer" "${endpoint_name}" done echo echo "Pulling code for layers...." for layer_name in nrlf dependency-layer nrlf-permissions do pull_layer_code "${layer_name}" done echo echo "✅ Done. Code is in ${DIST_DIR}" echo NRLF-3.0.31/scripts/put_pointers_from_files.py000066400000000000000000000032511511201605300213330ustar00rootroot00000000000000#!/usr/bin/env python # Put pointers from the provided files into the pointers table # This will overwrite the pointer if it already exists in the table import json import os import fire from aws_session_assume import get_boto_session from nrlf.core.dynamodb.model import DocumentPointer from nrlf.core.logger import logger from nrlf.producer.fhir.r4.model import DocumentReference logger.setLevel("ERROR") SKIP_PROD_WARNING = os.getenv("SKIP_PROD_WARNING", "false") def _put_pointers_from_files( *filenames, env: str = "dev", table_name: str | None = None ): if env == "prod" and SKIP_PROD_WARNING != "true": confirmation = input( "\nWARNING - This command will modify the PROD environment. Continue? [y/n] " ) if confirmation != "y": return "Exiting at user request" docrefs: list[DocumentReference] = [] print("Reading docrefs from files...") for filename in filenames: with open(filename) as f: docref_json = json.load(f) docref = DocumentReference.model_validate(docref_json) docrefs.append(docref) session = get_boto_session(env) dynamodb = session.resource("dynamodb") if not table_name: table_name = f"nhsd-nrlf--{env}-pointers-table" table = dynamodb.Table(table_name) for docref in docrefs: try: print(f"Putting {docref.id}....") pointer = DocumentPointer.from_document_reference(docref) table.put_item(Item=pointer.model_dump()) except Exception as e: print(f"Unable to put pointer for {docref.id}. Error: {e}") if __name__ == "__main__": fire.Fire(_put_pointers_from_files) NRLF-3.0.31/scripts/redact_live_pointers.py000066400000000000000000000065561511201605300206120ustar00rootroot00000000000000import json import os from datetime import datetime, timedelta, timezone from typing import Any import boto3 import fire from nrlf.consumer.fhir.r4.model import DocumentReference from nrlf.core.constants import PointerTypes from nrlf.core.logger import logger from nrlf.core.utils import create_fhir_instant from nrlf.core.validators import DocumentReferenceValidator dynamodb = boto3.client("dynamodb") paginator = dynamodb.get_paginator("scan") logger.setLevel("ERROR") type_to_name = {pointer_type.value: pointer_type.name for pointer_type in PointerTypes} def _redact_timestamps(docref: DocumentReference) -> None: mock_timestamp = create_fhir_instant() docref.meta.lastUpdated = mock_timestamp docref.date = mock_timestamp def _redact_ids(docref: DocumentReference) -> None: ods_code = docref.custodian.identifier.value mock_id = "c2a99222-eb50-4451-ad6e-1e951627800e" docref.subject.identifier.value = "9999999999" docref.id = f"{ods_code}-{mock_id}" if docref.masterIdentifier: docref.masterIdentifier.value = f"mid_{mock_id}" if docref.relatesTo: for relates_to in docref.relatesTo: relates_to.target.identifier.value = f"rel_{mock_id}" def _redact_content(docref: DocumentReference) -> None: mock_timestamp = create_fhir_instant() for content in docref.content: if content.attachment.url.startswith("ssp://"): content.attachment.url = "ssp://content.test.local/content" else: content.attachment.url = "https://content.test.local/content" content.attachment.creation = mock_timestamp def _redact_context(docref: DocumentReference) -> None: if docref.context.related: for related in docref.context.related: related.identifier.value = "012345678910" mock_timestamp = create_fhir_instant() if docref.context.period: if docref.context.period.start: docref.context.period.start = mock_timestamp if docref.context.period.end: docref.context.period.end = mock_timestamp def _redact_pointers(src_path: str, dest_path: str) -> None: """ Redact pointers in .json files in from the source path and write the redacted pointer to the destination path. Parameters: - src_path: The path to the source directory containing the pointers. - dest_path: The path to the destination directory to write the redacted pointers. """ src_pointer_files = [f for f in os.listdir(src_path) if f.endswith(".json")] for src_pointer_file in src_pointer_files: print("Reading", src_pointer_file) with open(f"{src_path}/{src_pointer_file}", "r") as f: pointer_data = f.read() docref = DocumentReference.model_validate_json(pointer_data) ods_code = docref.custodian.identifier.value type_coding = docref.type.coding[0] pointer_type = type_to_name[f"{type_coding.system}|{type_coding.code}"] _redact_ids(docref) _redact_timestamps(docref) _redact_content(docref) _redact_context(docref) month_year = datetime.now().strftime("%b%y") filename = f"{dest_path}/{ods_code}_{pointer_type}_{month_year}.json" print("Writing", filename) with open(filename, "w") as f: f.write(docref.model_dump_json(indent=2, exclude_unset=True)) if __name__ == "__main__": fire.Fire(_redact_pointers) NRLF-3.0.31/scripts/set_env_config.py000077500000000000000000000025311511201605300173660ustar00rootroot00000000000000#!/usr/bin/env python import json import sys import fire from aws_session_assume import get_boto_session def main(parameter_name: str, parameter_value: str, env: str): boto_session = get_boto_session(env) sm = boto_session.client("secretsmanager") secret_key = f"nhsd-nrlf--{env}--env-config" response = sm.get_secret_value(SecretId=secret_key) parameters = json.loads(response["SecretString"]) if parameter_name in parameters: current_value = parameters[parameter_name] if current_value == parameter_value: print( f"'{parameter_name}' already set to '{parameter_value}'. No changes made." ) sys.exit(0) print( f"Updating '{parameter_name}' from '{current_value}' to '{parameter_value}'...." ) parameters[parameter_name] = parameter_value else: print(f"Adding '{parameter_name}' with value '{parameter_value}'....") parameters[parameter_name] = parameter_value response = sm.put_secret_value( SecretId=secret_key, SecretString=json.dumps(parameters) ) if response["ResponseMetadata"]["HTTPStatusCode"] == 200: print("Updated successfully") else: print(f"Update failed with: {response}", file=sys.stderr) sys.exit(1) if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/scripts/set_pointer_supersede.py000066400000000000000000000057541511201605300210170ustar00rootroot00000000000000#!/usr/bin/env python # Set supersede info on a pointer import json import os import aws_session_assume import fire from nrlf.core.dynamodb.model import DocumentPointer from nrlf.core.logger import logger from nrlf.producer.fhir.r4.model import ( DocumentReference, DocumentReferenceRelatesTo, Identifier, Reference, ) logger.setLevel("ERROR") SKIP_PROD_WARNING = os.getenv("SKIP_PROD_WARNING", "false") def _set_pointer_supersede_info( pointer_id: str, supersede_pointer_id: str, delete_superseded: bool = False, env: str = "dev", table_name: str | None = None, ): if env == "prod" and SKIP_PROD_WARNING != "true": confirmation = input( "\nWARNING - This command will modify the PROD environment. Continue? [y/n] " ) if confirmation != "y": return "Exiting at user request" session = aws_session_assume.get_boto_session(env) dynamodb = session.resource("dynamodb") if not table_name: table_name = f"nhsd-nrlf--{env}-pointers-table" table = dynamodb.Table(table_name) print( f"Setting pointer {pointer_id} in {table_name} to supersede {supersede_pointer_id}...." ) try: doc_key = f"D#{pointer_id}" print(f"Getting {pointer_id}...") result = table.get_item( Key={"pk": doc_key, "sk": doc_key}, ) except Exception as e: print(f"Unable to get pointer. Error: {e}") return if "Item" not in result: print(f"Unable to set superseded info. Pointer {pointer_id} not found.") return item = result["Item"] try: pointer = DocumentPointer.model_validate({"_from_dynamo": True, **item}) doc_ref = DocumentReference.model_validate_json(pointer.document) except Exception as e: print(f"Could not validate pointer from table. Error: {e}") return if not doc_ref.relatesTo: doc_ref.relatesTo = [] existing_supersedes = [ relates_to for relates_to in doc_ref.relatesTo if relates_to.code == "replaces" ] if existing_supersedes: print( f"Unable to add supersede info as pointer is already superseding a pointer: {existing_supersedes}" ) return doc_ref.relatesTo.append( DocumentReferenceRelatesTo( code="replaces", target=Reference( type="DocumentReference", identifier=Identifier(value=supersede_pointer_id), ), ) ) print(f"Adding supersede info to {pointer_id}...") updated_pointer = DocumentPointer.from_document_reference(doc_ref) table.put_item( Item=updated_pointer.dict(exclude_none=True, exclude={"_from_dynamo"}) ) if delete_superseded: print(f"Deleting superseded {supersede_pointer_id}...") table.delete_item( Key={"pk": f"D#{supersede_pointer_id}", "sk": f"D#{supersede_pointer_id}"} ) if __name__ == "__main__": fire.Fire(_set_pointer_supersede_info) NRLF-3.0.31/scripts/set_smoketest_permissions.py000077500000000000000000000023141511201605300217210ustar00rootroot00000000000000#!/usr/bin/env python import json from os import path from pathlib import Path import fire from aws_session_assume import get_boto_session def main(secret_env_name: str = "dev", bucket_env_name: str = "dev", env: str = "dev"): boto_session = get_boto_session(env) print("Getting smoke test parameters from AWS....") # noqa smoke_test_params_name = f"nhsd-nrlf--{secret_env_name}--smoke-test-parameters" secretsmanager = boto_session.client("secretsmanager", region_name="eu-west-2") smoke_test_params_value = secretsmanager.get_secret_value( SecretId=smoke_test_params_name ) print("Parsing parameters....") # noqa smoke_test_params = json.loads(smoke_test_params_value["SecretString"]) nrlf_app_id = smoke_test_params["nrlf_app_id"] ods_code = smoke_test_params["ods_code"] print(f"Adding {ods_code} permissions to {nrlf_app_id} app in S3....") # noqa bucket = f"nhsd-nrlf--{bucket_env_name}-authorization-store" s3 = boto_session.client("s3") s3.put_object( Bucket=bucket, Key=f"{nrlf_app_id}/{ods_code}.json", Body=open(f"./tests/smoke/permissions/{ods_code}.json", "rb"), ) if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/scripts/tests/000077500000000000000000000000001511201605300151625ustar00rootroot00000000000000NRLF-3.0.31/scripts/tests/test_activate_stack.py000066400000000000000000000122031511201605300215560ustar00rootroot00000000000000import json import os import pytest from scripts.activate_stack import _parse_env_config, activate_stack @pytest.fixture def mock_secretsmanager(mocker): mock_secretsmanager = mocker.MagicMock() mock_env_configs = {} mock_secretsmanager.get_secret_value.side_effect = lambda SecretId: { "SecretId": SecretId, "SecretString": json.dumps(mock_env_configs[SecretId]), } mock_secretsmanager.create_secret.side_effect = lambda Name, SecretString: { mock_env_configs.update({Name: json.loads(SecretString)}) } mock_secretsmanager.put_secret_value.side_effect = lambda SecretId, SecretString: { mock_env_configs.update({SecretId: json.loads(SecretString)}) } return mock_secretsmanager @pytest.fixture def mock_apigw(mocker): mock_apigw = mocker.MagicMock() mock_rest_apis = [ {"name": "nhsd-nrlf--test-stack-1--consumer", "id": "consumer-id"}, {"name": "nhsd-nrlf--test-stack-1--producer", "id": "producer-id"}, {"name": "nhsd-nrlf--test-stack-2--consumer", "id": "consumer-id"}, {"name": "nhsd-nrlf--test-stack-2--producer", "id": "producer-id"}, ] mock_apigw.get_rest_apis.return_value = {"items": mock_rest_apis} return mock_apigw @pytest.fixture def mock_apigwv2(mocker): mock_apigwv2 = mocker.MagicMock() mock_api_mappings = { "consumer-id": {"ApiMappingKey": "consumer", "ApiMappingId": "consumer-id"}, "producer-id": {"ApiMappingKey": "producer", "ApiMappingId": "producer-id"}, } mock_apigwv2.get_api_mappings.return_value = {"Items": mock_api_mappings.values()} return mock_apigwv2 @pytest.fixture(scope="function") def mock_boto_session(mocker, mock_secretsmanager, mock_apigw, mock_apigwv2): mock_boto_session = mocker.MagicMock() mock_boto_session.client.side_effect = lambda service_name: { "secretsmanager": mock_secretsmanager, "apigateway": mock_apigw, "apigatewayv2": mock_apigwv2, }[service_name] return mock_boto_session def _create_mock_env_config(): return { "lock-state": "open", "active-stack": "test-stack-1", "active-version": "v1", "inactive-stack": "test-stack-2", "inactive-version": "v2", "domain-name": "test.domain.name", } def test_happy_path(mock_boto_session, mock_secretsmanager): mock_env_config = _create_mock_env_config() mock_secretsmanager.create_secret( Name="nhsd-nrlf--happy-path--env-config", SecretString=json.dumps(mock_env_config), ) activate_stack("test-stack-2", "happy-path", session=mock_boto_session) result = mock_secretsmanager.get_secret_value( SecretId="nhsd-nrlf--happy-path--env-config" # pragma: allowlist secret ) expected_env_config = { **mock_env_config, "active-stack": "test-stack-2", "active-version": "v2", "inactive-stack": "test-stack-1", "inactive-version": "v1", } assert result["SecretString"] == json.dumps(expected_env_config) def test_lock_state_not_open(mock_boto_session, mock_secretsmanager): inital_env_config = { **_create_mock_env_config(), "lock-state": "locked", } mock_secretsmanager.create_secret( Name="nhsd-nrlf--locked--env-config", SecretString=json.dumps(inital_env_config) ) with pytest.raises(SystemExit) as excinfo: activate_stack("test-stack-1", "locked", session=mock_boto_session) assert excinfo.value.code == 1 result = mock_secretsmanager.get_secret_value( SecretId="nhsd-nrlf--locked--env-config" # pragma: allowlist secret ) assert result["SecretString"] == json.dumps(inital_env_config) def test_stack_already_active(mock_boto_session, mock_secretsmanager): intial_env_config = { **_create_mock_env_config(), "inactive-stack": "test-stack-1", "active-stack": "test-stack-2", } mock_secretsmanager.create_secret( Name="nhsd-nrlf--already-active--env-config", SecretString=json.dumps(intial_env_config), ) with pytest.raises(SystemExit) as excinfo: activate_stack("test-stack-2", "already-active", session=mock_boto_session) assert excinfo.value.code == 1 result = mock_secretsmanager.get_secret_value( SecretId="nhsd-nrlf--already-active--env-config" # pragma: allowlist secret ) assert result["SecretString"] == json.dumps(intial_env_config) def test_parse_env_config_valid(): valid_config = json.dumps(_create_mock_env_config()) result = _parse_env_config(valid_config) assert result == _create_mock_env_config() def test_parse_env_config_empty(): with pytest.raises(ValueError): _parse_env_config("") def test_parse_env_config_invalid_json(): with pytest.raises(ValueError): _parse_env_config("this is not JSON!") def test_parse_env_config_missing_params(): with pytest.raises(ValueError): _parse_env_config(json.dumps({"lock-state": "open"})) def test_parse_env_config_invalid_lock_state(): with pytest.raises(ValueError): _parse_env_config( json.dumps({**_create_mock_env_config(), "lock-state": "invalid"}) ) NRLF-3.0.31/scripts/tests/test_delete_pointers_by_id.py000066400000000000000000000332141511201605300231310ustar00rootroot00000000000000import json from datetime import datetime, timezone from unittest.mock import MagicMock, call, patch import pytest from delete_pointers_by_id import ( PointerDeletionContext, _batch_delete_pointers, _batch_get_existing_pointers, _build_and_write_result, _check_pointers_match_ods_code, _delete_pointers_by_id, _is_valid_pointer, _load_pointers_from_file, _parse_json_pointers, _parse_plain_text_pointers, ) class TestLoadPointersFromFile: @patch("builtins.open", create=True) def test_load_json_array(self, mock_open): mock_open.return_value.__enter__.return_value.read.return_value = ( '[{"id": "G3H9E-id1"}, {"id": "G3H9E-id2"}]' ) result = _load_pointers_from_file("./pointers.json") assert result == ["G3H9E-id1", "G3H9E-id2"] @patch("builtins.open", create=True) def test_load_plain_text_file(self, mock_open): mock_open.return_value.__enter__.return_value.read.return_value = ( "G3H9E-id1\nG3H9E-id2\nG3H9E-id3" ) result = _load_pointers_from_file("./ids.txt") assert result == ["G3H9E-id1", "G3H9E-id2", "G3H9E-id3"] @patch("builtins.open", create=True) def test_load_empty_file(self, mock_open): mock_open.return_value.__enter__.return_value.read.return_value = "" result = _load_pointers_from_file("./empty.txt") assert result == [] class TestParseJsonPointers: def test_invalid_json(self): content = '[{"id": "G3H9E-id1"' with pytest.raises(ValueError, match="Failed to parse JSON file"): _parse_json_pointers(content, "./invalid.json") def test_json_not_array(self): content = '{"id": "G3H9E-id1"}' with pytest.raises( ValueError, match="JSON file must contain an array of objects" ): _parse_json_pointers(content, "./not_array.json") def test_valid_json_array(self): content = '[{"id": "G3H9E-id1"}, {"id": "G3H9E-id2"}]' result = _parse_json_pointers(content, "./pointers.json") assert result == ["G3H9E-id1", "G3H9E-id2"] def test_json_with_malformed_entries(self): content = '[{"id": "G3H9E-id1"}, {"patient_number": "123"}, {"id": ""}, {"id": "G3H9E-id2"}]' result = _parse_json_pointers(content, "./pointers.json") assert result == ["G3H9E-id1", "G3H9E-id2"] class TestIsValidPointer: def test_valid_pointer(self): item = {"id": "G3H9E-id1"} assert _is_valid_pointer(item) def test_missing_id_field(self): item = {"patient_number": "123"} assert not _is_valid_pointer(item) def test_empty_id_field(self): item = {"id": ""} assert not _is_valid_pointer(item) def test_non_string_id_field(self): item = {"id": 123} assert not _is_valid_pointer(item) def test_non_dict_item(self): item = ["id", "G3H9E-id1"] assert not _is_valid_pointer(item) class TestParsePlainTextPointers: def test_valid_plain_text(self): content = "G3H9E-id1\nG3H9E-id2\nG3H9E-id3" result = _parse_plain_text_pointers(content) assert result == ["G3H9E-id1", "G3H9E-id2", "G3H9E-id3"] def test_plain_text_with_empty_lines(self): content = "G3H9E-id1\n\nG3H9E-id2\n \nG3H9E-id3" result = _parse_plain_text_pointers(content) assert result == ["G3H9E-id1", "G3H9E-id2", "G3H9E-id3"] def test_empty_plain_text(self): content = "" result = _parse_plain_text_pointers(content) assert result == [] class TestBuildAndWriteResult: @patch("delete_pointers_by_id._write_result_file") @patch("delete_pointers_by_id._print_summary") def test_build_and_write_result_success(self, mock_print, mock_write): start_time = datetime.now(tz=timezone.utc) end_time = datetime.now(tz=timezone.utc) ctx = PointerDeletionContext( pointers_to_delete=["G3H9E-1", "G3H9E-2"], ods_code="G3H9E", matched_pointers=["G3H9E-1", "G3H9E-2"], mismatched_pointers=[], not_found_pointers=[], pointers_deleted=["G3H9E-1", "G3H9E-2"], failed_deletes=[], start_time=start_time, end_time=end_time, output_filename="delete_results_G3H9E_20231125T120000Z.json", ) result = _build_and_write_result(ctx) assert result["pointers_to_delete"] == 2 assert result["deleted_pointers"]["count"] == 2 assert result["ods_code"] == "G3H9E" assert result["output_filename"] == "delete_results_G3H9E_20231125T120000Z.json" assert "_output_error" not in result mock_write.assert_called_once() mock_print.assert_called_once() @patch("delete_pointers_by_id._write_result_file") @patch("delete_pointers_by_id._print_summary") def test_build_and_write_result_with_error(self, mock_print, mock_write): mock_write.side_effect = Exception("Write failed") start_time = datetime.now(tz=timezone.utc) end_time = datetime.now(tz=timezone.utc) ctx = PointerDeletionContext( pointers_to_delete=["G3H9E-1"], ods_code="G3H9E", matched_pointers=["G3H9E-1"], mismatched_pointers=[], not_found_pointers=[], pointers_deleted=["G3H9E-1"], failed_deletes=[], start_time=start_time, end_time=end_time, output_filename="delete_results_G3H9E_20231125T120000Z.json", ) result = _build_and_write_result(ctx) assert "_output_error" in result assert "Write failed" in result["_output_error"] mock_write.assert_called_once() mock_print.assert_called_once() class TestCheckPointersMatchOdsCode: def test_all_match(self): ods = "G3H9E" ids = ["G3H9E-a", "G3H9E-b"] matched, mismatched = _check_pointers_match_ods_code(ods, ids) assert matched == ids and mismatched == [] def test_none_match(self): ods = "G3H9E" ids = ["X-a", "Y-b"] matched, mismatched = _check_pointers_match_ods_code(ods, ids) assert matched == [] and mismatched == ids def test_mixed(self): ods = "G3H9E" ids = ["G3H9E-a", "X-b", "G3H9E-c"] matched, mismatched = _check_pointers_match_ods_code(ods, ids) assert matched == ["G3H9E-a", "G3H9E-c"] assert mismatched == ["X-b"] class TestBatchGetExistingPointers: @patch("delete_pointers_by_id.dynamodb") def test_all_exist(self, mock_dynamodb): table = "t" ids = ["G3H9E-1", "G3H9E-2"] mock_dynamodb.batch_get_item.return_value = { "Responses": { table: [{"pk": {"S": "D#G3H9E-1"}}, {"pk": {"S": "D#G3H9E-2"}}] } } existing, not_found = _batch_get_existing_pointers(table, ids) assert existing == ids and not_found == [] @patch("delete_pointers_by_id.dynamodb") def test_none_exist(self, mock_dynamodb): table = "t" ids = ["G3H9E-1", "G3H9E-2"] mock_dynamodb.batch_get_item.return_value = {"Responses": {table: []}} existing, not_found = _batch_get_existing_pointers(table, ids) assert existing == [] and not_found == ids class TestBatchDeletePointers: @patch("delete_pointers_by_id.dynamodb") def test_all_deleted(self, mock_dynamodb): table = "t" ids = ["G3H9E-1", "G3H9E-2"] mock_dynamodb.batch_write_item.return_value = {"UnprocessedItems": {}} deleted, failed = _batch_delete_pointers(table, ids) assert deleted == ids and failed == [] @patch("delete_pointers_by_id.dynamodb") def test_some_unprocessed(self, mock_dynamodb): table = "t" ids = ["G3H9E-1", "G3H9E-2", "G3H9E-3"] mock_dynamodb.batch_write_item.return_value = { "UnprocessedItems": { table: [ { "DeleteRequest": { "Key": {"pk": {"S": "D#G3H9E-3"}, "sk": {"S": "D#G3H9E-3"}} } } ] } } deleted, failed = _batch_delete_pointers(table, ids) assert deleted == ["G3H9E-1", "G3H9E-2"] assert failed == ["G3H9E-3"] class TestDeletePointersById: def test_missing_params(self): with pytest.raises( ValueError, match="Provide either pointers_to_delete or pointers_file" ): _delete_pointers_by_id("t", "G3H9E") def test_both_params_provided(self): with pytest.raises( ValueError, match="Provide either pointers_to_delete or pointers_file, not both", ): _delete_pointers_by_id( "t", "G3H9E", pointers_to_delete=["a"], pointers_file="./f" ) @patch("delete_pointers_by_id._build_and_write_result") @patch("delete_pointers_by_id._check_pointers_match_ods_code") @patch("delete_pointers_by_id._batch_get_existing_pointers") @patch("delete_pointers_by_id._batch_delete_pointers") def test_empty_pointers_list(self, mock_delete, mock_get, mock_check, mock_build): _delete_pointers_by_id("t", "G3H9E", pointers_to_delete=[]) mock_build.assert_called_once() mock_check.assert_not_called() mock_get.assert_not_called() mock_delete.assert_not_called() call_args = mock_build.call_args[0][0] assert call_args.pointers_to_delete == [] assert call_args.matched_pointers == [] @patch("delete_pointers_by_id._build_and_write_result") @patch("delete_pointers_by_id._check_pointers_match_ods_code") @patch("delete_pointers_by_id._batch_get_existing_pointers") @patch("delete_pointers_by_id._batch_delete_pointers") def test_no_matched_ods_codes(self, mock_delete, mock_get, mock_check, mock_build): mock_check.return_value = ([], ["RAT-1", "RAT-2"]) _delete_pointers_by_id("t", "G3H9E", pointers_to_delete=["RAT-1", "RAT-2"]) mock_build.assert_called_once() mock_check.assert_called_once() mock_get.assert_not_called() mock_delete.assert_not_called() call_args = mock_build.call_args[0][0] assert call_args.matched_pointers == [] assert call_args.mismatched_pointers == ["RAT-1", "RAT-2"] @patch("delete_pointers_by_id._build_and_write_result") @patch("delete_pointers_by_id._check_pointers_match_ods_code") @patch("delete_pointers_by_id._batch_get_existing_pointers") @patch("delete_pointers_by_id._batch_delete_pointers") def test_successful_flow(self, mock_delete, mock_get, mock_check, mock_build): ids = ["G3H9E-1", "G3H9E-2"] mock_check.return_value = (ids, []) mock_get.return_value = (ids, []) mock_delete.return_value = (ids, []) _delete_pointers_by_id("t", "G3H9E", pointers_to_delete=ids) mock_build.assert_called_once() mock_check.assert_called_once() mock_get.assert_called_once() mock_delete.assert_called_once() call_args = mock_build.call_args[0][0] assert call_args.pointers_deleted == ids assert call_args.failed_deletes == [] @patch("delete_pointers_by_id._build_and_write_result") @patch("delete_pointers_by_id._check_pointers_match_ods_code") @patch("delete_pointers_by_id._batch_get_existing_pointers") @patch("delete_pointers_by_id._batch_delete_pointers") def test_partial_with_failures(self, mock_delete, mock_get, mock_check, mock_build): matched = ["G3H9E-1", "G3H9E-2", "G3H9E-3"] mock_check.return_value = (matched, ["RAT-1"]) mock_get.return_value = (matched, []) mock_delete.return_value = (["G3H9E-1", "G3H9E-2"], ["G3H9E-3"]) _delete_pointers_by_id("t", "G3H9E", pointers_to_delete=matched + ["RAT-1"]) mock_build.assert_called_once() call_args = mock_build.call_args[0][0] assert call_args.mismatched_pointers == ["RAT-1"] assert call_args.pointers_deleted == ["G3H9E-1", "G3H9E-2"] assert call_args.failed_deletes == ["G3H9E-3"] @patch("delete_pointers_by_id._build_and_write_result") @patch("delete_pointers_by_id._check_pointers_match_ods_code") @patch("delete_pointers_by_id._batch_get_existing_pointers") @patch("delete_pointers_by_id._batch_delete_pointers") def test_some_pointers_not_found( self, mock_delete, mock_get, mock_check, mock_build ): matched = ["G3H9E-1", "G3H9E-2", "G3H9E-3"] mock_check.return_value = (matched, []) mock_get.return_value = (["G3H9E-1", "G3H9E-2"], ["G3H9E-3"]) mock_delete.return_value = (["G3H9E-1", "G3H9E-2"], []) _delete_pointers_by_id("t", "G3H9E", pointers_to_delete=matched) mock_build.assert_called_once() call_args = mock_build.call_args[0][0] assert call_args.not_found_pointers == ["G3H9E-3"] assert call_args.pointers_deleted == ["G3H9E-1", "G3H9E-2"] @patch("delete_pointers_by_id._build_and_write_result") @patch("delete_pointers_by_id._check_pointers_match_ods_code") @patch("delete_pointers_by_id._batch_get_existing_pointers") @patch("delete_pointers_by_id._batch_delete_pointers") def test_no_existing_pointers(self, mock_delete, mock_get, mock_check, mock_build): matched = ["G3H9E-1", "G3H9E-2"] mock_check.return_value = (matched, []) mock_get.return_value = ([], matched) _delete_pointers_by_id("t", "G3H9E", pointers_to_delete=matched) mock_build.assert_called_once() mock_delete.assert_not_called() # Verify the context call_args = mock_build.call_args[0][0] assert call_args.not_found_pointers == matched assert call_args.pointers_deleted == [] NRLF-3.0.31/scripts/truststore.sh000077500000000000000000000341531511201605300166230ustar00rootroot00000000000000#!/bin/bash # Script to manage the NRLF truststore files # # Note that all creative and destructive operations are local only apart from # "push-all". Files are not uploaded to or deleted from S3 automatically. # # Once changes have been made locally and have been tested thoroughly, the files # in the truststore directories can be uploaded to S3 using the appropriate AWS # CLI commands or the "push-all" command below. # set -o errexit -o pipefail -o nounset BUCKET="nhsd-nrlf--truststore" function _truststore_help() { echo echo "$0 [options]" echo echo "commands:" echo " help - this help screen" echo " build-ca - Build a single CA cert" echo " build-cert - Build a single client cert + private key" echo " build-all - Build the standard trust store certs" echo " pull-ca - Pull the certificate authority" echo " pull-ca-key - Pull the certificate authority private key" echo " pull-client - pull the files needed for a client connection" echo " pull-server - pull the files needed for a server connection" echo " pull-all-for-account - pull all the truststore files for all environments in a given account" echo " pull-all - pull all the truststore files for an environment" echo " push-all - push all the truststore files for an environment" echo " rotate-ca - rotate the certificate authority, archiving the previous one" echo " rotate-cert - rotate the client certificate, archiving the previous one" echo " disable-archived-ca - disable an archived certificate authority" echo " restore-archived-ca - restore an archived certificate authority" echo " restore-archived-cert - restore an archived client certificate" echo } # read an input file and substitute all the ${} entries function substitute_env_in_file() { infile=$1 outfile=$2 output=$(eval "cat < ${outfile} < " return 1 fi env=$1 fqdn=$2 substitute_env_in_file ./truststore/config/ca.conf /tmp/ca.conf echo -e "🚧 Building CA: $env \t(FQDN: $fqdn)" openssl req -newkey rsa:4096 \ -nodes \ -keyout ./truststore/ca/$env.key \ -new \ -x509 \ -days 36500 \ -out ./truststore/ca/$env.crt \ -config /tmp/ca.conf \ -extensions v3_req \ -extensions v3_ca &> /dev/null rm /tmp/ca.conf echo -e "✅ Successfully Built CA: $env (FQDN: $fqdn)" cat ./truststore/ca/$env.crt > ./truststore/server/$env.pem echo -e "✅ Successfully Built Server Truststore: $env" return 0 } # build a certificate function _truststore_build_cert() { if [[ $# -ne 3 ]]; then echo "Usage: $0 build-cert " return 1; fi cert_name=$1 ca_name=$2 fqdn=$3 serial=$(date +%s%3N) substitute_env_in_file ./truststore/config/client.conf /tmp/client.conf echo -e "🚧 Generating $cert_name keypair" openssl req \ -newkey rsa:4096 \ -nodes \ -keyout truststore/client/$cert_name.key \ -new \ -out truststore/client/$cert_name.csr \ -config /tmp/client.conf \ -extensions v3_req \ -extensions usr_cert &> /dev/null echo -e "🚧 Signing $cert_name certificate with ca=$ca_name (serial: $serial)" openssl x509 \ -req \ -in truststore/client/$cert_name.csr \ -CA truststore/ca/$ca_name.crt \ -CAkey truststore/ca/$ca_name.key \ -set_serial $serial \ -out truststore/client/$cert_name.crt \ -days 36500 \ -sha256 \ -extfile /tmp/client.conf \ -extensions v3_req \ -extensions usr_cert &> /dev/null echo -e "✅ Successfully generated $cert_name keypair for ca=$ca_name (FQDN: $fqdn)" rm /tmp/client.conf rm truststore/client/$cert_name.csr return 0 } # Rotate a CA - archive the existing CA and build a new one # The previous CA is added to the new CA bundle (can be removed after clients have updated) function _truststore_rotate_ca() { if [[ $# -ne 2 ]]; then echo "Usage: $0 rotate-ca " return 1; fi env="$1" fqdn="$2" if [[ ! -f "truststore/ca/$env.crt" ]] || [[ ! -f "truststore/ca/$env.key" ]] || [[ ! -f "truststore/server/$env.pem" ]]; then echo "Error: One or more ca cert truststore files not found for environment $env - cannot rotate CA" 1>&2 echo "Try running this first:" 1>&2 echo " $0 pull-all $env && $0 pull-ca-key dev" 1>&2 return 1 fi # Archive the existing ca certs archive_date="$(date +%Y-%m-%d)" if [[ -f "truststore/ca/$env.archived_$archive_date.crt" ]] || [[ -f "truststore/ca/$env.archived_$archive_date.key" ]] || [[ -f "truststore/server/$env.archived_$archive_date.pem" ]]; then echo "Error: Archive files already exist for date $archive_date - please resolve before rotating the CA" 1>&2 return 1 fi mv "truststore/ca/$env.crt" "truststore/ca/$env.archived_$archive_date.crt" mv "truststore/ca/$env.key" "truststore/ca/$env.archived_$archive_date.key" mv "truststore/server/$env.pem" "truststore/server/$env.archived_$archive_date.pem" # Build a new CA _truststore_build_ca "$env" "$fqdn" # Add the previous CA to the new CA bundle (can be removed after clients have updated) cat "truststore/ca/$env.archived_$archive_date.crt" >> "truststore/server/$env.pem" echo -e "✅ Successfully rotated CA for $env - previous CA archived with date: $archive_date" return 0 } # Rotate a client cert - archive the existing cert and build a new one function _truststore_rotate_cert() { if [[ $# -ne 3 ]]; then echo "Usage: $0 rotate-cert " exit 1; fi cert_name="$1" ca_name="$2" fqdn="$3" if [[ ! -f "truststore/client/$cert_name.crt" ]] || [[ ! -f "truststore/client/$cert_name.key" ]]; then echo "Error: One or more client cert truststore files not found for $cert_name - cannot rotate client cert" 1>&2 echo "Try running this first:" 1>&2 echo " $0 pull-all $cert_name" 1>&2 return 1 fi # Archive the existing client certs archive_date=$(date +%Y-%m-%d) if [[ -f "truststore/client/$cert_name.archived_$archive_date.crt" ]] || [[ -f "truststore/client/$cert_name.archived_$archive_date.key" ]]; then echo "Error: Archive files already exist for date $archive_date - please resolve before rotating the client cert" 1>&2 return 1 fi mv "truststore/client/$cert_name.crt" "truststore/client/$cert_name.archived_$archive_date.crt" mv "truststore/client/$cert_name.key" "truststore/client/$cert_name.archived_$archive_date.key" # Build a new client cert _truststore_build_cert "$cert_name" "$ca_name" "$fqdn" echo -e "✅ Successfully rotated client cert for $cert_name - previous cert archived with date: $archive_date" return 0 } # Disable an archived CA by removing it from the server pem file function _disable_archived_ca() { env="$1" cat "truststore/ca/$env.crt" > "truststore/server/$env.pem" echo -e "✅ Successfully disabled archived CA for $env" return 0 } # Restore an archived CA by moving the archived files back to their original names function _restore_archived_ca() { env="$1" archive_date="$2" mv "truststore/ca/$env.archived_$archive_date.crt" "truststore/ca/$env.crt" mv "truststore/ca/$env.archived_$archive_date.key" "truststore/ca/$env.key" mv "truststore/server/$env.archived_$archive_date.pem" "truststore/server/$env.pem" echo -e "✅ Successfully restored archived CA for $env from date: $archive_date" return 0 } # Restore an archived client cert by moving the archived files back to their original names function _restore_archived_cert() { env="$1" archive_date="$2" mv "truststore/client/$env.archived_$archive_date.crt" "truststore/client/$env.crt" mv "truststore/client/$env.archived_$archive_date.key" "truststore/client/$env.key" echo -e "✅ Successfully restored archived client cert for $env from date: $archive_date" return 0 } function _truststore_build_all() { _truststore_build_ca "prod" "record-locator.national.nhs.uk_CA2" _truststore_build_ca "int" "record-locator.int.national.nhs.uk_CA2" _truststore_build_ca "ref" "record-locator.ref.national.nhs.uk_CA2" _truststore_build_ca "perftest" "perftest.record-locator.national.nhs.uk_CA2" _truststore_build_ca "qa" "qa.record-locator.national.nhs.uk_CA2" _truststore_build_ca "dev" "record-locator.dev.national.nhs.uk_CA2" _truststore_build_cert "prod" "prod" "api.record-locator.national.nhs.uk" _truststore_build_cert "int" "int" "int.api.record-locator.int.national.nhs.uk" _truststore_build_cert "ref" "ref" "ref.api.record-locator.ref.national.nhs.uk" _truststore_build_cert "perftest" "perftest" "api.perftest.record-locator.national.nhs.uk" _truststore_build_cert "qa" "qa" "api.qa.record-locator.national.nhs.uk" _truststore_build_cert "dev" "dev" "dev.api.record-locator.dev.national.nhs.uk" echo -e "✅ Successfully built all truststore files" return 0 } function _truststore_pull_ca() { env=$1 echo "Pulling ${env} ca certificate" aws s3 cp "s3://${BUCKET}/ca/${env}.crt" "truststore/ca/${env}.crt" echo -e "✅ Successfully pulled ${env} ca certificate from s3://${BUCKET}" return 0 } function _truststore_pull_ca_key() { env=$1 echo "Pulling ${env} ca private key" aws s3 cp "s3://${BUCKET}/ca/${env}.key" "truststore/ca/${env}.key" echo -e "✅ Successfully pulled ${env} ca private key from s3://${BUCKET}" return 0 } function _truststore_pull_client() { env=$1 echo "Pulling ${env} client certificate" aws s3 cp "s3://${BUCKET}/client/${env}.key" "truststore/client/${env}.key" aws s3 cp "s3://${BUCKET}/client/${env}.crt" "truststore/client/${env}.crt" echo -e "✅ Successfully pulled ${env} client truststore files from s3://${BUCKET}" return 0 } function _truststore_pull_server() { env=$1 echo "Pulling ${env} server trust certificate" aws s3 cp "s3://${BUCKET}/server/${env}.pem" "truststore/server/${env}.pem" echo -e "✅ Successfully pulled ${env} server truststore files from s3://${BUCKET}" return 0 } function _truststore_pull_all() { env=$1 _truststore_pull_ca $env _truststore_pull_client $env _truststore_pull_server $env echo -e "✅ Successfully pulled all ${env} truststore files from s3://${BUCKET}" return 0 } function _truststore_pull_all_for_account() { account=$1 # sets envs_array source ./scripts/get-envs-for-account.sh $account for env in ${envs_array[@]}; do # don't need to pull sandbox certs if [[ $env != *"-sandbox" ]]; then echo "⏳ Pulling ${env} truststore certs" _truststore_pull_ca $env _truststore_pull_client $env _truststore_pull_server $env fi done echo -e "✅ Successfully pulled all ${account} truststore files from s3://${BUCKET}" return 0 } function _truststore_push_all() { env=$1 timestamp="$(date +%Y-%m-%d_%H%M%S)" backup_dir="truststore/backup/${env}_${timestamp}" echo -e "Backing up existing files to ${backup_dir}...." mkdir -p "${backup_dir}/ca" "${backup_dir}/client" "${backup_dir}/server" for f in "ca/${env}.crt" "ca/${env}.key" "client/${env}.crt" "client/${env}.key" "server/${env}.pem" do echo aws s3 cp "s3://${BUCKET}/$f" "${backup_dir}/$f" || echo "No existing file s3://${BUCKET}/$f to back up" if [[ -f "${backup_dir}/$f" ]] then diff --brief "truststore/$f" "${backup_dir}/$f" || true fi done echo echo -n "WARNING: You are about to upload files to the ${env} truststore - are you sure? [yes/NO] " read answer if [[ "$answer" != "yes" ]]; then echo "Aborting upload to ${env} truststore" 1>&2 return 1 fi echo "Uploading ${env} ca certificate" aws s3 cp "truststore/ca/${env}.crt" "s3://${BUCKET}/ca/${env}.crt" echo "Uploading ${env} ca private key" aws s3 cp "truststore/ca/${env}.key" "s3://${BUCKET}/ca/${env}.key" echo "Uploading ${env} client certificate" aws s3 cp "truststore/client/${env}.key" "s3://${BUCKET}/client/${env}.key" aws s3 cp "truststore/client/${env}.crt" "s3://${BUCKET}/client/${env}.crt" echo "Uploading ${env} server trust certificate" aws s3 cp "truststore/server/${env}.pem" "s3://${BUCKET}/server/${env}.pem" echo -e "✅ Successfully uploaded all ${env} truststore files to s3://${BUCKET}" return 0 } function _truststore() { local command=$1; shift local args=$@ case $command in "build-all") _truststore_build_all $args ;; "build-ca") _truststore_build_ca $args ;; "build-cert") _truststore_build_cert $args ;; "pull-all") _truststore_pull_all $args ;; "pull-all-for-account") _truststore_pull_all_for_account $args ;; "pull-server") _truststore_pull_server $args ;; "pull-client") _truststore_pull_client $args ;; "pull-ca") _truststore_pull_ca $args ;; "pull-ca-key") _truststore_pull_ca_key $args ;; "push-all") _truststore_push_all $args ;; "rotate-ca") _truststore_rotate_ca $args ;; "rotate-cert") _truststore_rotate_cert $args ;; "disable-archived-ca") _disable_archived_ca $args ;; "restore-archived-ca") _restore_archived_ca $args ;; "restore-archived-cert") _restore_archived_cert $args ;; *) _truststore_help $args ;; esac } _truststore $@ NRLF-3.0.31/sonar-project.properties000066400000000000000000000016711511201605300172420ustar00rootroot00000000000000sonar.projectKey=NHSDigital_NRLF sonar.organization=nhsdigital sonar.projectName=NRLF sonar.python.version=3.9.5 sonar.terraform.provider.aws.version=4.63.0 # TODO: Some paths here are outdated and perhaps we don't want to exclude everything sonar.cpd.exclusions=api/tests/**, tests/**, api/**/tests/**, feature_tests/**, cron/seed_sandbox/tests/**, data_contracts/**/tests/**, firehose/**/tests/**, firehose/**/scripts/**, helpers/tests/**, mi/**/tests/** sonar.exclusions=scripts/**, **/scripts/**, api/tests/**, tests/**, api/**/tests/**, feature_tests/**, cron/seed_sandbox/tests/**, data_contracts/**/tests/**, firehose/**/tests/**, firehose/**/scripts/**, helpers/tests/**, mi/**/tests/** # Exclude snomed urls as being unsafe sonar.issue.ignore.multicriteria=exclude_snomed_urls sonar.issue.ignore.multicriteria.exclude_snomed_urls.ruleKey=python:S5332 sonar.issue.ignore.multicriteria.exclude_snomed_urls.pattern=**http://snomed\.info(/sct)?** NRLF-3.0.31/terraform/000077500000000000000000000000001511201605300143325ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/000077500000000000000000000000001511201605300217725ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/README.md000066400000000000000000000133541511201605300232570ustar00rootroot00000000000000# NRLF Account Wide Infrastructure This directory contains terraform for resources which are global to a given account instead of a workspace. Resources can include but not limited to: User assume IAM roles, Route 53 DNS setup and API gateway cloudwatch roles etc. Each subdirectory corresponds to each AWS account (`mgmt`, `prod`, `test` and `dev`). **Account wide resources should be deployed manually and not be run as part of CI.** ## Table of Contents 1. [Prerequisites](#prerequisites) 2. [Initialise shell environment](#initialise-shell-environment) 3. [Deploy account wide resources](#deploy-account-wide-resources) 4. [Tear down account wide resources](#tear-down-account-wide-resources) ## Prerequisites Before deploying the NRLF account-wide infrastructure, you will need: - AWS accounts that have already been bootstrapped, as described in [bootstrap/README.md](../bootstrap/README.md). This is a one-time account setup step. - The required packages to build NRLF, see [the Setup section in README.md](../../README.md#before-you-begin). ## Deploy mgmt resources To deploy resources into the mgmt account, first login to the AWS mgmt account on the CLI. Then, initialise your terraform workspace with: ```shell cd mgmt terraform init && terraform workspace select mgmt ``` Once you have your workspace, you can plan your change with: ```shell terraform plan ``` Once you're happy with your planned changes, you can apply them with: ```shell terraform apply ``` ### If you get "Error: creating CodeBuild Webhook" If you see this error: ``` │ Error: creating CodeBuild Webhook (nhsd-nrlf-ci-build-project): operation error CodeBuild: CreateWebhook, https response error StatusCode: 400, RequestID: , ResourceNotFoundException: Access token not found in CodeBuild project for server type github │ │ with aws_codebuild_webhook.github_workflow, │ on codebuild.tf line 113, in resource "aws_codebuild_webhook" "github_workflow": │ 113: resource "aws_codebuild_webhook" "github_workflow" { ``` You will need to add the Github PAT credential for codebuild to connect to Github. To fix this: 1. Go to the AWS console and find the Codebuild service 2. Select the created nhsd-nrlf-ci-build-project project 3. Press the "Edit" button (in the top-bar) 4. Where it says "You have not connected to Github", press the "Manage account credentials" link 5. At the "Manage default source credential" page, choose "Personal Access Token" type, "Secrets Manager" service, and "Existing Secret" secret. 6. In the "Connection" drop-down, choose the "nhsd-nrlf--codebuild-github-pat" secret 7. Press the "Save" button If that has worked, you should see: "Your account is successfully connected through Secrets Manager secret" ### Build and publish the container image for CI build Once all the mgmt infra has been deployed, you need to build and publish the CI image to the ECR repo. To do this, first build the image as follows: ``` make build-ci-image ``` and then login to ECR: ``` make ecr-login ``` and push the image: ``` make publish-ci-image ``` ## Deploy account wide resources To deploy the account wide resources, first login to the AWS mgmt account on the CLI. Then, initialise your terraform workspace with: ```shell $ cd ACCOUNT_NAME $ terraform init && ( \ terraform workspace new ACCOUNT_NAME || \ terraform workspace select ACCOUNT_NAME ) ``` Replacing ACCOUNT_NAME with the name of your account, e.g `dev`, `test` etc. Once you have your workspace, you can plan your changes with: ```shell $ terraform plan \ -var 'assume_account=AWS_ACCOUNT_ID' \ -var 'assume_role=terraform' ``` Replacing AWS_ACCOUNT_ID with the AWS account number of your account. Once you're happy with your planned changes, you can apply them with: ```shell $ terraform apply \ -var 'assume_account=AWS_ACCOUNT_ID' \ -var 'assume_role=terraform' ``` Replacing AWS_ACCOUNT_ID with the AWS account number of your account. ### Reporting Resources To enable reporting resources for the account, do the following: 1. Set the `enable_reporting` variable to `true` in `./ACCOUNT_NAME/vars.tf` 2. Deploy the account-wide infrastructure to the account To disable reporting resources for the account, do the following: 1. Set the `enable_reporting` variable to `true` in `./ACCOUNT_NAME/vars.tf` 2. Deploy the account-wide infrastructure to the account #### Deploy the PowerBI Gateway The first time you deploy the PowerBI Gateway to an AWS account you need to create, install and configure a gateway image. Instruction on how to do this can be found in [KOP-NRLF-012](https://nhsd-confluence.digital.nhs.uk/x/8BXXQg). To enable the PowerBI Gateway in the account: 1. Set the `enable_powerbi_auto_push` variable to `true` in `./ACCOUNT_NAME/vars.tf` 2. Deploy the account-wide infrastructure to the account 3. Access the EC2 Serial Console for the instance and run this command to start the PowerBI Gateway: ``` Start-Service -Name "PBIEgwService" ``` To disable the PowerBI Gateway from the account: 1. Set the `enable_powerbi_auto_push` variable to `false` in `./ACCOUNT_NAME/vars.tf` 2. Deploy the account-wide infrastructure to the account ## Tear down account wide resources WARNING - This action will destroy all account-wide resources from the AWS account. This should only be done if you are sure that this is safe and are sure that you are signed into the correct AWS account. To tear down account-wide resources, first login to the AWS mgmt account on the CLI. Then, initialise your terraform workspace with: ```shell $ cd ACCOUNT_NAME $ terraform init && ( \ terraform workspace new ACCOUNT_NAME || \ terraform workspace select ACCOUNT_NAME ) ``` And then, to tear down: ```shell $ terraform destroy \ -var 'assume_account=AWS_ACCOUNT_ID' \ -var 'assume_role=terraform' ``` NRLF-3.0.31/terraform/account-wide-infrastructure/dev/000077500000000000000000000000001511201605300225505ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/dev/.terraform-version000066400000000000000000000000061511201605300262310ustar00rootroot000000000000001.9.8 NRLF-3.0.31/terraform/account-wide-infrastructure/dev/athena.tf000066400000000000000000000005041511201605300243420ustar00rootroot00000000000000module "dev-athena" { count = var.enable_reporting ? 1 : 0 source = "../modules/athena" name_prefix = "nhsd-nrlf--dev" target_bucket_name = module.dev-glue.target_bucket_name bucket_region = data.aws_region.current.region glue_database = module.dev-glue.glue_database } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/aws-backup.tf000066400000000000000000000120751511201605300251450ustar00rootroot00000000000000 resource "aws_s3_bucket" "backup_reports" { bucket_prefix = "${local.prefix}-backup-reports" } resource "aws_s3_bucket_public_access_block" "backup_reports" { bucket = aws_s3_bucket.backup_reports.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "backup_reports" { bucket = aws_s3_bucket.backup_reports.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "AES256" } } } resource "aws_s3_bucket_policy" "backup_reports_bucket_policy" { bucket = aws_s3_bucket.backup_reports.id policy = jsonencode({ Version = "2012-10-17" Id = "backup_reports_bucket_policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = "*" Action = "s3:*" Resource = [ aws_s3_bucket.backup_reports.arn, "${aws_s3_bucket.backup_reports.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, { Sid = "AllowBackupReportsWrite" Effect = "Allow" Principal = { AWS = "arn:aws:iam::${local.account_id}:role/aws-service-role/reports.backup.amazonaws.com/AWSServiceRoleForBackupReports" } Action = "s3:PutObject" Resource = [ "${aws_s3_bucket.backup_reports.arn}/*", ] Condition = { StringEquals = { "s3:x-amz-acl" = "bucket-owner-full-control" } } } ] }) } resource "aws_s3_bucket_ownership_controls" "backup_reports" { bucket = aws_s3_bucket.backup_reports.id rule { object_ownership = "BucketOwnerPreferred" } } resource "aws_s3_bucket_acl" "backup_reports" { depends_on = [aws_s3_bucket_ownership_controls.backup_reports] bucket = aws_s3_bucket.backup_reports.id acl = "private" } resource "aws_kms_key" "backup_notifications" { description = "KMS key for AWS Backup notifications" deletion_window_in_days = 7 enable_key_rotation = true policy = jsonencode({ Version = "2012-10-17" Statement = [ { Effect = "Allow" Sid = "Enable IAM User Permissions" Principal = { AWS = "arn:aws:iam::${var.assume_account}:root" } Action = "kms:*" Resource = "*" }, { Effect = "Allow" Principal = { Service = "sns.amazonaws.com" } Action = ["kms:GenerateDataKey*", "kms:Decrypt"] Resource = "*" }, { Effect = "Allow" Principal = { Service = "backup.amazonaws.com" } Action = ["kms:GenerateDataKey*", "kms:Decrypt"] Resource = "*" }, ] }) } module "source" { source = "../modules/backup-source" backup_copy_vault_account_id = jsondecode(data.aws_secretsmanager_secret_version.backup_destination_parameters.secret_string)["account-id"] backup_copy_vault_arn = jsondecode(data.aws_secretsmanager_secret_version.backup_destination_parameters.secret_string)["vault-arn"] environment_name = local.environment bootstrap_kms_key_arn = aws_kms_key.backup_notifications.arn project_name = "${local.prefix}-" reports_bucket = aws_s3_bucket.backup_reports.bucket terraform_role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" notification_target_email_addresses = local.notification_emails backup_plan_config = { "compliance_resource_types" : [ "S3" ], "enable" : true, "rules" : [ { "copy_action" : [{ "delete_after" : 4, }], "lifecycle" : { "delete_after" : 2 }, "name" : "daily_kept_for_2_days", "schedule" : "cron(0 0 * * ? *)" } ], "selection_tag" : "NHSE-Enable-S3-Backup" } backup_plan_config_dynamodb = { "compliance_resource_types" : [ "DynamoDB" ], "enable" : true, "rules" : [ { "name" : "daily", "schedule" : "cron(0 0 * * ? *)", "copy_action" : [{ "delete_after" : 4, }], "lifecycle" : { "delete_after" : 2 } }, { "name" : "monthly" "schedule" : "cron(30 0 ? * 5#1 *)" # first Thursday each month from 00:30 "copy_action" : [{ "cold_storage_after" : 3, "delete_after" : 100 # ensures there will always be min 3 }], "lifecycle" : { "delete_after" : 2 } }, { "name" : "weekly" # overlaps with monthly "schedule" : "cron(30 0 ? * 5 *)" # every Thursday from 00:30 to precede releases "copy_action" : [{ "cold_storage_after" : 14 # ensures 2 warm including one from previous release "delete_after" : 105 }], "lifecycle" : { "delete_after" : 2 } } ], "selection_tag" : "NHSE-Enable-DDB-Backup" } } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/cloudwatch.tf000066400000000000000000000004201511201605300252340ustar00rootroot00000000000000module "lambda_errors_cloudwatch_metric_alarm_dev" { source = "../modules/lambda-errors-metric-alarm" name_prefix = "nhsd-nrlf--dev" notification_emails = local.notification_emails evaluation_periods = 1 period = 60 threshold = 1 } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/data.tf000066400000000000000000000012271511201605300240160ustar00rootroot00000000000000data "aws_region" "current" {} data "aws_caller_identity" "current" {} data "aws_secretsmanager_secret_version" "identities_account_id" { secret_id = aws_secretsmanager_secret.identities_account_id.name } data "aws_secretsmanager_secret_version" "backup_destination_parameters" { secret_id = aws_secretsmanager_secret.backup_destination_parameters.name } data "aws_secretsmanager_secret" "emails" { name = "${local.prefix}-emails" } data "aws_secretsmanager_secret_version" "emails" { secret_id = data.aws_secretsmanager_secret.emails.id } data "external" "current-info" { program = [ "bash", "../../../scripts/get-current-info.sh", ] } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/domain.tf000066400000000000000000000020361511201605300243530ustar00rootroot00000000000000 module "dev-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.dev_api_domain_name domain_zone = aws_route53_zone.dev-ns.name mtls_certificate_file = "s3://${module.dev-truststore-bucket.bucket_name}/${module.dev-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.dev-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.dev-ns] } module "devsandbox-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.devsandbox_api_domain_name domain_zone = aws_route53_zone.dev-ns.name mtls_certificate_file = "s3://${module.dev-truststore-bucket.bucket_name}/${module.dev-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.dev-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.dev-ns] } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/dynamodb__pointers-table.tf000066400000000000000000000004121511201605300300440ustar00rootroot00000000000000module "dev-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--dev" enable_backups = false } module "dev-sandbox-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--dev-sandbox" } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/ec2.tf000066400000000000000000000022371511201605300235600ustar00rootroot00000000000000module "vpc" { count = var.enable_reporting && var.enable_powerbi_auto_push ? 1 : 0 source = "../modules/vpc" vpc_cidr_block = var.vpc_cidr_block enable_dns_hostnames = var.enable_dns_hostnames vpc_public_subnets_cidr_block = var.vpc_public_subnets_cidr_block vpc_private_subnets_cidr_block = var.vpc_private_subnets_cidr_block aws_azs = var.aws_azs name_prefix = "nhsd-nrlf--dev" } module "powerbi_gw_instance" { count = var.enable_reporting && var.enable_powerbi_auto_push ? 1 : 0 source = "../modules/powerbi-gw-ec2" use_custom_ami = var.use_powerbi_gw_custom_ami instance_type = var.powerbi_gw_instance_type name_prefix = "nhsd-nrlf--dev-powerbi-gw" target_bucket_arn = module.dev-glue.target_bucket_arn glue_kms_key_arn = module.dev-glue.aws_kms_key_arn athena_kms_key_arn = module.dev-athena[0].kms_key_arn athena_bucket_arn = module.dev-athena[0].bucket_arn subnet_id = module.vpc[0].private_subnet_id security_groups = [module.vpc[0].powerbi_gw_security_group_id] } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/etc/000077500000000000000000000000001511201605300233235ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/dev/etc/dev.tfvars000066400000000000000000000000001511201605300253160ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/dev/glue.tf000066400000000000000000000002651511201605300240420ustar00rootroot00000000000000module "dev-glue" { is_enabled = var.enable_reporting source = "../modules/glue" name_prefix = "nhsd-nrlf--dev" schedule = false python_version = 3 } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/iam__api-gateway-to-cloudwatch.tf000066400000000000000000000015141511201605300310540ustar00rootroot00000000000000resource "aws_iam_role" "api_gateway_to_cloudwatch" { name = "${local.prefix}--api-gateway-cloudwatch-logs" assume_role_policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = "sts:AssumeRole" Effect = "Allow" Principal = { "Service" : "apigateway.amazonaws.com" } } ] }) } resource "aws_iam_role_policy_attachment" "api_gateway_to_cloudwatch" { role = aws_iam_role.api_gateway_to_cloudwatch.name policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs" depends_on = [ aws_iam_role.api_gateway_to_cloudwatch ] } resource "aws_api_gateway_account" "api_gateway_account" { cloudwatch_role_arn = aws_iam_role.api_gateway_to_cloudwatch.arn depends_on = [ aws_iam_role.api_gateway_to_cloudwatch ] } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/iam__developer-role.tf000066400000000000000000000012461511201605300270170ustar00rootroot00000000000000resource "aws_iam_role" "developer_role" { name = "NHSDDeveloperRole" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { AWS : "arn:aws:iam::${data.aws_secretsmanager_secret_version.identities_account_id.secret_string}:root" }, Effect : "Allow" Condition : { Bool : { "aws:MultiFactorAuthPresent" : true } } } ] }) } resource "aws_iam_role_policy_attachment" "policy_attachment" { role = aws_iam_role.developer_role.name policy_arn = "arn:aws:iam::aws:policy/AdministratorAccess" } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/locals.tf000066400000000000000000000005051511201605300243600ustar00rootroot00000000000000locals { region = "eu-west-2" project = "nhsd-nrlf" environment = terraform.workspace prefix = "${local.project}--${local.environment}" account_id = data.aws_caller_identity.current.account_id notification_emails = tolist(jsondecode(data.aws_secretsmanager_secret_version.emails.secret_string)) } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/main.tf000066400000000000000000000015121511201605300240260ustar00rootroot00000000000000provider "aws" { region = local.region assume_role { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } default_tags { tags = { project_name = local.project workspace = terraform.workspace } } } provider "awscc" { region = local.region assume_role = { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } } terraform { backend "s3" { encrypt = false region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-account-wide-infrastructure" workspace_key_prefix = "nhsd-nrlf" } required_providers { aws = { source = "hashicorp/aws" version = "~> 6.0" } } } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/outputs.tf000066400000000000000000000016671511201605300246400ustar00rootroot00000000000000output "powerbi_gw_instance_id" { description = "The ID of the PowerBI Gateway EC2 instance." value = var.enable_powerbi_auto_push ? module.powerbi_gw_instance[0].instance_id : null } output "reporting_database_name" { description = "Name of the reporting Athena database" value = var.enable_reporting ? module.dev-glue.glue_database : null } output "athena_workgroup_name" { description = "Name of the Athena workgroup" value = var.enable_reporting ? module.dev-athena[0].workgroup_name : null } output "athena_s3_output_location" { description = "S3 output location for Athena queries" value = var.enable_reporting ? "s3://${module.dev-athena[0].bucket.id}/" : null } output "athena_kms_key_arn" { description = "KMS key ARN for Athena encryption" value = var.enable_reporting ? module.dev-athena[0].kms_key_arn : null } output "version" { value = data.external.current-info.result.version } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/route53.tf000066400000000000000000000002671511201605300244160ustar00rootroot00000000000000resource "aws_route53_zone" "dev-ns" { name = "api.record-locator.dev.national.nhs.uk" } resource "aws_route53_zone" "NEW_dev-ns" { name = "dev.record-locator.national.nhs.uk" } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/s3.tf000066400000000000000000000013761511201605300234370ustar00rootroot00000000000000module "dev-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--dev" enable_backups = false } module "dev-sandbox-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--dev-sandbox" } module "dev-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--dev" server_certificate_file = "../../../truststore/server/dev.pem" enable_backups = false } module "dev-sandbox-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--dev-sandbox" server_certificate_file = "../../../truststore/server/dev.pem" } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/secrets.tf000066400000000000000000000043221511201605300245540ustar00rootroot00000000000000resource "aws_secretsmanager_secret" "identities_account_id" { name = "${local.prefix}--nhs-identities-account-id" } resource "aws_secretsmanager_secret" "backup_destination_parameters" { name = "${local.prefix}--backup-destination-parameters" description = "Parameters used to configure the backup destination" } resource "aws_secretsmanager_secret" "dev_smoke_test_apigee_app" { name = "${local.prefix}--dev--apigee-app--smoke-test" description = "APIGEE App used to run Smoke Tests against the DEV environment" } resource "aws_secretsmanager_secret" "dev_smoke_test_parameters" { name = "${local.project}--dev--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the dev environment" } resource "aws_secretsmanager_secret" "devsandbox_smoke_test_parameters" { name = "${local.project}--dev-sandbox--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the dev-sandbox environment" } resource "aws_secretsmanager_secret" "dev_splunk_configuration" { name = "${local.project}--dev--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_dev index" } resource "aws_secretsmanager_secret" "devsandbox_splunk_configuration" { name = "${local.project}--devsandbox--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_devsandbox index" } resource "aws_secretsmanager_secret" "dev_environment_configuration" { name = "${local.project}--dev--env-config" description = "The environment configuration for the Dev environment" } resource "aws_secretsmanager_secret" "devsandbox_environment_configuration" { name = "${local.project}--dev-sandbox--env-config" description = "The environment configuration for the Dev Sandbox environment" } resource "aws_secretsmanager_secret" "powerbi_gw_instance_admin_pwd" { name = "${local.project}--dev-powerbi-gw-instance-admin-pwd" description = "Admin password for the PowerBI Gateway EC2 instance" } resource "aws_secretsmanager_secret" "powerbi_gw_recovery_key" { name = "${local.project}--dev-powerbi-gw-recovery-key" description = "Recovery key for the PowerBI Gateway EC2 instance" } NRLF-3.0.31/terraform/account-wide-infrastructure/dev/vars.tf000066400000000000000000000032721511201605300240620ustar00rootroot00000000000000variable "assume_account" { sensitive = true } variable "assume_role" {} variable "dev_api_domain_name" { description = "The internal DNS name of the API Gateway for the dev environment" default = "dev.api.record-locator.dev.national.nhs.uk" } variable "devsandbox_api_domain_name" { description = "The internal DNS name of the API Gateway for the dev sandbox environment" default = "dev-sandbox.api.record-locator.dev.national.nhs.uk" } variable "enable_reporting" { type = bool description = "Enable account-wide reporting processes in the dev account" default = true } variable "aws_azs" { type = string description = "AWS Availability Zones" default = "eu-west-2a" } variable "enable_dns_hostnames" { type = bool description = "Enable DNS hostnames in VPC" default = true } variable "vpc_cidr_block" { type = string description = "Base CIDR Block for VPC" default = "10.0.0.0/16" } variable "vpc_public_subnets_cidr_block" { type = string description = "CIDR Block for Public Subnets in VPC" default = "10.0.0.0/24" } variable "vpc_private_subnets_cidr_block" { type = string description = "CIDR Block for Private Subnets in VPC" default = "10.0.1.0/24" } variable "enable_powerbi_auto_push" { type = bool description = "Enable automatic pushing of info into PowerBI" default = true } variable "powerbi_gw_instance_type" { type = string description = "Type for PowerBI GW EC2 Instance" default = "t2.medium" } variable "use_powerbi_gw_custom_ami" { type = bool description = "Use custom image for PowerBI GW instance" default = true } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/000077500000000000000000000000001511201605300227365ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/.terraform-version000066400000000000000000000000061511201605300264170ustar00rootroot000000000000001.9.8 NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/codebuild.tf000066400000000000000000000057241511201605300252330ustar00rootroot00000000000000data "aws_iam_policy_document" "codebuild_assume_role" { statement { effect = "Allow" principals { type = "Service" identifiers = ["codebuild.amazonaws.com"] } actions = [ "sts:AssumeRole", "sts:AssumeRoleWithWebIdentity", "sts:TagSession" ] condition { test = "StringEquals" variable = "aws:SourceAccount" values = ["${data.aws_caller_identity.current.account_id}"] } } } resource "aws_iam_role" "codebuild_service_role" { name = "${local.project}-codebuild-service-role" assume_role_policy = data.aws_iam_policy_document.codebuild_assume_role.json } data "aws_iam_policy_document" "codebuild_policy" { statement { effect = "Allow" actions = [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents", ] resources = ["*"] } statement { effect = "Allow" actions = [ "codeconnections:GetConnectionToken", "codeconnections:GetConnection" ] resources = ["arn:aws:codestar-connections:us-east-1:123456789012:connection/guid-string"] } statement { effect = "Allow" actions = [ "secretsmanager:GetSecretValue", "secretsmanager:DescribeSecret", "secretsmanager:ListSecretVersionIds" ] resources = [ "arn:aws:secretsmanager:${data.aws_region.current.region}:${data.aws_caller_identity.current.account_id}:secret:${local.project}--codebuild-github-pat-*", ] } statement { effect = "Allow" actions = [ "ecr:*" ] resources = [ "${aws_ecr_repository.repository.arn}", "${aws_ecr_repository.repository.arn}:*" ] } } resource "aws_iam_role_policy" "codebuild_policy" { role = aws_iam_role.codebuild_service_role.name policy = data.aws_iam_policy_document.codebuild_policy.json } resource "aws_codebuild_project" "project" { name = "${local.project}-ci-build-project" description = "NRLF CI Build Project" service_role = aws_iam_role.codebuild_service_role.arn artifacts { type = "NO_ARTIFACTS" } environment { compute_type = "BUILD_GENERAL1_SMALL" image = "${aws_ecr_repository.repository.repository_url}:latest" type = "LINUX_CONTAINER" image_pull_credentials_type = "CODEBUILD" } logs_config { cloudwatch_logs { group_name = "${local.project}-ci-build-logs" stream_name = "build-log-stream" } } source { type = "GITHUB" location = "https://github.com/NHSDigital/NRLF" git_clone_depth = 1 } source_version = "main" project_visibility = "PRIVATE" } resource "aws_codebuild_webhook" "github_workflow" { project_name = aws_codebuild_project.project.name build_type = "BUILD" filter_group { filter { type = "EVENT" pattern = "WORKFLOW_JOB_QUEUED" } } depends_on = [aws_codebuild_project.project, aws_iam_role.codebuild_service_role] } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/data.tf000066400000000000000000000032321511201605300242020ustar00rootroot00000000000000data "aws_caller_identity" "current" {} data "aws_region" "current" {} data "aws_dynamodb_table" "terraform_state_lock" { name = "${local.project}--terraform-state-lock" } data "aws_s3_bucket" "terraform_state" { bucket = "${local.project}--terraform-state" } data "aws_s3_bucket" "ci_logging" { bucket = "${local.project}--mgmt--github-ci-logging" } data "aws_s3_bucket" "truststore" { bucket = "${local.project}--truststore" } data "aws_secretsmanager_secret_version" "identities_account_id" { secret_id = aws_secretsmanager_secret.identities_account_id.name } data "aws_secretsmanager_secret" "prod_account_id" { name = "${local.project}--mgmt--prod-account-id" } data "aws_secretsmanager_secret" "dev_account_id" { name = "${local.project}--mgmt--dev-account-id" } data "aws_secretsmanager_secret" "test_account_id" { name = "${local.project}--mgmt--test-account-id" } data "aws_secretsmanager_secret" "test_backup_account_id" { name = "${local.project}--mgmt--test-backup-account-id" } data "aws_secretsmanager_secret" "test_restore_account_id" { name = "${local.project}--mgmt--test-restore-account-id" } data "aws_secretsmanager_secret_version" "dev_account_id" { secret_id = data.aws_secretsmanager_secret.dev_account_id.name } data "aws_secretsmanager_secret_version" "test_account_id" { secret_id = data.aws_secretsmanager_secret.test_account_id.name } data "aws_secretsmanager_secret_version" "test_backup_account_id" { secret_id = data.aws_secretsmanager_secret.test_backup_account_id.name } data "aws_secretsmanager_secret_version" "test_restore_account_id" { secret_id = data.aws_secretsmanager_secret.test_restore_account_id.name } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/ecr.tf000066400000000000000000000015221511201605300240420ustar00rootroot00000000000000resource "aws_ecr_repository" "repository" { name = "${local.project}-ci-build" image_tag_mutability = "MUTABLE" } data "aws_iam_policy_document" "codebuild_access_policy" { statement { sid = "CodeBuildEcrAccess" effect = "Allow" principals { type = "Service" identifiers = ["codebuild.amazonaws.com"] } actions = [ "ecr:GetDownloadUrlForLayer", "ecr:BatchGetImage", "ecr:BatchCheckLayerAvailability", ] condition { test = "StringEquals" variable = "aws:SourceAccount" values = ["${data.aws_caller_identity.current.account_id}"] } } } resource "aws_ecr_repository_policy" "codebuild_access_policy" { repository = aws_ecr_repository.repository.name policy = data.aws_iam_policy_document.codebuild_access_policy.json } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/etc/000077500000000000000000000000001511201605300235115ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/etc/mgmt.tfvars000066400000000000000000000000001511201605300256720ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/iam__developer-role.tf000066400000000000000000000063671511201605300272160ustar00rootroot00000000000000resource "aws_iam_role" "developer_role" { name = "NHSDDeveloperRole" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { AWS : "arn:aws:iam::${data.aws_secretsmanager_secret_version.identities_account_id.secret_string}:root" }, Effect : "Allow" } ] }) } module "developer_policy" { source = "../modules/role-policy" name = "${local.prefix}--developer-policy" role_name = aws_iam_role.developer_role.name iam_permissions = [ { Action = [ "s3:PutObject", "s3:DeleteObject", "s3:GetObject", "dynamodb:PutItem", "dynamodb:GetItem", "dynamodb:DeleteItem", "s3:ListBucket" ] Effect = "Allow" Resource = [ data.aws_dynamodb_table.terraform_state_lock.arn, data.aws_s3_bucket.terraform_state.arn, "${data.aws_s3_bucket.terraform_state.arn}/*" ] }, { Action = [ "s3:PutObject", "s3:GetObject", "s3:DeleteObject" ] Effect = "Deny" Resource = [ "${data.aws_s3_bucket.terraform_state.arn}/${local.project}/prod/*", "${data.aws_s3_bucket.terraform_state.arn}/${local.project}/mgmt/*", ] }, { Action = [ "s3:DeleteObject" ] Effect = "Deny" Resource = [ "${data.aws_s3_bucket.terraform_state.arn}/${local.project}/dev/*" ] }, { Action = "sts:AssumeRole" Effect = "Allow" Resource = [ "arn:aws:iam::${data.aws_secretsmanager_secret_version.dev_account_id.secret_string}:role/terraform", "arn:aws:iam::${data.aws_secretsmanager_secret_version.test_account_id.secret_string}:role/terraform", "arn:aws:iam::${data.aws_secretsmanager_secret_version.test_backup_account_id.secret_string}:role/terraform", "arn:aws:iam::${data.aws_secretsmanager_secret_version.test_restore_account_id.secret_string}:role/terraform" ] }, { Action = [ "secretsmanager:GetResourcePolicy", "secretsmanager:GetSecretValue", "secretsmanager:DescribeSecret", "secretsmanager:ListSecretVersionIds" ] Effect = "Allow" Resource = [ data.aws_secretsmanager_secret.dev_account_id.arn, data.aws_secretsmanager_secret.test_account_id.arn ] }, { Action = [ "s3:ListAllMyBuckets" ] Effect = "Allow" Resource = [ "arn:aws:s3:::*" ] }, { Action = [ "s3:GetObject", "s3:ListBucket" ] Effect = "Allow" Resource = [ data.aws_s3_bucket.ci_logging.arn, "${data.aws_s3_bucket.ci_logging.arn}/*" ] }, { Action = [ "s3:PutObject", "s3:GetObject", "s3:DeleteObject" ] Effect = "Deny" Resource = [ "${data.aws_s3_bucket.truststore.arn}/ca/prod*", "${data.aws_s3_bucket.truststore.arn}/client/prod*", "${data.aws_s3_bucket.truststore.arn}/server/prod*" ] }, { Action = [ "s3:GetObject" ] Effect = "Allow" Resource = [ "${data.aws_s3_bucket.truststore.arn}/*" ] } ] } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/locals.tf000066400000000000000000000002401511201605300245420ustar00rootroot00000000000000locals { region = "eu-west-2" project = "nhsd-nrlf" environment = terraform.workspace prefix = "${local.project}--${local.environment}" } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/main.tf000066400000000000000000000007621511201605300242220ustar00rootroot00000000000000provider "aws" { region = local.region default_tags { tags = { project_name = local.project workspace = terraform.workspace } } } terraform { backend "s3" { encrypt = false region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-account-wide-infrastructure" workspace_key_prefix = "nhsd-nrlf" } } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/route53.tf000066400000000000000000000065671511201605300246150ustar00rootroot00000000000000resource "aws_route53_zone" "prod_zone" { name = "record-locator.national.nhs.uk" tags = { Environment = terraform.workspace } } resource "aws_route53_record" "prod_zone" { zone_id = aws_route53_zone.prod_zone.zone_id name = "api.record-locator.national.nhs.uk" records = [ "ns-1269.awsdns-30.org.", "ns-729.awsdns-27.net.", "ns-1680.awsdns-18.co.uk.", "ns-237.awsdns-29.com." ] ttl = 300 type = "NS" } resource "aws_route53_zone" "ref_zone" { name = "record-locator.ref.national.nhs.uk" tags = { Environment = terraform.workspace } } resource "aws_route53_record" "ref_zone" { zone_id = aws_route53_zone.ref_zone.zone_id name = "api.record-locator.ref.national.nhs.uk" records = [ "ns-1982.awsdns-55.co.uk.", "ns-1513.awsdns-61.org.", "ns-765.awsdns-31.net.", "ns-257.awsdns-32.com." ] ttl = 300 type = "NS" } resource "aws_route53_zone" "int_zone" { name = "record-locator.int.national.nhs.uk" tags = { Environment = terraform.workspace } } resource "aws_route53_record" "int_zone" { zone_id = aws_route53_zone.int_zone.zone_id name = "api." records = [ "ns-1877.awsdns-42.co.uk.", "ns-279.awsdns-34.com.", "ns-789.awsdns-34.net.", "ns-1362.awsdns-42.org." ] ttl = 300 type = "NS" } resource "aws_route53_zone" "dev_zone" { name = "record-locator.dev.national.nhs.uk" tags = { Environment = terraform.workspace } } resource "aws_route53_record" "dev_zone" { zone_id = aws_route53_zone.dev_zone.zone_id name = "api.record-locator.dev.national.nhs.uk" records = [ "ns-495.awsdns-61.com.", "ns-610.awsdns-12.net.", "ns-1934.awsdns-49.co.uk.", "ns-1382.awsdns-44.org." ] ttl = 300 type = "NS" } /** * NEW DNS Zone (all under record-locator.national.nhs.uk) */ resource "aws_route53_record" "NEW_ref_zone_delegation" { zone_id = aws_route53_zone.prod_zone.zone_id name = "ref.record-locator.national.nhs.uk" records = [ "ns-1654.awsdns-14.co.uk.", "ns-1328.awsdns-38.org.", "ns-47.awsdns-05.com.", "ns-834.awsdns-40.net." ] ttl = 300 type = "NS" } resource "aws_route53_record" "NEW_int_zone_delegation" { zone_id = aws_route53_zone.prod_zone.zone_id name = "int.record-locator.national.nhs.uk" records = [ "ns-1064.awsdns-05.org.", "ns-609.awsdns-12.net.", "ns-2014.awsdns-59.co.uk.", "ns-386.awsdns-48.com." ] ttl = 300 type = "NS" } resource "aws_route53_record" "NEW_dev_zone_delegation" { zone_id = aws_route53_zone.prod_zone.zone_id name = "dev.record-locator.national.nhs.uk" records = [ "ns-1331.awsdns-38.org.", "ns-160.awsdns-20.com.", "ns-1900.awsdns-45.co.uk.", "ns-962.awsdns-56.net." ] ttl = 300 type = "NS" } resource "aws_route53_record" "NEW_qa_zone_delegation" { zone_id = aws_route53_zone.prod_zone.zone_id name = "qa.record-locator.national.nhs.uk" records = [ "ns-1821.awsdns-35.co.uk.", "ns-1449.awsdns-53.org.", "ns-933.awsdns-52.net.", "ns-500.awsdns-62.com." ] ttl = 300 type = "NS" } resource "aws_route53_record" "perftest_zone_delegation" { zone_id = aws_route53_zone.prod_zone.zone_id name = "perftest.record-locator.national.nhs.uk" records = [ "ns-885.awsdns-46.net.", "ns-1995.awsdns-57.co.uk.", "ns-239.awsdns-29.com.", "ns-1424.awsdns-50.org." ] ttl = 300 type = "NS" } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/secrets.tf000066400000000000000000000001671511201605300247450ustar00rootroot00000000000000resource "aws_secretsmanager_secret" "identities_account_id" { name = "${local.prefix}--nhs-identities-account-id" } NRLF-3.0.31/terraform/account-wide-infrastructure/mgmt/vars.tf000066400000000000000000000007311511201605300242450ustar00rootroot00000000000000variable "private_subnet_cidr_blocks" { description = "Available CIDR blocks for private subnets" type = list(string) default = [ "10.0.1.0/24", "10.0.2.0/24", "10.0.3.0/24", "10.0.4.0/24", ] } variable "subnet_count" { description = "Number of subnets" type = map(number) default = { private = 3 } } variable "vpc_cidr_block" { description = "CIDR block for VPC" type = string default = "10.0.0.0/16" } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/000077500000000000000000000000001511201605300234425ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/000077500000000000000000000000001511201605300247025ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/athena.tf000066400000000000000000000015441511201605300265010ustar00rootroot00000000000000resource "aws_athena_workgroup" "athena" { name = "${var.name_prefix}-athena-wg" configuration { enforce_workgroup_configuration = true publish_cloudwatch_metrics_enabled = true result_configuration { output_location = "s3://${aws_s3_bucket.athena.id}/output/" encryption_configuration { encryption_option = "SSE_KMS" kms_key_arn = aws_kms_key.athena.arn } } } } resource "aws_athena_named_query" "rep_consumer" { name = "rep_consumer" workgroup = aws_athena_workgroup.athena.id database = var.glue_database query = file("${path.module}/sql/rep_consumer.sql") } resource "aws_athena_named_query" "rep_producer" { name = "rep_producer" workgroup = aws_athena_workgroup.athena.id database = var.glue_database query = file("${path.module}/sql/rep_producer.sql") } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/kms.tf000066400000000000000000000002531511201605300260270ustar00rootroot00000000000000resource "aws_kms_key" "athena" { } resource "aws_kms_alias" "athena" { name = "alias/${var.name_prefix}-athena" target_key_id = aws_kms_key.athena.key_id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/outputs.tf000066400000000000000000000003621511201605300267610ustar00rootroot00000000000000output "workgroup_name" { value = aws_athena_workgroup.athena.name } output "bucket" { value = aws_s3_bucket.athena } output "bucket_arn" { value = aws_s3_bucket.athena.arn } output "kms_key_arn" { value = aws_kms_key.athena.arn } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/s3.tf000066400000000000000000000030261511201605300255630ustar00rootroot00000000000000resource "aws_s3_bucket" "athena" { bucket = "${var.name_prefix}-athena" } resource "aws_s3_bucket_policy" "athena" { bucket = "${var.name_prefix}-athena" policy = jsonencode({ Version = "2012-10-17" Id = "athena-policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = { "AWS" : "*" } Action = "s3:*" Resource = [ aws_s3_bucket.athena.arn, "${aws_s3_bucket.athena.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, { Sid : "AllowAthenaAccess", Effect : "Allow", Principal : { Service : "athena.amazonaws.com" }, Action : [ "s3:PutObject", "s3:GetBucketLocation", "s3:GetObject", "s3:ListBucket" ], Resource : [ aws_s3_bucket.athena.arn, "${aws_s3_bucket.athena.arn}/*", ] }, ] }) } resource "aws_s3_bucket_public_access_block" "athena-public-access-block" { bucket = aws_s3_bucket.athena.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "athena" { bucket = aws_s3_bucket.athena.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "aws:kms" kms_master_key_id = aws_kms_key.athena.arn } } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/sql/000077500000000000000000000000001511201605300255015ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/sql/rep_consumer.sql000066400000000000000000000044471511201605300307340ustar00rootroot00000000000000CREATE OR REPLACE VIEW "rep_consumer" AS WITH cc AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM consumer_countdocumentreference ) , cr AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM consumer_readdocumentreference ) , cs AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM consumer_searchdocumentreference ) , csp AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM consumer_searchpostdocumentreference ) , base AS ( SELECT * FROM cc UNION SELECT * FROM cr UNION SELECT * FROM cs UNION SELECT * FROM csp ) , ods_codes AS ( SELECT DISTINCT user_ods , event_xray_trace_id FROM base WHERE (user_ods IS NOT NULL) ) SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , b.event_correlation_id , b.event_xray_trace_id , event_pointer_types , oc.user_ods FROM (base b LEFT JOIN ods_codes oc ON (b.event_xray_trace_id = oc.event_xray_trace_id)) NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/sql/rep_producer.sql000066400000000000000000000072361511201605300307230ustar00rootroot00000000000000CREATE OR REPLACE VIEW "rep_producer" AS WITH pc AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_createdocumentreference ) , pd AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id --, event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_deletedocumentreference ) /*, pr AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_readdocumentreference )*/ /*, ps AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_searchdocumentreference )*/ , psp AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id --, event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_searchpostdocumentreference ) /*, pu AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id , event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_updatedocumentreference )*/ , pus AS ( SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , event_correlation_id , event_xray_trace_id --, event_pointer_types , COALESCE("event_headers_nhsd-end-user-organisation-ods", event_metadata_ods_code) user_ods FROM producer_upsertdocumentreference ) , base AS ( SELECT * FROM pc UNION SELECT * FROM pd /*UNION SELECT * FROM pr UNION SELECT * FROM ps*/ UNION SELECT * FROM psp /*UNION SELECT * FROM pu*/ UNION SELECT * FROM pus ) , ods_codes AS ( SELECT DISTINCT user_ods , event_xray_trace_id FROM base WHERE (user_ods IS NOT NULL) ) SELECT time , event_timestamp , date , host , event_log_reference , event_level , event_location , event_message , event_service , event_function_request_id , b.event_correlation_id , b.event_xray_trace_id --, event_pointer_types , oc.user_ods FROM (base b LEFT JOIN ods_codes oc ON (b.event_xray_trace_id = oc.event_xray_trace_id)) NRLF-3.0.31/terraform/account-wide-infrastructure/modules/athena/vars.tf000066400000000000000000000006061511201605300262120ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "bucket_region" { type = string description = "The AWS region where the S3 bucket will be created." } variable "target_bucket_name" { type = string } variable "glue_database" { type = string description = "The Glue database in use" } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/000077500000000000000000000000001511201605300262055ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/README.md000066400000000000000000000677241511201605300275040ustar00rootroot00000000000000# AWS Backup Module The AWS Backup Module helps automates the setup of AWS Backup resources in a source account. It streamlines the process of creating, managing, and standardising backup configurations. ## Inputs | Name | Description | Type | Default | Required | | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | | [backup_copy_vault_account_id](#input_backup_copy_vault_account_id) | The account id of the destination backup vault for allowing restores back into the source account. | `string` | `""` | no | | [backup_copy_vault_arn](#input_backup_copy_vault_arn) | The ARN of the destination backup vault for cross-account backup copies. | `string` | `""` | no | | [backup_plan_config](#input_backup_plan_config) | Configuration for backup plans | 
object({
 selection_tag = string
 compliance_resource_types = list(string)
 rules = list(object({
 name = string
 schedule = string
 enable_continuous_backup = optional(bool)
 lifecycle = object({
 delete_after = optional(number)
 cold_storage_after = optional(number)
 })
 copy_action = optional(object({
 delete_after = optional(number)
 }))
 }))
 })
| 
{
 "compliance_resource_types": [
 "S3"
 ],
 "rules": [
 {
 "copy_action": {
 "delete_after": 365
 },
 "lifecycle": {
 "delete_after": 35
 },
 "name": "daily_kept_5_weeks",
 "schedule": "cron(0 0 * * ? *)"
 },
 {
 "copy_action": {
 "delete_after": 365
 },
 "lifecycle": {
 "delete_after": 90
 },
 "name": "weekly_kept_3_months",
 "schedule": "cron(0 1 ? * SUN *)"
 },
 {
 "copy_action": {
 "delete_after": 365
 },
 "lifecycle": {
 "cold_storage_after": 30,
 "delete_after": 2555
 },
 "name": "monthly_kept_7_years",
 "schedule": "cron(0 2 1 * ? *)"
 },
 {
 "copy_action": {
 "delete_after": 365
 },
 "enable_continuous_backup": true,
 "lifecycle": {
 "delete_after": 35
 },
 "name": "point_in_time_recovery",
 "schedule": "cron(0 5 * * ? *)"
 }
 ],
 "selection_tag": "BackupLocal"
}
| no | | [backup_plan_config_dynamodb](#input_backup_plan_config_dynamodb) | Configuration for backup plans with dynamodb | 
object({
 enable = bool
 selection_tag = string
 compliance_resource_types = list(string)
 rules = optional(list(object({
 name = string
 schedule = string
 enable_continuous_backup = optional(bool)
 lifecycle = object({
 delete_after = number
 cold_storage_after = optional(number)
 })
 copy_action = optional(object({
 delete_after = optional(number)
 }))
 })))
 })
| 
{
 "compliance_resource_types": [
 "DynamoDB"
 ],
 "enable": true,
 "rules": [
 {
 "copy_action": {
 "delete_after": 365
 },
 "lifecycle": {
 "delete_after": 35
 },
 "name": "dynamodb_daily_kept_5_weeks",
 "schedule": "cron(0 0 * * ? *)"
 },
 {
 "copy_action": {
 "delete_after": 365
 },
 "lifecycle": {
 "delete_after": 90
 },
 "name": "dynamodb_weekly_kept_3_months",
 "schedule": "cron(0 1 ? * SUN *)"
 },
 {
 "copy_action": {
 "delete_after": 365
 },
 "lifecycle": {
 "cold_storage_after": 30,
 "delete_after": 2555
 },
 "name": "dynamodb_monthly_kept_7_years",
 "schedule": "cron(0 2 1 * ? *)"
 }
 ],
 "selection_tag": "BackupDynamoDB"
}
| no | | [bootstrap_kms_key_arn](#input_bootstrap_kms_key_arn) | The ARN of the bootstrap KMS key used for encryption at rest of the SNS topic. | `string` | n/a | yes | | [environment_name](#input_environment_name) | The name of the environment where AWS Backup is configured. | `string` | n/a | yes | | [notifications_target_email_address](#input_notifications_target_email_address) | The email address to which backup notifications will be sent via SNS. | `string` | `""` | no | | [project_name](#input_project_name) | The name of the project this relates to. | `string` | n/a | yes | | [reports_bucket](#input_reports_bucket) | Bucket to drop backup reports into | `string` | n/a | yes | | [restore_testing_plan_algorithm](#input_restore_testing_plan_algorithm) | Algorithm of the Recovery Selection Point | `string` | `"LATEST_WITHIN_WINDOW"` | no | | [restore_testing_plan_recovery_point_types](#input_restore_testing_plan_recovery_point_types) | Recovery Point Types | `list(string)` | 
[
 "SNAPSHOT"
]
| no | | [restore_testing_plan_scheduled_expression](#input_restore_testing_plan_scheduled_expression) | Scheduled Expression of Recovery Selection Point | `string` | `"cron(0 1 ? * SUN *)"` | no | | [restore_testing_plan_selection_window_days](#input_restore_testing_plan_selection_window_days) | Selection window days | `number` | `7` | no | | [restore_testing_plan_start_window](#input_restore_testing_plan_start_window) | Start window from the scheduled time during which the test should start | `number` | `1` | no | | [terraform_role_arn](#input_terraform_role_arn) | ARN of Terraform role used to deploy to account | `string` | n/a | yes | ## Example ```terraform module "test_aws_backup" { source = "./modules/aws-backup" environment_name = "environment_name" bootstrap_kms_key_arn = kms_key[0].arn project_name = "testproject" reports_bucket = "compliance-reports" terraform_role_arn = data.aws_iam_role.terraform_role.arn } ``` NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_framework.tf000066400000000000000000000071201511201605300320620ustar00rootroot00000000000000resource "aws_backup_framework" "main" { # must be underscores instead of dashes name = replace("${local.resource_name_prefix}-framework", "-", "_") description = "${var.project_name} Backup Framework" # Evaluates if recovery points are encrypted. control { name = "BACKUP_RECOVERY_POINT_ENCRYPTED" scope { tags = { "environment_name" = var.environment_name } } } # Evaluates if backup vaults do not allow manual deletion of recovery points with the exception of certain IAM roles. control { name = "BACKUP_RECOVERY_POINT_MANUAL_DELETION_DISABLED" scope { tags = { "environment_name" = var.environment_name } } input_parameter { name = "principalArnList" value = var.terraform_role_arn } } # Evaluates if recovery point retention period is at least 1 month. control { name = "BACKUP_RECOVERY_POINT_MINIMUM_RETENTION_CHECK" scope { tags = { "environment_name" = var.environment_name } } input_parameter { name = "requiredRetentionDays" value = "35" } } # Evaluates if backup plan creates backups at least every 1 day and retains them for at least 1 month before deleting them. control { name = "BACKUP_PLAN_MIN_FREQUENCY_AND_MIN_RETENTION_CHECK" scope { tags = { "environment_name" = var.environment_name } } input_parameter { name = "requiredFrequencyUnit" value = "days" } input_parameter { name = "requiredRetentionDays" value = "35" } input_parameter { name = "requiredFrequencyValue" value = "1" } } # Evaluates if resources are protected by a backup plan. control { name = "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN" scope { compliance_resource_types = var.backup_plan_config.compliance_resource_types tags = { (var.backup_plan_config.selection_tag) = "True" } } } # Evaluates if resources have at least one recovery point created within the past 1 day. control { name = "BACKUP_LAST_RECOVERY_POINT_CREATED" input_parameter { name = "recoveryPointAgeUnit" value = "days" } input_parameter { name = "recoveryPointAgeValue" value = "1" } scope { compliance_resource_types = var.backup_plan_config.compliance_resource_types tags = { (var.backup_plan_config.selection_tag) = "True" } } } } resource "aws_backup_framework" "dynamodb" { count = var.backup_plan_config_dynamodb.enable ? 1 : 0 # must be underscores instead of dashes name = replace("${local.resource_name_prefix}-dynamodb-framework", "-", "_") description = "${var.project_name} DynamoDB Backup Framework" # Evaluates if resources are protected by a backup plan. control { name = "BACKUP_RESOURCES_PROTECTED_BY_BACKUP_PLAN" scope { compliance_resource_types = var.backup_plan_config_dynamodb.compliance_resource_types tags = { (var.backup_plan_config_dynamodb.selection_tag) = "True" } } } # Evaluates if resources have at least one recovery point created within the past 1 day. control { name = "BACKUP_LAST_RECOVERY_POINT_CREATED" input_parameter { name = "recoveryPointAgeUnit" value = "days" } input_parameter { name = "recoveryPointAgeValue" value = "1" } scope { compliance_resource_types = var.backup_plan_config_dynamodb.compliance_resource_types tags = { (var.backup_plan_config_dynamodb.selection_tag) = "True" } } } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_notification.tf000066400000000000000000000005201511201605300325500ustar00rootroot00000000000000resource "aws_backup_vault_notifications" "backup_notification" { backup_vault_name = aws_backup_vault.main.name sns_topic_arn = aws_sns_topic.backup.arn backup_vault_events = [ "BACKUP_JOB_COMPLETED", "RESTORE_JOB_COMPLETED", "S3_BACKUP_OBJECT_FAILED", "S3_RESTORE_OBJECT_FAILED", "COPY_JOB_FAILED" ] } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_plan.tf000066400000000000000000000054521511201605300310250ustar00rootroot00000000000000resource "aws_backup_plan" "default" { count = var.backup_plan_config.enable ? 1 : 0 name = "${local.resource_name_prefix}-plan" dynamic "rule" { for_each = var.backup_plan_config.rules content { recovery_point_tags = { backup_rule_name = rule.value.name } rule_name = rule.value.name target_vault_name = aws_backup_vault.main.name schedule = rule.value.schedule enable_continuous_backup = rule.value.enable_continuous_backup lifecycle { delete_after = rule.value.lifecycle.delete_after cold_storage_after = rule.value.lifecycle.cold_storage_after } dynamic "copy_action" { for_each = rule.value.copy_action != null ? rule.value.copy_action : [] content { lifecycle { delete_after = copy_action.value.delete_after } destination_vault_arn = var.backup_copy_vault_arn } } } } } # this backup plan shouldn't include a continous backup rule as it isn't supported for DynamoDB resource "aws_backup_plan" "dynamodb" { count = var.backup_plan_config_dynamodb.enable ? 1 : 0 name = "${local.resource_name_prefix}-dynamodb-plan" dynamic "rule" { for_each = var.backup_plan_config_dynamodb.rules content { recovery_point_tags = { backup_rule_name = rule.value.name } rule_name = rule.value.name target_vault_name = aws_backup_vault.main.name schedule = rule.value.schedule lifecycle { delete_after = rule.value.lifecycle.delete_after cold_storage_after = rule.value.lifecycle.cold_storage_after } dynamic "copy_action" { for_each = rule.value.copy_action != null ? rule.value.copy_action : [] content { lifecycle { delete_after = copy_action.value.delete_after cold_storage_after = copy_action.value.cold_storage_after } destination_vault_arn = var.backup_copy_vault_arn } } } } } resource "aws_backup_selection" "default" { count = var.backup_plan_config.enable ? 1 : 0 iam_role_arn = aws_iam_role.backup.arn name = "${local.resource_name_prefix}-selection" plan_id = aws_backup_plan.default[0].id selection_tag { key = var.backup_plan_config.selection_tag type = "STRINGEQUALS" value = "True" } } resource "aws_backup_selection" "dynamodb" { count = var.backup_plan_config_dynamodb.enable ? 1 : 0 iam_role_arn = aws_iam_role.backup.arn name = "${local.resource_name_prefix}-dynamodb-selection" plan_id = aws_backup_plan.dynamodb[0].id selection_tag { key = var.backup_plan_config_dynamodb.selection_tag type = "STRINGEQUALS" value = "True" } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_report_plan.tf000066400000000000000000000037001511201605300324120ustar00rootroot00000000000000# Create the reports resource "aws_backup_report_plan" "backup_jobs" { name = "backup_jobs" description = "Report for showing whether backups ran successfully in the last 24 hours" report_delivery_channel { formats = [ "JSON" ] s3_bucket_name = var.reports_bucket s3_key_prefix = "backup_jobs" } report_setting { report_template = "BACKUP_JOB_REPORT" } } # Create the restore testing completion reports resource "aws_backup_report_plan" "backup_restore_testing_jobs" { name = "backup_restore_testing_jobs" description = "Report for showing whether backup restore test ran successfully in the last 24 hours" report_delivery_channel { formats = [ "JSON" ] s3_bucket_name = var.reports_bucket s3_key_prefix = "backup_restore_testing_jobs" } report_setting { report_template = "RESTORE_JOB_REPORT" } } resource "aws_backup_report_plan" "resource_compliance" { name = "resource_compliance" description = "Report for showing whether resources are compliant with the framework" report_delivery_channel { formats = [ "JSON" ] s3_bucket_name = var.reports_bucket s3_key_prefix = "resource_compliance" } report_setting { framework_arns = var.backup_plan_config_dynamodb.enable ? [aws_backup_framework.main.arn, aws_backup_framework.dynamodb[0].arn] : [aws_backup_framework.main.arn] number_of_frameworks = 2 report_template = "RESOURCE_COMPLIANCE_REPORT" } } resource "aws_backup_report_plan" "copy_jobs" { count = var.backup_plan_config.enable || var.backup_plan_config_dynamodb.enable ? 1 : 0 name = "copy_jobs" description = "Report for showing whether copies ran successfully in the last 24 hours" report_delivery_channel { formats = [ "JSON" ] s3_bucket_name = var.reports_bucket s3_key_prefix = "copy_jobs" } report_setting { report_template = "COPY_JOB_REPORT" } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_restore_testing.tf000066400000000000000000000024071511201605300333100ustar00rootroot00000000000000resource "awscc_backup_restore_testing_plan" "backup_restore_testing_plan" { restore_testing_plan_name = "backup_restore_testing_plan" schedule_expression = var.restore_testing_plan_scheduled_expression start_window_hours = var.restore_testing_plan_start_window recovery_point_selection = { algorithm = var.restore_testing_plan_algorithm include_vaults = [aws_backup_vault.main.arn] recovery_point_types = var.restore_testing_plan_recovery_point_types selection_window_days = var.restore_testing_plan_selection_window_days } } resource "awscc_backup_restore_testing_selection" "backup_restore_testing_selection_dynamodb" { count = var.backup_plan_config_dynamodb.enable ? 1 : 0 iam_role_arn = aws_iam_role.backup.arn protected_resource_type = "DynamoDB" restore_testing_plan_name = awscc_backup_restore_testing_plan.backup_restore_testing_plan.restore_testing_plan_name restore_testing_selection_name = "backup_restore_testing_selection_dynamodb" protected_resource_arns = ["*"] protected_resource_conditions = { string_equals = [{ key = "aws:ResourceTag/${var.backup_plan_config_dynamodb.selection_tag}" value = "True" }] } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_vault.tf000066400000000000000000000002141511201605300312150ustar00rootroot00000000000000resource "aws_backup_vault" "main" { name = "${local.resource_name_prefix}-vault" kms_key_arn = aws_kms_key.aws_backup_key.arn } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/backup_vault_policy.tf000066400000000000000000000021331511201605300325760ustar00rootroot00000000000000resource "aws_backup_vault_policy" "vault_policy" { backup_vault_name = aws_backup_vault.main.name policy = data.aws_iam_policy_document.vault_policy.json } data "aws_iam_policy_document" "vault_policy" { statement { sid = "DenyApartFromTerraform" effect = "Deny" principals { type = "AWS" identifiers = ["*"] } condition { test = "ArnNotEquals" values = [var.terraform_role_arn] variable = "aws:PrincipalArn" } actions = [ "backup:DeleteRecoveryPoint", "backup:PutBackupVaultAccessPolicy", "backup:UpdateRecoveryPointLifecycle" ] resources = ["*"] } dynamic "statement" { for_each = var.backup_plan_config.enable || var.backup_plan_config_dynamodb.enable ? [1] : [] content { sid = "Allow account to copy into backup vault" effect = "Allow" actions = ["backup:CopyIntoBackupVault"] resources = ["*"] principals { type = "AWS" identifiers = ["arn:aws:iam::${var.backup_copy_vault_account_id}:root"] } } } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/data.tf000066400000000000000000000003071511201605300274510ustar00rootroot00000000000000data "aws_caller_identity" "current" {} data "aws_region" "current" {} data "aws_iam_roles" "roles" { name_regex = "AWSReservedSSO_Admin_.*" path_prefix = "/aws-reserved/sso.amazonaws.com/" } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/iam.tf000066400000000000000000000021341511201605300273060ustar00rootroot00000000000000data "aws_iam_policy_document" "assume_role" { statement { effect = "Allow" principals { type = "Service" identifiers = ["backup.amazonaws.com"] } actions = ["sts:AssumeRole"] } } resource "aws_iam_role" "backup" { name = "${var.project_name}BackupRole" assume_role_policy = data.aws_iam_policy_document.assume_role.json } resource "aws_iam_role_policy_attachment" "backup" { policy_arn = "arn:aws:iam::aws:policy/service-role/AWSBackupServiceRolePolicyForBackup" role = aws_iam_role.backup.name } resource "aws_iam_role_policy_attachment" "restore" { policy_arn = "arn:aws:iam::aws:policy/service-role/AWSBackupServiceRolePolicyForRestores" role = aws_iam_role.backup.name } resource "aws_iam_role_policy_attachment" "s3_restore" { policy_arn = "arn:aws:iam::aws:policy/AWSBackupServiceRolePolicyForS3Restore" role = aws_iam_role.backup.name } resource "aws_iam_role_policy_attachment" "s3_backup" { policy_arn = "arn:aws:iam::aws:policy/AWSBackupServiceRolePolicyForS3Backup" role = aws_iam_role.backup.name } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/kms.tf000066400000000000000000000021031511201605300273260ustar00rootroot00000000000000resource "aws_kms_key" "aws_backup_key" { description = "AWS Backup KMS Key" deletion_window_in_days = 30 enable_key_rotation = true policy = data.aws_iam_policy_document.backup_key_policy.json } resource "aws_kms_alias" "backup_key" { name = "alias/${var.environment_name}/backup-key" target_key_id = aws_kms_key.aws_backup_key.key_id } data "aws_iam_policy_document" "backup_key_policy" { #checkov:skip=CKV_AWS_109:See (CERSS-25168) for more info #checkov:skip=CKV_AWS_111:See (CERSS-25169) for more info statement { sid = "AllowBackupUseOfKey" principals { type = "Service" identifiers = ["backup.amazonaws.com"] } actions = ["kms:GenerateDataKey", "kms:Decrypt", "kms:Encrypt"] resources = ["*"] } statement { sid = "EnableIAMUserPermissions" principals { type = "AWS" identifiers = [ "arn:aws:iam::${data.aws_caller_identity.current.account_id}:root", var.terraform_role_arn ] } actions = ["kms:*"] resources = ["*"] } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/locals.tf000066400000000000000000000001761511201605300300210ustar00rootroot00000000000000locals { resource_name_prefix = "${data.aws_region.current.region}-${data.aws_caller_identity.current.account_id}-backup" } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/sns.tf000066400000000000000000000022421511201605300273430ustar00rootroot00000000000000resource "aws_sns_topic" "backup" { name = "${local.resource_name_prefix}-notifications" kms_master_key_id = var.bootstrap_kms_key_arn } data "aws_iam_policy_document" "allow_backup_to_sns" { policy_id = "backup" statement { actions = [ "SNS:Publish", ] effect = "Allow" principals { type = "Service" identifiers = ["backup.amazonaws.com"] } resources = [ aws_sns_topic.backup.arn ] sid = "allow_backup" condition { test = "StringEquals" variable = "aws:SourceAccount" values = ["${data.aws_caller_identity.current.account_id}"] } } } resource "aws_sns_topic_policy" "backup_sns_policy" { arn = aws_sns_topic.backup.arn policy = data.aws_iam_policy_document.allow_backup_to_sns.json } resource "aws_sns_topic_subscription" "aws_backup_notifications_email_target" { count = length(var.notification_target_email_addresses) topic_arn = aws_sns_topic.backup.arn protocol = "email" endpoint = var.notification_target_email_addresses[count.index] filter_policy = jsonencode({ "State" : [{ "anything-but" : "COMPLETED" }] }) } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/backup-source/variables.tf000066400000000000000000000065111511201605300305130ustar00rootroot00000000000000variable "project_name" { description = "The name of the project this relates to." type = string } variable "environment_name" { description = "The name of the environment where AWS Backup is configured." type = string } variable "notification_target_email_addresses" { description = "The email addresses to which backup notifications will be sent via SNS." type = list(string) sensitive = true default = [] } variable "bootstrap_kms_key_arn" { description = "The ARN of the bootstrap KMS key used for encryption at rest of the SNS topic." type = string } variable "reports_bucket" { description = "Bucket to drop backup reports into" type = string } variable "terraform_role_arn" { description = "ARN of Terraform role used to deploy to account" type = string } variable "restore_testing_plan_algorithm" { description = "Algorithm of the Recovery Selection Point" type = string default = "LATEST_WITHIN_WINDOW" } variable "restore_testing_plan_start_window" { description = "Start window from the scheduled time during which the test should start" type = number default = 1 } variable "restore_testing_plan_scheduled_expression" { description = "Scheduled Expression of Recovery Selection Point" type = string default = "cron(0 1 ? * SUN *)" } variable "restore_testing_plan_recovery_point_types" { description = "Recovery Point Types" type = list(string) default = ["SNAPSHOT"] } variable "restore_testing_plan_selection_window_days" { description = "Selection window days" type = number default = 7 } variable "backup_copy_vault_arn" { description = "The ARN of the destination backup vault for cross-account backup copies." type = string default = "" } variable "backup_copy_vault_account_id" { description = "The account id of the destination backup vault for allowing restores back into the source account." type = string default = "" } variable "backup_plan_config" { description = "Configuration for backup plans" type = object({ enable = bool selection_tag = string compliance_resource_types = list(string) rules = list(object({ name = string schedule = string enable_continuous_backup = optional(bool) lifecycle = object({ delete_after = optional(number) cold_storage_after = optional(number) }) copy_action = optional(list(object({ delete_after = optional(number) cold_storage_after = optional(number) }))) })) }) } variable "backup_plan_config_dynamodb" { description = "Configuration for backup plans with dynamodb" type = object({ enable = bool selection_tag = string compliance_resource_types = list(string) rules = optional(list(object({ name = string schedule = string enable_continuous_backup = optional(bool) lifecycle = object({ delete_after = number cold_storage_after = optional(number) }) copy_action = optional(list(object({ delete_after = optional(number) cold_storage_after = optional(number) }))) }))) }) } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/env-custom-domain-name/000077500000000000000000000000001511201605300277255ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/env-custom-domain-name/acm.tf000066400000000000000000000007031511201605300310200ustar00rootroot00000000000000 resource "aws_acm_certificate" "certificate" { domain_name = var.domain_name subject_alternative_names = var.subject_alternative_names validation_method = "DNS" lifecycle { create_before_destroy = true } } resource "aws_acm_certificate_validation" "validation" { certificate_arn = aws_acm_certificate.certificate.arn validation_record_fqdns = [for record in aws_route53_record.route : record.fqdn] } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/env-custom-domain-name/apigateway.tf000066400000000000000000000007621511201605300324200ustar00rootroot00000000000000resource "aws_api_gateway_domain_name" "domain" { domain_name = aws_acm_certificate.certificate.domain_name regional_certificate_arn = aws_acm_certificate.certificate.arn security_policy = "TLS_1_2" endpoint_configuration { types = ["REGIONAL"] } mutual_tls_authentication { truststore_uri = var.mtls_certificate_file truststore_version = var.mtls_certificate_file_version } depends_on = [ aws_acm_certificate_validation.validation ] } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/env-custom-domain-name/route53.tf000066400000000000000000000013621511201605300315700ustar00rootroot00000000000000data "aws_route53_zone" "zone" { name = var.domain_zone private_zone = false } resource "aws_route53_record" "route" { for_each = { for dvo in aws_acm_certificate.certificate.domain_validation_options : dvo.domain_name => { name = dvo.resource_record_name record = dvo.resource_record_value type = dvo.resource_record_type } } name = each.value.name records = [each.value.record] ttl = 60 type = each.value.type zone_id = data.aws_route53_zone.zone.zone_id } resource "aws_route53_record" "cname" { zone_id = data.aws_route53_zone.zone.id name = var.domain_name type = "CNAME" ttl = "5" records = [ aws_api_gateway_domain_name.domain.regional_domain_name ] } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/env-custom-domain-name/vars.tf000066400000000000000000000012011511201605300312250ustar00rootroot00000000000000 variable "domain_zone" { description = "The Route53 zone ID for the domain" type = string } variable "subject_alternative_names" { description = "The subject alternative names for the certificate" type = list(any) default = [] } variable "domain_name" { description = "The internal DNS name of the API Gateway for the dev environment" type = string } variable "mtls_certificate_file" { description = "The path to the mtls certificate file" type = string } variable "mtls_certificate_file_version" { description = "The S3 version of the mtls certificate file" type = string } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/000077500000000000000000000000001511201605300243765ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/LogSchemaGeneration/000077500000000000000000000000001511201605300302545ustar00rootroot00000000000000LogSchemaGeneration.ipynb000066400000000000000000000277011511201605300351250ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/LogSchemaGeneration{ "cells": [ { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "import boto3\n", "from pyspark.sql.types import (\n", " StructType,\n", ")\n", "import json\n", "from datetime import datetime, timedelta\n", "from typing import List, Dict, Type, Set, Any" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# Initialize CloudWatch client\n", "session = boto3.Session(region_name=\"eu-west-2\", profile_name=\"nhsd-nrlf-dev\")\n", "client = session.client(\"logs\")" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def parse_json(log):\n", " try:\n", " return json.loads(log)\n", " except json.JSONDecodeError:\n", " return {\"raw_message\": str(log)}\n", "\n", "\n", "def fetch_cloudwatch_logs(log_group_name, start_time, end_time):\n", " logs = []\n", " next_token = None\n", " while True:\n", " if next_token:\n", " response = client.filter_log_events(\n", " logGroupName=log_group_name,\n", " startTime=int(start_time.timestamp() * 1000),\n", " endTime=int(end_time.timestamp() * 1000),\n", " nextToken=next_token,\n", " )\n", " else:\n", " response = client.filter_log_events(\n", " logGroupName=log_group_name,\n", " startTime=int(start_time.timestamp() * 1000),\n", " endTime=int(end_time.timestamp() * 1000),\n", " )\n", " for event in response[\"events\"]:\n", " logs.append(\n", " parse_json(event[\"message\"])\n", " )\n", " next_token = response.get(\"nextToken\")\n", " if not next_token:\n", " break\n", " # print(logs)\n", " return logs" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "# Example usage\n", "log_group = \"searchPostDocumentReference\"\n", "log_group_name = f\"/aws/lambda/nhsd-nrlf--dev-1--api--consumer--{log_group}\"\n", "end_time = datetime.now() - timedelta(days=25)\n", "start_time = end_time - timedelta(days=21) # Fetch logs from the last hour\n", "logs = fetch_cloudwatch_logs(log_group_name, start_time, end_time)\n", "print(len(logs))" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "print(logs)" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def checktype(obj: List):\n", " # print(obj)\n", " if obj:\n", " data_types = [type(i).__name__ for i in obj]\n", " return max(set(data_types), key=data_types.count)\n", " else:\n", " return \"str\"\n", "\n", "\n", "def _is_struct(field_type: Any) -> bool:\n", " \"\"\"Check if a field type is a struct\"\"\"\n", " return isinstance(field_type, dict) and field_type.get(\"type\") == \"struct\"\n", "\n", "\n", "def find_cols(log, prefix=\"\"):\n", " cols = {}\n", " if isinstance(log, dict):\n", " for k, v in log.items():\n", " # print(f\"k: {k}, v: {v}\")\n", " name = f\"{prefix}__{k}\" if prefix else k\n", " if isinstance(v, dict):\n", " cols.update(find_cols(v, name))\n", "\n", " if name not in cols.keys() and v:\n", " if isinstance(v, list):\n", " cols[name] = f\"list.{checktype(v)}\"\n", " temp = {}\n", " for i in v:\n", " if checktype(v) == \"dict\":\n", " for key, val in i.items():\n", " temp_name = f\"{name}__{key}\"\n", " if isinstance(val, dict):\n", " temp.update(find_cols(val, temp_name))\n", " if isinstance(val, list):\n", " temp.update(find_cols(val, temp_name))\n", " if temp_name not in temp and val:\n", " temp[temp_name] = type(val).__name__\n", " cols.update(temp)\n", "\n", " else:\n", " cols[name] = type(v).__name__\n", "\n", " elif isinstance(log, list):\n", " if prefix not in cols:\n", " cols[prefix] = f\"list.{checktype(log)}\"\n", " list_temp = {}\n", " for item in log:\n", " if checktype(log) == \"dict\":\n", " for list_key, list_val in item.items():\n", " list_temp_name = f\"{prefix}__{list_key}\"\n", " if isinstance(list_val, dict):\n", " list_temp.update(find_cols(list_val, list_temp_name))\n", " if isinstance(list_val, list):\n", " list_temp.update(find_cols(list_val, list_temp_name))\n", " if list_temp_name not in list_temp and list_val:\n", " list_temp[list_temp_name] = type(list_val).__name__\n", " cols.update(list_temp)\n", "\n", " return cols\n", "\n", "\n", "fields = {}\n", "for log in logs:\n", " fields.update(find_cols(log))\n", "\n", "print(fields)\n", "\n", "\n", "def format_schema(fields: Dict):\n", " final = {}\n", " type_mapping = {\n", " \"str\": \"string\",\n", " \"bool\": \"boolean\",\n", " \"NoneType\": None,\n", " \"int\": \"long\",\n", " \"float\": \"double\",\n", " \"dict\": {\"fields\": {}, \"type\": \"struct\"},\n", " \"list.str\": {\"type\": \"array\", \"elementType\": \"string\", \"containsNull\": True},\n", " \"list.bool\": {\"type\": \"array\", \"elementType\": \"boolean\", \"containsNull\": True},\n", " \"list.int\": {\"type\": \"array\", \"elementType\": \"long\", \"containsNull\": True},\n", " \"list.NoneType\": {\"type\": \"array\", \"elementType\": None, \"containsNull\": True},\n", " \"list.float\": {\"type\": \"array\", \"elementType\": \"double\", \"containsNull\": True},\n", " \"list.dict\": {\n", " \"type\": \"array\",\n", " \"elementType\": {\"fields\": {}, \"type\": \"struct\"},\n", " \"containsNull\": True,\n", " },\n", " }\n", "\n", " for k, v in fields.items():\n", " if v not in type_mapping:\n", " raise ValueError(\n", " f\"Unsupported type '{v}' for field '{k}'. \"\n", " f\"Allowed types : {type_mapping.keys()}\"\n", " )\n", " if \"__\" not in k: # if base level, then add accordingly\n", " if k in final.keys():\n", " if not _is_struct(final[k][\"type\"]):\n", " raise ValueError(\n", " f\"Field {k} already exists as non-struct type \"\n", " f\"({final[k]['type']}). Cannot redefine\"\n", " )\n", " else:\n", " final[k] = {\n", " \"metadata\": {},\n", " \"name\": k,\n", " \"nullable\": True,\n", " \"type\": type_mapping[v],\n", " }\n", " else: # else not base level, so form hierarchy\n", " levels = k.split(\"__\")\n", " end = len(levels) - 1\n", " hierarchy = {}\n", " for i, level in enumerate(levels): # iterate through levels\n", " if i < end:\n", " data_type = {\"fields\": {}, \"type\": \"struct\"}\n", " else:\n", " if v == \"list.dict\":\n", " data_type = {\n", " \"type\": \"array\",\n", " \"elementType\": {\"fields\": {}, \"type\": \"struct\"},\n", " \"containsNull\": True,\n", " }\n", " else:\n", " data_type = type_mapping[v]\n", " if i == 0:\n", " if level not in final.keys():\n", " final[level] = {\n", " \"metadata\": {},\n", " \"name\": level,\n", " \"nullable\": True,\n", " \"type\": data_type,\n", " }\n", "\n", " hierarchy = final[level][\"type\"][\"fields\"]\n", " else:\n", " try:\n", " if levels[i - 1] in hierarchy:\n", " if \"elementType\" not in hierarchy[levels[i - 1]][\"type\"]:\n", " hierarchy = hierarchy[levels[i - 1]][\"type\"][\"fields\"]\n", " else:\n", " hierarchy = hierarchy[levels[i - 1]][\"type\"][\n", " \"elementType\"\n", " ][\"fields\"]\n", " except:\n", " raise ValueError(f\"{hierarchy[levels[i-1]]}\")\n", " if level not in hierarchy:\n", " hierarchy[level] = {\n", " \"metadata\": {},\n", " \"name\": level,\n", " \"nullable\": True,\n", " \"type\": data_type,\n", " }\n", " data_type = None\n", "\n", " return final\n", "\n", "\n", "l = format_schema(fields)\n", "print(l)" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "def make_fields(final):\n", " for k, v in final.items():\n", " # print(f\"k: {k}, v: {v}\")\n", " parent = k\n", " if isinstance(v[\"type\"], dict):\n", " if \"elementType\" in v[\"type\"]:\n", " if isinstance(v[\"type\"][\"elementType\"], dict):\n", " fields = make_fields(v[\"type\"][\"elementType\"][\"fields\"])\n", " final[parent][\"type\"][\"elementType\"][\"fields\"] = fields\n", "\n", " elif not isinstance(v[\"type\"][\"fields\"], list):\n", " fields = make_fields(v[\"type\"][\"fields\"])\n", " final[parent][\"type\"][\"fields\"] = fields\n", "\n", " return list(final.values())\n", "\n", "\n", "jsonSchema = {\"fields\": make_fields(l), \"type\": \"struct\"}\n", "# jsonSchema" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "schema = StructType.fromJson(jsonSchema)\n", "schema" ] } ], "metadata": { "kernelspec": { "display_name": ".venv", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.12.9" } }, "nbformat": 4, "nbformat_minor": 2 } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/LogSchemaGeneration/README.md000066400000000000000000000006671511201605300315440ustar00rootroot00000000000000# Log Schema Generation The Glue script uses pyspark to process log data. Due to the structure of each json document inside of a log group differing, we need to account for this variance. The notebook provides a way to automatically generate a pyspark schema for a log group without manual intervention. Point it at the desired group, and hit run all, then copy and paste the output into either producer_schema.py or consumer_schema.py. NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/glue.tf000066400000000000000000000074671511201605300257030ustar00rootroot00000000000000# Create Glue Data Catalog Database resource "aws_glue_catalog_database" "log_database" { count = var.is_enabled ? 1 : 0 name = "${var.name_prefix}-reporting" location_uri = "${aws_s3_bucket.target-data-bucket.id}/" } # Create Glue Crawler resource "aws_glue_crawler" "log_crawler" { count = var.is_enabled ? 1 : 0 name = "${var.name_prefix}-log-crawler" database_name = aws_glue_catalog_database.log_database[0].name role = aws_iam_role.glue_service_role.name s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/consumer_countDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/consumer_readDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/consumer_searchDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/consumer_searchPostDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_createDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_deleteDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_readDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_searchDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_searchPostDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_updateDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/producer_upsertDocumentReference/" } s3_target { path = "s3://${aws_s3_bucket.target-data-bucket.id}/spine_sspDocumentRetrieval/" } schema_change_policy { delete_behavior = "LOG" } configuration = jsonencode({ "Version" : 1.0, "Grouping" : { "TableGroupingPolicy" : "CombineCompatibleSchemas" } }) } resource "aws_glue_trigger" "log_trigger" { count = var.is_enabled ? 1 : 0 name = "${var.name_prefix}-org-report-trigger" type = "ON_DEMAND" actions { crawler_name = aws_glue_crawler.log_crawler[0].name } } resource "aws_glue_trigger" "glue_trigger" { count = var.schedule && var.is_enabled ? 1 : 0 name = "${var.name_prefix}-glue-trigger" type = "SCHEDULED" schedule = "cron(0 1 * * ? *)" actions { job_name = aws_glue_job.glue_job[0].name } } resource "aws_glue_job" "glue_job" { count = var.is_enabled ? 1 : 0 name = "${var.name_prefix}-glue-job" role_arn = aws_iam_role.glue_service_role.arn description = "Transfer logs from source to bucket" glue_version = "5.0" worker_type = "G.1X" execution_class = "STANDARD" timeout = 60 # minutes max_retries = 0 number_of_workers = 4 command { name = "glueetl" python_version = var.python_version script_location = "s3://${aws_s3_bucket.code-bucket.id}/main.py" } default_arguments = { "--enable-auto-scaling" = "true" "--enable-continous-cloudwatch-log" = "true" "--datalake-formats" = "delta" "--source_path" = "s3://${aws_s3_bucket.source-data-bucket.id}/" # Specify the source S3 path "--target_path" = "s3://${aws_s3_bucket.target-data-bucket.id}/" # Specify the destination S3 path "--job_name" = "${var.name_prefix}-glue-job" "--partition_cols" = "date" "--enable-continuous-log-filter" = "true" "--enable-metrics" = "true" "--extra-py-files" = "s3://${aws_s3_bucket.code-bucket.id}/src.zip" "--enable-job-insights" = "true" "--job-language" = "python" } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/iam.tf000066400000000000000000000042271511201605300255040ustar00rootroot00000000000000resource "aws_iam_role" "glue_service_role" { name = "${var.name_prefix}-glue_service_role" assume_role_policy = jsonencode({ "Version" : "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Principal" : { "Service" : "glue.amazonaws.com" }, "Action" : "sts:AssumeRole" } ] }) } data "aws_iam_policy_document" "glue_service" { statement { actions = [ "s3:AbortMultipartUpload", "s3:GetBucketLocation", "s3:GetObject", "s3:ListBucket", "s3:ListBucketMultipartUploads", "s3:PutObject", "s3:DeleteObject", ] resources = compact([ aws_s3_bucket.source-data-bucket.arn, "${aws_s3_bucket.source-data-bucket.arn}/*", aws_s3_bucket.target-data-bucket.arn, "${aws_s3_bucket.target-data-bucket.arn}/*", aws_s3_bucket.code-bucket.arn, "${aws_s3_bucket.code-bucket.arn}/*", ]) effect = "Allow" } statement { actions = [ "kms:DescribeKey", "kms:GenerateDataKey*", "kms:Encrypt", "kms:ReEncrypt*", "kms:Decrypt", ] resources = [ aws_kms_key.glue.arn, ] effect = "Allow" } statement { actions = [ "logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents" ] resources = [ "arn:aws:logs:*:*:*:/aws-glue/*", ] effect = "Allow" } statement { actions = [ "glue:*", ] resources = [ "*" ] effect = "Allow" } statement { actions = [ "cloudwatch:Get*", "cloudwatch:List*", "cloudwatch:Put*", ] resources = [ "*" ] effect = "Allow" } statement { actions = [ "iam:PassRole", ] effect = "Allow" resources = [ "arn:aws:iam::*:role/AWSGlueServiceRole*", aws_iam_role.glue_service_role.arn, ] } } resource "aws_iam_policy" "glue_service" { name = "${var.name_prefix}-glue" policy = data.aws_iam_policy_document.glue_service.json } resource "aws_iam_role_policy_attachment" "glue_service" { role = aws_iam_role.glue_service_role.name policy_arn = aws_iam_policy.glue_service.arn } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/kms.tf000066400000000000000000000002431511201605300255220ustar00rootroot00000000000000resource "aws_kms_key" "glue" { } resource "aws_kms_alias" "glue" { name = "alias/${var.name_prefix}-glue" target_key_id = aws_kms_key.glue.key_id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/locals.tf000066400000000000000000000001001511201605300261750ustar00rootroot00000000000000locals { s3 = { expiration = { days = 1 } } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/outputs.tf000066400000000000000000000012461511201605300264570ustar00rootroot00000000000000output "target_bucket_name" { description = "Name of destination bucket" value = aws_s3_bucket.target-data-bucket.id } output "target_bucket_arn" { description = "Arn of destination bucket" value = aws_s3_bucket.target-data-bucket.arn } output "source_bucket_name" { description = "Name of source bucket" value = aws_s3_bucket.source-data-bucket.id } output "aws_kms_key_arn" { description = "Arn of kms key" value = aws_kms_key.glue.arn } output "glue_crawler_name" { value = "s3//${aws_s3_bucket.source-data-bucket.id}/" } output "glue_database" { value = var.is_enabled ? aws_glue_catalog_database.log_database[0].name : "" } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/s3.tf000066400000000000000000000114111511201605300252540ustar00rootroot00000000000000# S3 Bucket for Raw Data resource "aws_s3_bucket" "source-data-bucket" { bucket = "${var.name_prefix}-source-data-bucket" } resource "aws_s3_bucket_policy" "source-data-bucket" { bucket = "${var.name_prefix}-source-data-bucket" policy = jsonencode({ Version = "2012-10-17" Id = "source-data-bucket-policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = { "AWS" : "*" } Action = "s3:*" Resource = [ aws_s3_bucket.source-data-bucket.arn, "${aws_s3_bucket.source-data-bucket.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, ] }) } resource "aws_s3_bucket_server_side_encryption_configuration" "source-data-bucket" { bucket = aws_s3_bucket.source-data-bucket.bucket rule { apply_server_side_encryption_by_default { kms_master_key_id = aws_kms_key.glue.arn sse_algorithm = "aws:kms" } } } resource "aws_s3_bucket_public_access_block" "source-data-bucket-public-access-block" { bucket = aws_s3_bucket.source-data-bucket.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_lifecycle_configuration" "source-data-bucket-lifecycle" { bucket = aws_s3_bucket.source-data-bucket.id rule { id = "object-auto-delete-rule" status = "Enabled" expiration { days = local.s3.expiration.days } } } resource "aws_s3_bucket_versioning" "source-data-bucket-versioning" { bucket = aws_s3_bucket.source-data-bucket.id versioning_configuration { status = "Disabled" } } # S3 Bucket for Processed Data resource "aws_s3_bucket" "target-data-bucket" { bucket = "${var.name_prefix}-target-data-bucket" } resource "aws_s3_bucket_policy" "target-data-bucket" { bucket = "${var.name_prefix}-target-data-bucket" policy = jsonencode({ Version = "2012-10-17" Id = "target-data-bucket-policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = { "AWS" : "*" } Action = "s3:*" Resource = [ aws_s3_bucket.target-data-bucket.arn, "${aws_s3_bucket.target-data-bucket.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, ] }) } resource "aws_s3_bucket_server_side_encryption_configuration" "target-data-bucket" { bucket = aws_s3_bucket.target-data-bucket.bucket rule { apply_server_side_encryption_by_default { kms_master_key_id = aws_kms_key.glue.arn sse_algorithm = "aws:kms" } } } resource "aws_s3_bucket_public_access_block" "target-data-bucket-public-access-block" { bucket = aws_s3_bucket.target-data-bucket.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } # S3 Bucket for Code resource "aws_s3_bucket" "code-bucket" { bucket = "${var.name_prefix}-code-bucket" } resource "aws_s3_bucket_policy" "code-bucket" { bucket = "${var.name_prefix}-code-bucket" policy = jsonencode({ Version = "2012-10-17" Id = "code-bucket-policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = { "AWS" : "*" } Action = "s3:*" Resource = [ aws_s3_bucket.code-bucket.arn, "${aws_s3_bucket.code-bucket.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, ] }) } resource "aws_s3_bucket_server_side_encryption_configuration" "code-bucket" { bucket = aws_s3_bucket.code-bucket.bucket rule { apply_server_side_encryption_by_default { kms_master_key_id = aws_kms_key.glue.arn sse_algorithm = "aws:kms" } } } resource "aws_s3_bucket_public_access_block" "code-bucket-public-access-block" { bucket = aws_s3_bucket.code-bucket.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_object" "script" { bucket = aws_s3_bucket.code-bucket.bucket key = "main.py" source = "${path.module}/src/main.py" source_hash = filemd5("${path.module}/src/main.py") } data "archive_file" "python" { type = "zip" output_path = "${path.module}/files/src.zip" source_dir = "${path.module}/src" } resource "aws_s3_object" "zip" { bucket = aws_s3_bucket.code-bucket.bucket key = "src.zip" source = data.archive_file.python.output_path source_hash = filemd5(data.archive_file.python.output_path) } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/000077500000000000000000000000001511201605300251655ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/__init__.py000066400000000000000000000000001511201605300272640ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/consumer_schemas.py000066400000000000000000002053131511201605300311010ustar00rootroot00000000000000from pyspark.sql.types import ( ArrayType, BooleanType, DoubleType, LongType, StringType, StructField, StructType, ) searchPostDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("content-type", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("nhsd-correlation-id", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("body", StringType(), True), StructField("model", StringType(), True), StructField( "parsed_body", StructType( [ StructField("subject_identifier", StringType(), True), StructField("type", StringType(), True), StructField("custodian_identifier", StringType(), True), ] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("nhs_number", StringType(), True), StructField( "query", StructType( [ StructField("IndexName", StringType(), True), StructField( "KeyConditionExpression", StringType(), True ), StructField( "ExpressionAttributeValues", StructType( [ StructField( ":patient_key", StringType(), True ), StructField( ":patient_sort", StringType(), True ), StructField(":type_0", StringType(), True), StructField(":type_1", StringType(), True), StructField(":type_2", StringType(), True), StructField(":type_3", StringType(), True), StructField(":type_4", StringType(), True), StructField(":type_5", StringType(), True), StructField(":type_6", StringType(), True), StructField(":type_7", StringType(), True), StructField(":type_8", StringType(), True), StructField(":type_9", StringType(), True), StructField(":type_10", StringType(), True), StructField(":type_11", StringType(), True), StructField(":type_12", StringType(), True), ] ), True, ), StructField( "ReturnConsumedCapacity", StringType(), True ), StructField("FilterExpression", StringType(), True), StructField( "ExpressionAttributeNames", StructType( [ StructField( "#pointer_type", StringType(), True ) ] ), True, ), ] ), True, ), StructField("table", StringType(), True), StructField( "stats", StructType( [ StructField("count", LongType(), True), StructField("scanned_count", LongType(), True), ] ), True, ), StructField( "result", StructType( [ StructField( "Items", ArrayType( StructType( [ StructField( "nhs_number", StringType(), True ), StructField( "version", StringType(), True ), StructField( "category_id", StringType(), True ), StructField( "producer_id", StringType(), True ), StructField( "source", StringType(), True ), StructField( "patient_key", StringType(), True ), StructField( "type_id", StringType(), True ), StructField( "schemas", ArrayType(StringType(), True), True, ), StructField( "category", StringType(), True ), StructField("sk", StringType(), True), StructField( "patient_sort", StringType(), True ), StructField("id", StringType(), True), StructField("pk", StringType(), True), StructField( "document", StringType(), True ), StructField( "custodian", StringType(), True ), StructField( "author", StringType(), True ), StructField("type", StringType(), True), StructField( "created_on", StringType(), True ), StructField( "master_identifier", StringType(), True, ), StructField( "masterid_key", StringType(), True ), StructField( "updated_on", StringType(), True ), ] ), True, ), True, ), StructField("Count", LongType(), True), StructField("ScannedCount", LongType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField("Table", StructType([]), True), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField("id", StringType(), True), StructField("count", LongType(), True), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), StructField("error", StringType(), True), StructField("exception", StringType(), True), StructField("exception_name", StringType(), True), StructField( "stack_trace", StructType( [ StructField("type", StringType(), True), StructField("value", StringType(), True), StructField("module", StringType(), True), StructField( "frames", ArrayType( StructType( [ StructField("file", StringType(), True), StructField("line", LongType(), True), StructField( "function", StringType(), True ), StructField( "statement", StringType(), True ), ] ), True, ), True, ), ] ), True, ), StructField("bucket", StringType(), True), StructField("key", StringType(), True), StructField("subject_identifier", StringType(), True), StructField("type", StringType(), True), ] ), True, ), ] ) searchDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField( "params", StructType( [ StructField("subject:identifier", StringType(), True), StructField("type", StringType(), True), ] ), True, ), StructField("model", StringType(), True), StructField( "parsed_params", StructType( [ StructField("subject_identifier", StringType(), True), StructField("type", StringType(), True), ] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("nhs_number", StringType(), True), StructField( "query", StructType( [ StructField("IndexName", StringType(), True), StructField( "KeyConditionExpression", StringType(), True ), StructField( "ExpressionAttributeValues", StructType( [ StructField( ":patient_key", StringType(), True ), StructField( ":patient_sort", StringType(), True ), StructField(":type_0", StringType(), True), StructField(":type_1", StringType(), True), StructField(":type_2", StringType(), True), StructField(":type_3", StringType(), True), ] ), True, ), StructField( "ReturnConsumedCapacity", StringType(), True ), StructField("FilterExpression", StringType(), True), StructField( "ExpressionAttributeNames", StructType( [ StructField( "#pointer_type", StringType(), True ) ] ), True, ), ] ), True, ), StructField("table", StringType(), True), StructField( "stats", StructType( [ StructField("count", LongType(), True), StructField("scanned_count", LongType(), True), ] ), True, ), StructField( "result", StructType( [ StructField( "Items", ArrayType( StructType( [ StructField( "nhs_number", StringType(), True ), StructField( "version", StringType(), True ), StructField( "category_id", StringType(), True ), StructField( "producer_id", StringType(), True ), StructField( "source", StringType(), True ), StructField( "patient_key", StringType(), True ), StructField( "type_id", StringType(), True ), StructField( "schemas", ArrayType(StringType(), True), True, ), StructField( "category", StringType(), True ), StructField("sk", StringType(), True), StructField( "patient_sort", StringType(), True ), StructField("id", StringType(), True), StructField("pk", StringType(), True), StructField( "document", StringType(), True ), StructField( "custodian", StringType(), True ), StructField( "author", StringType(), True ), StructField("type", StringType(), True), StructField( "created_on", StringType(), True ), StructField( "updated_on", StringType(), True ), StructField( "master_identifier", StringType(), True, ), StructField( "masterid_key", StringType(), True ), ] ), True, ), True, ), StructField("Count", LongType(), True), StructField("ScannedCount", LongType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField("Table", StructType([]), True), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField("id", StringType(), True), StructField("count", LongType(), True), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), StructField("type", StringType(), True), ] ), True, ), ] ) readDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField( "path", StructType([StructField("id", StringType(), True)]), True, ), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("model", StringType(), True), StructField( "parsed_path", StructType([StructField("id", StringType(), True)]), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField( "result", StructType( [ StructField("id", StringType(), True), StructField("nhs_number", StringType(), True), StructField("custodian", StringType(), True), StructField("producer_id", StringType(), True), StructField("category_id", StringType(), True), StructField("category", StringType(), True), StructField("type_id", StringType(), True), StructField("type", StringType(), True), StructField("author", StringType(), True), StructField("source", StringType(), True), StructField("version", LongType(), True), StructField("document", StringType(), True), StructField("created_on", StringType(), True), StructField("pk", StringType(), True), StructField("sk", StringType(), True), StructField("patient_key", StringType(), True), StructField("patient_sort", StringType(), True), ] ), True, ), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), ] ), True, ), ] ) countDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField( "params", StructType( [StructField("subject:identifier", StringType(), True)] ), True, ), StructField("model", StringType(), True), StructField( "parsed_params", StructType( [StructField("subject_identifier", StringType(), True)] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("nhs_number", StringType(), True), StructField( "query", StructType( [ StructField("IndexName", StringType(), True), StructField( "KeyConditionExpression", StringType(), True ), StructField( "ExpressionAttributeValues", StructType( [ StructField( ":patient_key", StringType(), True ), StructField( ":patient_sort", StringType(), True ), ] ), True, ), StructField("Select", StringType(), True), StructField( "ReturnConsumedCapacity", StringType(), True ), ] ), True, ), StructField("count", LongType(), True), StructField( "result", StructType( [ StructField("Count", LongType(), True), StructField("ScannedCount", LongType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField("Table", StructType([]), True), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), ] ), True, ), ] ) consumerSchemaList = { "consumer--countDocumentReference": countDocumentReferenceSchema, "consumer--searchPostDocumentReference": searchPostDocumentReferenceSchema, "consumer--searchDocumentReference": searchDocumentReferenceSchema, "consumer--readDocumentReference": readDocumentReferenceSchema, } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/main.py000066400000000000000000000034141511201605300264650ustar00rootroot00000000000000import logging import sys from awsglue.context import GlueContext from awsglue.utils import getResolvedOptions from pipeline import LogPipeline from pyspark.sql import SparkSession from transformations import dtype_conversion, format_ssp, rename_cols, resolve_dupes # Spark and Glue Context initialization spark = SparkSession.builder.config("spark.sql.caseSensitive", "true").getOrCreate() glue_context = GlueContext(spark.sparkContext) # Logger setup MSG_FORMAT = "%(asctime)s %(levelname)s %(name)s: %(message)s" DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S" logging.basicConfig(format=MSG_FORMAT, datefmt=DATETIME_FORMAT) logger = logging.getLogger("ETLLogger") logger.setLevel(logging.INFO) # Get arguments from AWS Glue job args = getResolvedOptions( sys.argv, ["job_name", "source_path", "target_path", "partition_cols"] ) partition_cols = args["partition_cols"].split(",") if "partition_cols" in args else [] host_prefixes = [ "consumer--countDocumentReference", "consumer--searchPostDocumentReference", "consumer--searchDocumentReference", "consumer--readDocumentReference", "producer--searchPostDocumentReference", "producer--searchDocumentReference", "producer--readDocumentReference", "producer--upsertDocumentReference", "producer--updateDocumentReference", "producer--deleteDocumentReference", "producer--createDocumentReference", "s2c", ] # Initialize ETL process etl_job = LogPipeline( glue_context=glue_context, spark=spark, logger=logger, source_path=args["source_path"], target_path=args["target_path"], host_prefixes=host_prefixes, job_name=args["job_name"], partition_cols=partition_cols, transformations=[rename_cols, resolve_dupes, dtype_conversion, format_ssp], ) # Run the job etl_job.run() NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/pipeline.py000066400000000000000000000117251511201605300273520ustar00rootroot00000000000000import time import boto3 class LogPipeline: def __init__( self, glue_context, spark, logger, source_path, target_path, host_prefixes, job_name, partition_cols=[], transformations=[], ): """Initialize Glue context, Spark session, logger, and paths""" self.glue_context = glue_context self.spark = spark self.logger = logger self.source_path = source_path self.target_path = target_path self.host_prefixes = host_prefixes self.partition_cols = partition_cols self.transformations = transformations self.glue = boto3.client( service_name="glue", region_name="eu-west-2", endpoint_url="https://glue.eu-west-2.amazonaws.com", ) self.job_name = job_name self.name_prefix = "-".join(job_name.split("-")[:4]) def run(self): """Runs ETL""" try: self.logger.info("ETL Process started.") data = self.extract_dynamic() self.logger.info(f"Data extracted from {self.source_path}.") for name, df in data.items(): data[name] = self.transform(df, name) self.logger.info("Data transformed successfully.") self.load(data) self.logger.info(f"Data loaded into {self.target_path}.") self.logger.info("Trigger glue crawler") self.trigger_crawler() except Exception as e: self.logger.error(f"ETL process failed: {e}") raise e def get_last_run(self): self.logger.info("Retrieving last successful runtime.") all_runs = self.glue.get_job_runs(JobName=self.job_name) if not all_runs["JobRuns"]: return None for run in all_runs["JobRuns"]: if run["JobRunState"] == "SUCCEEDED": return time.mktime(run["StartedOn"].timetuple()) return None def extract_dynamic(self): """Extract JSON data from S3""" last_runtime = self.get_last_run() data = {} data_source = self.glue_context.getSource("s3", paths=[self.source_path]) data_source.setFormat("json") self.logger.info(f"Extracting data from {self.source_path} as JSON") for name in self.host_prefixes: if last_runtime: data[name] = self.glue_context.create_dynamic_frame.from_options( connection_type="s3", connection_options={ "paths": [self.source_path], "recurse": True, "groupFiles": "inPartition", "groupSize": "134217728", }, format="json", ).filter( f=lambda x, n=name: (x["host"] is not None and n in x["host"]) and (x["time"] > last_runtime) ) else: data[name] = self.glue_context.create_dynamic_frame.from_options( connection_type="s3", connection_options={ "paths": [self.source_path], "recurse": True, "groupFiles": "inPartition", "groupSize": "134217728", }, format="json", ).filter(f=lambda x, n=name: (x["host"] is not None and n in x["host"])) return data def transform(self, dataframe, name): """Apply a list of transformations on the dataframe""" self.spark.conf.set("spark.sql.caseSensitive", True) dataframe = ( dataframe.relationalize("root", f"./tmp/{name}").select("root").toDF() ) for transformation in self.transformations: self.logger.info(f"Applying transformation: {transformation.__name__}") dataframe = transformation(dataframe, self.logger, name) return dataframe def load(self, data): """Load transformed data into Parquet format""" self.logger.info(f"Loading data into {self.target_path} as Parquet") for name, dataframe in data.items(): name = name.replace("--", "_") if name == "s2c": name = "spine_sspDocumentRetrieval" try: if dataframe.rdd.isEmpty(): self.logger.info(f"{name} dataframe has no rows. Skipping.") continue self.logger.info( f"Attempting to load dataframe {name} into {self.target_path}{name}" ) dataframe.write.mode("append").partitionBy( *self.partition_cols ).parquet(f"{self.target_path}{name}") except Exception as e: self.logger.info(f"{name} failed to write with error: {e}") def trigger_crawler(self): self.glue.start_crawler(Name=f"{self.name_prefix}-log-crawler") NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/producer_schemas.py000066400000000000000000005747561511201605300311150ustar00rootroot00000000000000from pyspark.sql.types import ( ArrayType, BooleanType, DoubleType, LongType, StringType, StructField, StructType, ) upsertDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("content-type", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), StructField( "Nhsd-End-User-Organisation-Ods", StringType(), True ), StructField("X-Correlation-Id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), StructField( "nrl_permissions", ArrayType(StringType(), True), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("body", StringType(), True), StructField("model", StringType(), True), StructField( "parsed_body", StructType( [ StructField("resourceType", StringType(), True), StructField("id", StringType(), True), StructField("status", StringType(), True), StructField( "type", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "category", ArrayType( StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), True, ), StructField( "subject", StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True ), StructField( "value", StringType(), True ), ] ), True, ) ] ), True, ), StructField( "author", ArrayType( StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True, ), StructField( "value", StringType(), True, ), ] ), True, ) ] ), True, ), True, ), StructField( "custodian", StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True ), StructField( "value", StringType(), True ), ] ), True, ) ] ), True, ), StructField( "content", ArrayType( StructType( [ StructField( "attachment", StructType( [ StructField( "contentType", StringType(), True, ), StructField( "url", StringType(), True, ), StructField( "creation", StringType(), True, ), ] ), True, ), StructField( "format", StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), StructField( "extension", ArrayType( StructType( [ StructField( "valueCodeableConcept", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), StructField( "id", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "url", StringType(), True, ), ] ), True, ), True, ), ] ), True, ), True, ), StructField( "context", StructType( [ StructField( "practiceSetting", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "period", StructType( [ StructField( "start", StringType(), True ), StructField( "end", StringType(), True ), ] ), True, ), StructField( "related", ArrayType( StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True, ), StructField( "value", StringType(), True, ), ] ), True, ) ] ), True, ), True, ), ] ), True, ), StructField( "masterIdentifier", StructType( [ StructField("system", StringType(), True), StructField("value", StringType(), True), ] ), True, ), StructField("date", StringType(), True), ] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("resource", StringType(), True), StructField("resource_type", StringType(), True), StructField("step", StringType(), True), StructField("required_fields", ArrayType(StringType(), True), True), StructField("reason", StringType(), True), StructField("is_valid", BooleanType(), True), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField("type", StringType(), True), StructField("pointer_id", StringType(), True), StructField( "indexes", StructType( [ StructField("pk", StringType(), True), StructField("sk", StringType(), True), StructField("patient_key", StringType(), True), StructField("patient_sort", StringType(), True), StructField("masterid_key", StringType(), True), ] ), True, ), StructField("source", StringType(), True), StructField("version", LongType(), True), StructField( "result", StructType( [ StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField( "Table", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), StructField( "masterid_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), StructField( "headers", StructType( [StructField("Location", StringType(), True)] ), True, ), ] ), True, ), StructField("error", StringType(), True), StructField("exception", StringType(), True), StructField("exception_name", StringType(), True), StructField( "stack_trace", StructType( [ StructField("type", StringType(), True), StructField("value", StringType(), True), StructField("module", StringType(), True), StructField( "frames", ArrayType( StructType( [ StructField("file", StringType(), True), StructField("line", LongType(), True), StructField( "function", StringType(), True ), StructField( "statement", StringType(), True ), ] ), True, ), True, ), ] ), True, ), StructField("bucket", StringType(), True), StructField("key", StringType(), True), StructField("ods_code", StringType(), True), StructField("id", StringType(), True), StructField("date", StringType(), True), ] ), True, ), ] ) updateDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField( "path", StructType([StructField("id", StringType(), True)]), True, ), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("content-type", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("body", StringType(), True), StructField("model", StringType(), True), StructField( "parsed_body", StructType( [ StructField("resourceType", StringType(), True), StructField("id", StringType(), True), StructField("status", StringType(), True), StructField( "type", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "category", ArrayType( StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), True, ), StructField( "subject", StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True ), StructField( "value", StringType(), True ), ] ), True, ) ] ), True, ), StructField( "author", ArrayType( StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True, ), StructField( "value", StringType(), True, ), ] ), True, ) ] ), True, ), True, ), StructField( "custodian", StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True ), StructField( "value", StringType(), True ), ] ), True, ) ] ), True, ), StructField( "content", ArrayType( StructType( [ StructField( "attachment", StructType( [ StructField( "contentType", StringType(), True, ), StructField( "url", StringType(), True, ), StructField( "creation", StringType(), True, ), ] ), True, ), StructField( "format", StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), StructField( "extension", ArrayType( StructType( [ StructField( "valueCodeableConcept", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "url", StringType(), True, ), ] ), True, ), True, ), ] ), True, ), True, ), StructField( "context", StructType( [ StructField( "practiceSetting", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "period", StructType( [ StructField( "start", StringType(), True ) ] ), True, ), StructField( "related", ArrayType( StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True, ), StructField( "value", StringType(), True, ), ] ), True, ) ] ), True, ), True, ), ] ), True, ), StructField("date", StringType(), True), ] ), True, ), StructField( "parsed_path", StructType([StructField("id", StringType(), True)]), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("resource_type", StringType(), True), StructField("step", StringType(), True), StructField("required_fields", ArrayType(StringType(), True), True), StructField("reason", StringType(), True), StructField("is_valid", BooleanType(), True), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField("type", StringType(), True), StructField( "result", StructType( [ StructField("id", StringType(), True), StructField("nhs_number", StringType(), True), StructField("custodian", StringType(), True), StructField("producer_id", StringType(), True), StructField("category_id", StringType(), True), StructField("category", StringType(), True), StructField("type_id", StringType(), True), StructField("type", StringType(), True), StructField("author", StringType(), True), StructField("source", StringType(), True), StructField("version", LongType(), True), StructField("document", StringType(), True), StructField("created_on", StringType(), True), StructField("pk", StringType(), True), StructField("sk", StringType(), True), StructField("patient_key", StringType(), True), StructField("patient_sort", StringType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField( "Table", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), StructField("updated_on", StringType(), True), ] ), True, ), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), StructField("field", StringType(), True), StructField("provided", StringType(), True), ] ), True, ), ] ) searchPostDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("content-type", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("body", StringType(), True), StructField("model", StringType(), True), StructField( "parsed_body", StructType( [ StructField("subject_identifier", StringType(), True), StructField("type", StringType(), True), ] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("custodian", StringType(), True), StructField("nhs_number", StringType(), True), StructField("expression", StringType(), True), StructField("values", ArrayType(StringType(), True), True), StructField( "query", StructType( [ StructField("IndexName", StringType(), True), StructField( "KeyConditionExpression", StringType(), True ), StructField( "ExpressionAttributeValues", StructType( [ StructField( ":patient_key", StringType(), True ), StructField( ":patient_sort", StringType(), True ), StructField( ":custodian", StringType(), True ), StructField(":type_0", StringType(), True), StructField(":type_1", StringType(), True), StructField(":type_2", StringType(), True), StructField(":type_3", StringType(), True), StructField(":type_4", StringType(), True), StructField(":type_5", StringType(), True), StructField(":type_6", StringType(), True), StructField(":type_7", StringType(), True), StructField(":type_8", StringType(), True), StructField(":type_9", StringType(), True), StructField(":type_10", StringType(), True), StructField(":type_11", StringType(), True), StructField(":type_12", StringType(), True), ] ), True, ), StructField( "ReturnConsumedCapacity", StringType(), True ), StructField("FilterExpression", StringType(), True), StructField( "ExpressionAttributeNames", StructType( [ StructField( "#pointer_type", StringType(), True ) ] ), True, ), ] ), True, ), StructField("table", StringType(), True), StructField( "stats", StructType( [ StructField("count", LongType(), True), StructField("scanned_count", LongType(), True), ] ), True, ), StructField( "result", StructType( [ StructField( "Items", ArrayType( StructType( [ StructField( "nhs_number", StringType(), True ), StructField( "version", StringType(), True ), StructField( "category_id", StringType(), True ), StructField( "producer_id", StringType(), True ), StructField( "source", StringType(), True ), StructField( "patient_key", StringType(), True ), StructField( "type_id", StringType(), True ), StructField( "schemas", ArrayType(StringType(), True), True, ), StructField( "category", StringType(), True ), StructField("sk", StringType(), True), StructField( "patient_sort", StringType(), True ), StructField("id", StringType(), True), StructField("pk", StringType(), True), StructField( "document", StringType(), True ), StructField( "custodian", StringType(), True ), StructField( "author", StringType(), True ), StructField("type", StringType(), True), StructField( "created_on", StringType(), True ), StructField( "updated_on", StringType(), True ), StructField( "master_identifier", StringType(), True, ), StructField( "masterid_key", StringType(), True ), ] ), True, ), True, ), StructField("Count", LongType(), True), StructField("ScannedCount", LongType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField("Table", StructType([]), True), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("id", StringType(), True), StructField("count", LongType(), True), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), ] ), True, ), ] ) searchDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField( "params", StructType( [ StructField("subject:identifier", StringType(), True), StructField("type", StringType(), True), ] ), True, ), StructField("model", StringType(), True), StructField( "parsed_params", StructType( [ StructField("subject_identifier", StringType(), True), StructField("type", StringType(), True), ] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("custodian", StringType(), True), StructField("nhs_number", StringType(), True), StructField("expression", StringType(), True), StructField("values", ArrayType(StringType(), True), True), StructField( "query", StructType( [ StructField("IndexName", StringType(), True), StructField( "KeyConditionExpression", StringType(), True ), StructField( "ExpressionAttributeValues", StructType( [ StructField( ":patient_key", StringType(), True ), StructField( ":patient_sort", StringType(), True ), StructField( ":custodian", StringType(), True ), StructField(":type_0", StringType(), True), StructField(":type_1", StringType(), True), StructField(":type_2", StringType(), True), StructField(":type_3", StringType(), True), ] ), True, ), StructField( "ReturnConsumedCapacity", StringType(), True ), StructField("FilterExpression", StringType(), True), StructField( "ExpressionAttributeNames", StructType( [ StructField( "#pointer_type", StringType(), True ) ] ), True, ), ] ), True, ), StructField("table", StringType(), True), StructField( "stats", StructType( [ StructField("count", LongType(), True), StructField("scanned_count", LongType(), True), ] ), True, ), StructField( "result", StructType( [ StructField( "Items", ArrayType( StructType( [ StructField( "nhs_number", StringType(), True ), StructField( "version", StringType(), True ), StructField( "category_id", StringType(), True ), StructField( "producer_id", StringType(), True ), StructField( "source", StringType(), True ), StructField( "patient_key", StringType(), True ), StructField( "type_id", StringType(), True ), StructField( "schemas", ArrayType(StringType(), True), True, ), StructField( "category", StringType(), True ), StructField("sk", StringType(), True), StructField( "patient_sort", StringType(), True ), StructField("id", StringType(), True), StructField("pk", StringType(), True), StructField( "document", StringType(), True ), StructField( "custodian", StringType(), True ), StructField( "author", StringType(), True ), StructField("type", StringType(), True), StructField( "created_on", StringType(), True ), StructField( "master_identifier", StringType(), True, ), StructField( "masterid_key", StringType(), True ), ] ), True, ), True, ), StructField("Count", LongType(), True), StructField("ScannedCount", LongType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField("Table", StructType([]), True), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("id", StringType(), True), StructField("count", LongType(), True), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), StructField("type", StringType(), True), ] ), True, ), ] ) readDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField( "path", StructType([StructField("id", StringType(), True)]), True, ), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("model", StringType(), True), StructField( "parsed_path", StructType([StructField("id", StringType(), True)]), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField( "result", StructType( [ StructField("id", StringType(), True), StructField("nhs_number", StringType(), True), StructField("custodian", StringType(), True), StructField("producer_id", StringType(), True), StructField("category_id", StringType(), True), StructField("category", StringType(), True), StructField("type_id", StringType(), True), StructField("type", StringType(), True), StructField("author", StringType(), True), StructField("source", StringType(), True), StructField("version", LongType(), True), StructField("document", StringType(), True), StructField("created_on", StringType(), True), StructField("pk", StringType(), True), StructField("sk", StringType(), True), StructField("patient_key", StringType(), True), StructField("patient_sort", StringType(), True), ] ), True, ), ] ), True, ), ] ) deleteDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField( "path", StructType([StructField("id", StringType(), True)]), True, ), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("model", StringType(), True), StructField( "parsed_path", StructType([StructField("id", StringType(), True)]), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField( "result", StructType( [ StructField("id", StringType(), True), StructField("nhs_number", StringType(), True), StructField("custodian", StringType(), True), StructField("producer_id", StringType(), True), StructField("category_id", StringType(), True), StructField("category", StringType(), True), StructField("type_id", StringType(), True), StructField("type", StringType(), True), StructField("author", StringType(), True), StructField("source", StringType(), True), StructField("version", LongType(), True), StructField("document", StringType(), True), StructField("created_on", StringType(), True), StructField("pk", StringType(), True), StructField("sk", StringType(), True), StructField("patient_key", StringType(), True), StructField("patient_sort", StringType(), True), StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField( "Table", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ) ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), StructField("updated_on", StringType(), True), ] ), True, ), StructField("partition_key", StringType(), True), StructField("sort_key", StringType(), True), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), ] ), True, ), StructField("pointer_id", StringType(), True), ] ), True, ), ] ) createDocumentReferenceSchema = StructType( [ StructField("raw_message", StringType(), True), StructField("time", DoubleType(), True), StructField("index", StringType(), True), StructField("host", StringType(), True), StructField("source", StringType(), True), StructField( "event", StructType( [ StructField("level", StringType(), True), StructField("location", StringType(), True), StructField("message", StringType(), True), StructField("timestamp", StringType(), True), StructField("service", StringType(), True), StructField("cold_start", BooleanType(), True), StructField("function_name", StringType(), True), StructField("function_memory_size", StringType(), True), StructField("function_arn", StringType(), True), StructField("function_request_id", StringType(), True), StructField("correlation_id", StringType(), True), StructField("method", StringType(), True), StructField("path", StringType(), True), StructField( "headers", StructType( [ StructField("accept", StringType(), True), StructField("accept-encoding", StringType(), True), StructField("Authorization", StringType(), True), StructField("content-type", StringType(), True), StructField("Host", StringType(), True), StructField( "NHSD-Client-RP-Details", StringType(), True ), StructField( "NHSD-Connection-Metadata", StringType(), True ), StructField("NHSD-Correlation-Id", StringType(), True), StructField("User-Agent", StringType(), True), StructField("X-Forwarded-For", StringType(), True), StructField("X-Request-Id", StringType(), True), StructField("NHSD-Correlation-ID", StringType(), True), StructField( "NHSD-End-User-Organisation-ODS", StringType(), True ), StructField("NHSD-Request-ID", StringType(), True), StructField("X-Forwarded-Port", StringType(), True), StructField("X-Forwarded-Proto", StringType(), True), StructField("cache-control", StringType(), True), StructField("Postman-Token", StringType(), True), StructField("x-correlation-id", StringType(), True), StructField("x-request-id", StringType(), True), ] ), True, ), StructField("log_reference", StringType(), True), StructField("xray_trace_id", StringType(), True), StructField( "config", StructType( [ StructField("AWS_REGION", StringType(), True), StructField("PREFIX", StringType(), True), StructField("ENVIRONMENT", StringType(), True), StructField("SPLUNK_INDEX", StringType(), True), StructField("SOURCE", StringType(), True), StructField("AUTH_STORE", StringType(), True), StructField("TABLE_NAME", StringType(), True), ] ), True, ), StructField( "metadata", StructType( [ StructField("ods_code", StringType(), True), StructField("nrl_app_id", StringType(), True), StructField( "client_rp_details", StructType( [ StructField( "developer_app_name", StringType(), True ), StructField( "developer_app_id", StringType(), True ), ] ), True, ), ] ), True, ), StructField("pointer_types", ArrayType(StringType(), True), True), StructField("body", StringType(), True), StructField("model", StringType(), True), StructField( "parsed_body", StructType( [ StructField("resourceType", StringType(), True), StructField("status", StringType(), True), StructField( "type", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "category", ArrayType( StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), True, ), StructField( "subject", StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True ), StructField( "value", StringType(), True ), ] ), True, ) ] ), True, ), StructField( "author", ArrayType( StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True, ), StructField( "value", StringType(), True, ), ] ), True, ) ] ), True, ), True, ), StructField( "custodian", StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True ), StructField( "value", StringType(), True ), ] ), True, ) ] ), True, ), StructField( "content", ArrayType( StructType( [ StructField( "attachment", StructType( [ StructField( "contentType", StringType(), True, ), StructField( "url", StringType(), True, ), StructField( "creation", StringType(), True, ), StructField( "size", LongType(), True ), ] ), True, ), StructField( "format", StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), StructField( "extension", ArrayType( StructType( [ StructField( "valueCodeableConcept", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "url", StringType(), True, ), ] ), True, ), True, ), ] ), True, ), True, ), StructField( "context", StructType( [ StructField( "practiceSetting", StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), StructField( "period", StructType( [ StructField( "start", StringType(), True ), StructField( "end", StringType(), True ), ] ), True, ), StructField( "related", ArrayType( StructType( [ StructField( "identifier", StructType( [ StructField( "system", StringType(), True, ), StructField( "value", StringType(), True, ), ] ), True, ) ] ), True, ), True, ), StructField( "event", ArrayType( StructType( [ StructField( "coding", ArrayType( StructType( [ StructField( "system", StringType(), True, ), StructField( "code", StringType(), True, ), StructField( "display", StringType(), True, ), ] ), True, ), True, ) ] ), True, ), True, ), ] ), True, ), StructField("id", StringType(), True), StructField( "meta", StructType( [StructField("lastUpdated", StringType(), True)] ), True, ), StructField( "masterIdentifier", StructType( [ StructField("system", StringType(), True), StructField("value", StringType(), True), ] ), True, ), StructField( "identifier", ArrayType( StructType( [ StructField( "type", StructType( [ StructField( "text", StringType(), True, ) ] ), True, ), StructField( "value", StringType(), True ), ] ), True, ), True, ), StructField("date", StringType(), True), StructField( "relatesTo", ArrayType( StructType( [ StructField("code", StringType(), True), StructField( "target", StructType( [ StructField( "type", StringType(), True, ), StructField( "identifier", StructType( [ StructField( "value", StringType(), True, ) ] ), True, ), ] ), True, ), ] ), True, ), True, ), ] ), True, ), StructField("table_name", StringType(), True), StructField("item_type", StringType(), True), StructField("original_kwargs_keys", StringType(), True), StructField("filtered_kwargs_keys", StringType(), True), StructField("resource", StringType(), True), StructField("resource_type", StringType(), True), StructField("step", StringType(), True), StructField("required_fields", ArrayType(StringType(), True), True), StructField("reason", StringType(), True), StructField("is_valid", BooleanType(), True), StructField("producer_id", StringType(), True), StructField("document_id", StringType(), True), StructField("custodian", StringType(), True), StructField("type", StringType(), True), StructField("pointer_id", StringType(), True), StructField( "indexes", StructType( [ StructField("pk", StringType(), True), StructField("sk", StringType(), True), StructField("patient_key", StringType(), True), StructField("patient_sort", StringType(), True), StructField("masterid_key", StringType(), True), ] ), True, ), StructField("source", StringType(), True), StructField("version", LongType(), True), StructField( "result", StructType( [ StructField( "ConsumedCapacity", StructType( [ StructField( "TableName", StringType(), True ), StructField( "CapacityUnits", DoubleType(), True ), StructField( "Table", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), StructField( "GlobalSecondaryIndexes", StructType( [ StructField( "patient_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), StructField( "masterid_gsi", StructType( [ StructField( "CapacityUnits", DoubleType(), True, ) ] ), True, ), ] ), True, ), ] ), True, ), StructField( "ResponseMetadata", StructType( [ StructField( "RequestId", StringType(), True ), StructField( "HTTPStatusCode", LongType(), True ), StructField( "HTTPHeaders", StructType( [ StructField( "server", StringType(), True ), StructField( "date", StringType(), True ), StructField( "content-type", StringType(), True, ), StructField( "content-length", StringType(), True, ), StructField( "connection", StringType(), True, ), StructField( "x-amzn-requestid", StringType(), True, ), StructField( "x-amz-crc32", StringType(), True, ), ] ), True, ), ] ), True, ), ] ), True, ), StructField("status_code", StringType(), True), StructField( "response", StructType( [ StructField("statusCode", StringType(), True), StructField("body", StringType(), True), StructField( "headers", StructType( [StructField("Location", StringType(), True)] ), True, ), ] ), True, ), StructField("error", StringType(), True), StructField("ods_code", StringType(), True), StructField("relatesTo", ArrayType(StringType(), True), True), StructField("related_identifier", StringType(), True), ] ), True, ), ] ) producerSchemaList = { "producer--searchPostDocumentReference": searchPostDocumentReferenceSchema, "producer--searchDocumentReference": searchDocumentReferenceSchema, "producer--readDocumentReference": readDocumentReferenceSchema, "producer--upsertDocumentReference": upsertDocumentReferenceSchema, "producer--updateDocumentReference": updateDocumentReferenceSchema, "producer--deleteDocumentReference": deleteDocumentReferenceSchema, "producer--createDocumentReference": createDocumentReferenceSchema, } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/src/transformations.py000066400000000000000000000102641511201605300307730ustar00rootroot00000000000000from collections import defaultdict from functools import reduce from pyspark.sql.functions import ( coalesce, col, concat, from_unixtime, lit, regexp_replace, to_date, to_timestamp, when, ) from pyspark.sql.types import NullType def format_ssp(df, logger, name): if name != "s2c": logger.info(f"Not SSP logs, returning df: {name}") return df if df.rdd.isEmpty(): logger.info(f"{name} dataframe has no rows. Skipping format_ssp.") return df logger.info("Processing SSP logs") no_ods_code = df.filter(col("logReference") != "SSP0001").select( "time", "host", "internalID", "logReference", "interaction", "responseCode", "responseErrorMessage", "totalDuration", ) ods_code = df.filter(col("logReference") == "SSP0001").select( "sspFrom", "fromOrgName", "fromOdsCode", "fromPostCode", "sspTo", "toOrgName", "toOdsCode", "toPostCode", "internalID", ) df = no_ods_code.join(ods_code, on="internalID", how="left") return df def resolve_dupes(df, logger, name): if df.rdd.isEmpty(): logger.info(f"{name} dataframe has no rows. Skipping resolve_dupes.") return df column_groups = defaultdict(list) for column_name in df.columns: normalised_name = column_name.lower().rstrip("_") column_groups[normalised_name].append(column_name) final_select_exprs = [] for lower_name, original_names in column_groups.items(): if len(original_names) == 1: final_select_exprs.append(col(original_names[0]).alias(lower_name)) else: logger.info( f"Resolving duplicate group '{lower_name}': {original_names} for df: {name}" ) merge_logic = lambda col1, col2: when( col1.isNull() | col2.isNull(), coalesce(col1, col2) ).otherwise(concat(col1, lit(", "), col2)) merged_column_expr = reduce(merge_logic, [col(c) for c in original_names]) final_select_exprs.append(merged_column_expr.alias(lower_name)) return df.select(*final_select_exprs) def rename_cols(df, logger, name): if df.rdd.isEmpty(): logger.info(f"{name} dataframe has no rows. Skipping rename_cols.") return df logger.info(f"Replacing '.' with '_' for df: {name}") for col_name in df.columns: df = df.withColumnRenamed(col_name, col_name.replace(".", "_")) return df def dtype_conversion(df, logger, name): if df.rdd.isEmpty(): logger.info(f"{name} dataframe has no rows. Skipping dtype_conversion.") return df try: logger.info(f"Formatting event_timestamp, time and date columns for df: {name}") if "event_timestamp" in df.columns: df = df.withColumn( "event_timestamp_cleaned", regexp_replace(col("event_timestamp"), ",", "."), ).withColumn( "event_timestamp", to_timestamp( col("event_timestamp_cleaned"), "yyyy-MM-dd HH:mm:ss.SSSZ" ), ) df = df.drop("event_timestamp_cleaned") if "time" in df.columns: df = df.withColumn( "time", from_unixtime(col("time")).cast("timestamp") ).withColumn("date", to_date(col("time"))) if "_time" in df.columns: df = df.withColumn( "time", to_timestamp(col("_time"), "yyyy-MM-dd HH:mm:ss.SSSZ") ).withColumn("date", to_date(col("time"))) df = df.drop("_time") except Exception as e: logger.info(f"Failed formatting of timestamp columns with error: {e}") logger.info("Handling Null Type columns") select_exprs = [] for column_name in df.columns: column_type = df.schema[column_name].dataType if isinstance(column_type, NullType): logger.info(f"Converting {column_name} to string") select_exprs.append(col(column_name).cast("string").alias(column_name)) else: select_exprs.append(col(column_name)) return df.select(*select_exprs) NRLF-3.0.31/terraform/account-wide-infrastructure/modules/glue/vars.tf000066400000000000000000000014541511201605300257100ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "python_version" { type = number description = "Python version to run in script" } variable "source_bucket" { description = "S3 bucket for source data" default = "source-data-bucket" } variable "target_bucket" { description = "S3 bucket for target data" default = "target-data-bucket" } variable "code_bucket" { description = "S3 bucket for Glue job scripts" default = "code-bucket" } variable "is_enabled" { type = bool description = "Flag to enable or disable the Glue module" default = true } variable "schedule" { type = bool description = "Flag to enable or disable the Glue schedule" default = false } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/000077500000000000000000000000001511201605300305475ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/cloudwatch.tf000066400000000000000000000011371511201605300332410ustar00rootroot00000000000000resource "aws_cloudwatch_metric_alarm" "metric_alarm" { alarm_name = "${var.name_prefix}--lambda-errors-metric-alarm" alarm_description = "This metric monitors the number of Lambda errors that have occurred" alarm_actions = [aws_sns_topic.sns_topic.arn] comparison_operator = "GreaterThanOrEqualToThreshold" evaluation_periods = var.evaluation_periods threshold = var.threshold unit = "Count" metric_name = "Errors" namespace = "AWS/Lambda" period = var.period statistic = "Sum" datapoints_to_alarm = 1 } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/iam.tf000066400000000000000000000023151511201605300316510ustar00rootroot00000000000000resource "aws_iam_policy" "lambda-errors-topic-kms-read-write" { name = "${var.name_prefix}-lambda-errors-topic-kms-read-write" description = "Encrypt and decrypt with the lambda errors sns topic kms key" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey", "kms:Encrypt", "kms:GenerateDataKey" ] Effect = "Allow" Resource = [ aws_kms_key.lambda-errors-topic-key.arn, aws_cloudwatch_metric_alarm.metric_alarm.arn ] } ] }) } data "aws_caller_identity" "current" {} data "aws_iam_policy_document" "sns_kms_key_policy" { policy_id = "CloudWatchEncryptUsingKey" statement { effect = "Allow" actions = [ "kms:*" ] resources = ["*"] principals { type = "AWS" identifiers = ["arn:aws:iam::${data.aws_caller_identity.current.account_id}:root"] } } statement { effect = "Allow" actions = [ "kms:Decrypt", "kms:GenerateDataKey" ] resources = ["*"] principals { type = "Service" identifiers = ["cloudwatch.amazonaws.com"] } } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/kms.tf000066400000000000000000000007111511201605300316730ustar00rootroot00000000000000resource "aws_kms_key" "lambda-errors-topic-key" { description = "Lambda errors SNS topic table KMS key" deletion_window_in_days = var.kms_deletion_window_in_days policy = data.aws_iam_policy_document.sns_kms_key_policy.json } resource "aws_kms_alias" "lambda-errors-topic-alias" { name = "alias/${var.name_prefix}-lambda-errors-topic-table-key" target_key_id = aws_kms_key.lambda-errors-topic-key.key_id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/output.tf000066400000000000000000000002511511201605300324400ustar00rootroot00000000000000output "cloudwatch_metric_alarm_arn" { description = "The ARN of the Cloudwatch metric alarm." value = try(aws_cloudwatch_metric_alarm.metric_alarm.arn, "") } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/sns.tf000066400000000000000000000006151511201605300317070ustar00rootroot00000000000000resource "aws_sns_topic" "sns_topic" { name = "${var.name_prefix}--lambda-errors-sns-topic" kms_master_key_id = aws_kms_key.lambda-errors-topic-key.key_id } resource "aws_sns_topic_subscription" "sns_subscription" { count = length(var.notification_emails) topic_arn = aws_sns_topic.sns_topic.arn protocol = "email" endpoint = var.notification_emails[count.index] } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/lambda-errors-metric-alarm/vars.tf000066400000000000000000000016631511201605300320630ustar00rootroot00000000000000variable "evaluation_periods" { description = "The number of periods over which data is compared to the specified threshold." type = number } variable "threshold" { description = "The value against which the specified statistic is compared." type = number default = null } variable "period" { description = "The period in seconds over which the specified statistic is applied." type = string default = null } variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "kms_deletion_window_in_days" { type = number description = "The duration in days after which the key is deleted after destruction of the resource." default = 7 } variable "notification_emails" { type = list(string) sensitive = true description = "The email addresses to which notifications will be sent." default = [] } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/permissions-store-bucket/000077500000000000000000000000001511201605300304225ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/permissions-store-bucket/iam.tf000066400000000000000000000010121511201605300315150ustar00rootroot00000000000000resource "aws_iam_policy" "read-s3-authorization-store" { name = "${var.name_prefix}-read-s3-authorization-store" description = "Read the authorization store S3 bucket" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "s3:GetObject", "s3:ListBucket", ] Effect = "Allow" Resource = [ aws_s3_bucket.authorization-store.arn, "${aws_s3_bucket.authorization-store.arn}/*", ] }, ] }) } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/permissions-store-bucket/output.tf000066400000000000000000000004661511201605300323230ustar00rootroot00000000000000output "bucket_arn" { description = "Name of the authorization store S3 bucket" value = aws_s3_bucket.authorization-store.arn } output "bucket_read_policy_arn" { description = "Policy to read from the authorization store S3 bucket" value = aws_iam_policy.read-s3-authorization-store.arn } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/permissions-store-bucket/s3.tf000066400000000000000000000031511511201605300313020ustar00rootroot00000000000000resource "aws_s3_bucket" "authorization-store" { bucket = "${var.name_prefix}-authorization-store" force_destroy = var.enable_bucket_force_destroy tags = { Name = "authorization store" Environment = "${var.name_prefix}" NHSE-Enable-S3-Backup = var.enable_backups ? "True" : "False" } } resource "aws_s3_bucket_public_access_block" "authorization-store-public-access-block" { bucket = aws_s3_bucket.authorization-store.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "authorization-store" { bucket = aws_s3_bucket.authorization-store.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "AES256" } } } resource "aws_s3_bucket_policy" "authorization_store_bucket_policy" { bucket = aws_s3_bucket.authorization-store.id policy = jsonencode({ Version = "2012-10-17" Id = "authorization_store_bucket_policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = "*" Action = "s3:*" Resource = [ aws_s3_bucket.authorization-store.arn, "${aws_s3_bucket.authorization-store.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, ] }) } resource "aws_s3_bucket_versioning" "authorization-store" { bucket = aws_s3_bucket.authorization-store.id versioning_configuration { status = "Enabled" } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/permissions-store-bucket/vars.tf000066400000000000000000000007331511201605300317330ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "enable_bucket_force_destroy" { type = bool description = "A boolean flag to enable force destroy of the S3 bucket, so that all objects in the bucket are deleted when the bucket is destroyed." default = false } variable "enable_backups" { type = bool description = "enable AWS cloud backups" default = false } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/pointers-table/000077500000000000000000000000001511201605300263725ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/pointers-table/dynamodb.tf000066400000000000000000000021571511201605300305270ustar00rootroot00000000000000resource "aws_dynamodb_table" "pointers" { name = "${var.name_prefix}-pointers-table" billing_mode = "PAY_PER_REQUEST" hash_key = "pk" range_key = "sk" deletion_protection_enabled = var.enable_deletion_protection attribute { name = "pk" type = "S" } attribute { name = "sk" type = "S" } attribute { name = "patient_key" type = "S" } attribute { name = "patient_sort" type = "S" } attribute { name = "masterid_key" type = "S" } global_secondary_index { name = "patient_gsi" hash_key = "patient_key" range_key = "patient_sort" projection_type = "ALL" } global_secondary_index { name = "masterid_gsi" hash_key = "masterid_key" projection_type = "ALL" } server_side_encryption { enabled = true kms_key_arn = aws_kms_key.pointers-table-key.arn } point_in_time_recovery { enabled = var.enable_pitr } tags = { NHSE-Enable-DDB-Backup = var.enable_backups ? "True" : "False" } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/pointers-table/iam.tf000066400000000000000000000035271511201605300275020ustar00rootroot00000000000000resource "aws_iam_policy" "pointers-table-read" { name = "${var.name_prefix}-pointers-table-read" description = "Read the pointers table" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey" ] Effect = "Allow" Resource = [ aws_kms_key.pointers-table-key.arn ] }, { Effect = "Allow" Action = [ "dynamodb:Query", "dynamodb:Scan", "dynamodb:GetItem", ], Resource = [ "${aws_dynamodb_table.pointers.arn}*" ] } ] }) } resource "aws_iam_policy" "pointers-table-write" { name = "${var.name_prefix}-pointers-table-write" description = "Write to the pointers table" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Encrypt", "kms:GenerateDataKey" ] Effect = "Allow" Resource = [ aws_kms_key.pointers-table-key.arn ] }, { Effect = "Allow" Action = [ "dynamodb:PutItem", "dynamodb:UpdateItem", "dynamodb:DeleteItem", ], Resource = [ "${aws_dynamodb_table.pointers.arn}*" ] } ] }) } resource "aws_iam_policy" "pointers-kms-read-write" { name = "${var.name_prefix}-pointers-kms-read-write" description = "Encrypt and decrypt with the pointers table kms key" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey", "kms:Encrypt", "kms:GenerateDataKey" ] Effect = "Allow" Resource = [ aws_kms_key.pointers-table-key.arn ] } ] }) } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/pointers-table/kms.tf000066400000000000000000000005301511201605300275150ustar00rootroot00000000000000resource "aws_kms_key" "pointers-table-key" { description = "Document pointers table KMS key" deletion_window_in_days = var.kms_deletion_window_in_days } resource "aws_kms_alias" "pointers-table-alias" { name = "alias/${var.name_prefix}-pointers-table-key" target_key_id = aws_kms_key.pointers-table-key.key_id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/pointers-table/output.tf000066400000000000000000000006231511201605300302660ustar00rootroot00000000000000output "table_name" { description = "Name of the pointers table" value = aws_dynamodb_table.pointers.name } output "read_policy_arn" { description = "Policy to read from the pointers table" value = aws_iam_policy.pointers-table-read.arn } output "write_policy_arn" { description = "Policy to write to the pointers table" value = aws_iam_policy.pointers-table-write.arn } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/pointers-table/vars.tf000066400000000000000000000013241511201605300277000ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "enable_deletion_protection" { type = bool description = "Enable deletion protection for the DynamoDB table." default = false } variable "enable_pitr" { type = bool description = "Enable point-in-time recovery for the DynamoDB table." default = false } variable "kms_deletion_window_in_days" { type = number description = "The duration in days after which the key is deleted after destruction of the resource." default = 7 } variable "enable_backups" { type = bool description = "Enable AwS cloud backup" default = false } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/000077500000000000000000000000001511201605300261735ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/data.tf000066400000000000000000000005531511201605300274420ustar00rootroot00000000000000data "aws_ami" "windows-2019" { most_recent = true owners = ["amazon"] filter { name = "name" values = ["Windows_Server-2019-English-Full-Base*"] } } data "aws_ami" "PowerBI_Gateway" { count = var.use_custom_ami ? 1 : 0 most_recent = true owners = ["self"] filter { name = "name" values = ["PowerBI_GW"] } } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/ec2.tf000066400000000000000000000050731511201605300272040ustar00rootroot00000000000000resource "aws_instance" "powerbi_gw" { associate_public_ip_address = false iam_instance_profile = aws_iam_instance_profile.powerbi_profile.name ami = local.selected_ami_id instance_type = var.instance_type key_name = aws_key_pair.ec2_key_pair.key_name subnet_id = var.subnet_id vpc_security_group_ids = var.security_groups root_block_device { volume_size = 40 volume_type = "gp2" } user_data = file("${path.module}/scripts/user_data.tpl") tags = { Name = "${var.name_prefix}-ec2" PatchGroup = local.windows_patching_tag } } resource "aws_ssm_maintenance_window" "updates" { name = "windows-updates" schedule = "cron(0 2 ? * MON *)" # Monday 2am UTC duration = 3 cutoff = 1 } resource "aws_ssm_maintenance_window_target" "windows_instances" { window_id = aws_ssm_maintenance_window.updates.id resource_type = "INSTANCE" targets { key = "tag:PatchGroup" values = [local.windows_patching_tag] } } resource "aws_ssm_maintenance_window_task" "patch_task" { window_id = aws_ssm_maintenance_window.updates.id task_type = "RUN_COMMAND" task_arn = "AWS-RunPatchBaseline" priority = 1 max_concurrency = 1 max_errors = 1 service_role_arn = aws_iam_role.maintenance_window_role.arn targets { key = "WindowTargetIds" values = [aws_ssm_maintenance_window_target.windows_instances.id] } task_invocation_parameters { run_command_parameters { parameter { name = "Operation" values = ["Install"] } } } } resource "aws_iam_role" "maintenance_window_role" { name = "maintenance-window-role" assume_role_policy = jsonencode({ Version = "2012-10-17" Statement = [{ Action = "sts:AssumeRole" Effect = "Allow" Principal = { Service = "ssm.amazonaws.com" } }] }) } resource "aws_iam_role_policy_attachment" "maintenance_window_policy" { role = aws_iam_role.maintenance_window_role.name policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonSSMMaintenanceWindowRole" } resource "tls_private_key" "instance_key_pair" { algorithm = "RSA" } resource "aws_key_pair" "ec2_key_pair" { key_name = "${var.name_prefix}_PowerBI-GateWay-Key" public_key = tls_private_key.instance_key_pair.public_key_openssh } resource "local_file" "ssh_key_priv" { filename = "${path.module}/keys/${aws_key_pair.ec2_key_pair.key_name}.pem" content = tls_private_key.instance_key_pair.private_key_pem } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/iam.tf000066400000000000000000000042531511201605300273000ustar00rootroot00000000000000resource "aws_iam_role" "ec2_service_role" { name = "${var.name_prefix}-ec2_service_role" assume_role_policy = jsonencode({ "Version" : "2012-10-17", "Statement" : [ { "Effect" : "Allow", "Principal" : { "Service" : "ec2.amazonaws.com" }, "Action" : "sts:AssumeRole" } ] }) } data "aws_iam_policy_document" "ec2_service" { statement { actions = [ "s3:GetBucketLocation", "s3:GetObject", "s3:ListBucket", "s3:ListBucketMultipartUploads", "s3:ListMultipartUploadParts", "s3:AbortMultipartUpload", "s3:CreateBucket", "s3:PutObject", "s3:PutBucketPublicAccessBlock" ] resources = compact([ var.target_bucket_arn, "${var.target_bucket_arn}/*", var.athena_bucket_arn, "${var.athena_bucket_arn}/*", ]) effect = "Allow" } statement { actions = [ "s3:ListBucket", "s3:GetBucketLocation", "s3:ListAllMyBuckets" ] resources = compact([ "*" ]) effect = "Allow" } statement { actions = [ "kms:DescribeKey", "kms:GenerateDataKey*", "kms:Encrypt", "kms:ReEncrypt*", "kms:Decrypt", ] resources = [ var.glue_kms_key_arn, var.athena_kms_key_arn, ] effect = "Allow" } statement { actions = [ "athena:*", ] effect = "Allow" resources = [ "*" ] } statement { actions = [ "glue:*", ] effect = "Allow" resources = [ "*" ] } } resource "aws_iam_policy" "ec2_service" { name = "${var.name_prefix}-ec2" policy = data.aws_iam_policy_document.ec2_service.json } resource "aws_iam_role_policy_attachment" "ec2_role_policy" { role = aws_iam_role.ec2_service_role.name policy_arn = aws_iam_policy.ec2_service.arn } resource "aws_iam_role_policy_attachment" "ec2_role_policy_ssm" { role = aws_iam_role.ec2_service_role.name policy_arn = "arn:aws:iam::aws:policy/AmazonSSMManagedInstanceCore" } resource "aws_iam_instance_profile" "powerbi_profile" { name = "${var.name_prefix}-powerbi_instance_profile" role = aws_iam_role.ec2_service_role.name } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/locals.tf000066400000000000000000000002611511201605300300020ustar00rootroot00000000000000locals { selected_ami_id = var.use_custom_ami ? data.aws_ami.PowerBI_Gateway[0].id : data.aws_ami.windows-2019.id windows_patching_tag = "windows_scheduled_patching" } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/outputs.tf000066400000000000000000000002021511201605300302430ustar00rootroot00000000000000output "instance_id" { description = "The ID of the PowerBI Gateway EC2 instance." value = aws_instance.powerbi_gw.id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/scripts/000077500000000000000000000000001511201605300276625ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/scripts/user_data.tpl000066400000000000000000000035261511201605300323600ustar00rootroot00000000000000 Install-WindowsFeature -name Web-Server -IncludeManagementTools $instanceId = (Invoke-WebRequest -Uri http://169.254.169.254/latest/meta-data/instance-id -UseBasicParsing).content $instanceAZ = (Invoke-WebRequest -Uri http://169.254.169.254/latest/meta-data/placement/availability-zone -UseBasicParsing).content $pubHostName = (Invoke-WebRequest -Uri http://169.254.169.254/latest/meta-data/public-hostname -UseBasicParsing).content $pubIPv4 = (Invoke-WebRequest -Uri http://169.254.169.254/latest/meta-data/public-ipv4 -UseBasicParsing).content $privHostName = (Invoke-WebRequest -Uri http://169.254.169.254/latest/meta-data/local-hostname -UseBasicParsing).content $privIPv4 = (Invoke-WebRequest -Uri http://169.254.169.254/latest/meta-data/local-ipv4 -UseBasicParsing).content New-Item -Path C:\inetpub\wwwroot\index.html -ItemType File -Force Add-Content -Path C:\inetpub\wwwroot\index.html "" Add-Content -Path C:\inetpub\wwwroot\index.html "

AWS Windows VM Deployed with Terraform

" Add-Content -Path C:\inetpub\wwwroot\index.html "
EC2 Instance Metadata
" Add-Content -Path C:\inetpub\wwwroot\index.html "
Instance ID: $instanceId
" Add-Content -Path C:\inetpub\wwwroot\index.html "
AWS Availablity Zone: $instanceAZ
" Add-Content -Path C:\inetpub\wwwroot\index.html "
Public Hostname: $pubHostName
" Add-Content -Path C:\inetpub\wwwroot\index.html "
Public IPv4: $pubIPv4
" Add-Content -Path C:\inetpub\wwwroot\index.html "
Private Hostname: $privHostName
" Add-Content -Path C:\inetpub\wwwroot\index.html "
Private IPv4: $privIPv4
" Add-Content -Path C:\inetpub\wwwroot\index.html "" NRLF-3.0.31/terraform/account-wide-infrastructure/modules/powerbi-gw-ec2/vars.tf000066400000000000000000000004111511201605300274750ustar00rootroot00000000000000variable "name_prefix" {} variable "instance_type" {} variable "security_groups" {} variable "subnet_id" {} variable "glue_kms_key_arn" {} variable "athena_kms_key_arn" {} variable "target_bucket_arn" {} variable "athena_bucket_arn" {} variable "use_custom_ami" {} NRLF-3.0.31/terraform/account-wide-infrastructure/modules/role-policy/000077500000000000000000000000001511201605300257005ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/role-policy/main.tf000066400000000000000000000004411511201605300271560ustar00rootroot00000000000000resource "aws_iam_policy" "policy" { name = var.name policy = jsonencode({ Version = "2012-10-17" Statement = var.iam_permissions }) } resource "aws_iam_role_policy_attachment" "policy_attachment" { role = var.role_name policy_arn = aws_iam_policy.policy.arn } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/role-policy/vars.tf000066400000000000000000000001111511201605300271770ustar00rootroot00000000000000variable "name" {} variable "role_name" {} variable "iam_permissions" {} NRLF-3.0.31/terraform/account-wide-infrastructure/modules/truststore-bucket/000077500000000000000000000000001511201605300271535ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/truststore-bucket/output.tf000066400000000000000000000007151511201605300310510ustar00rootroot00000000000000output "bucket_name" { description = "Name of the truststore S3 bucket" value = aws_s3_bucket.api_truststore.bucket } output "certificates_object_key" { description = "Key of the truststore certificates object" value = aws_s3_object.api_truststore_certificate.key } output "certificates_object_version" { description = "Version of the truststore certificates object" value = aws_s3_object.api_truststore_certificate.version_id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/truststore-bucket/s3.tf000066400000000000000000000032431511201605300300350ustar00rootroot00000000000000resource "aws_s3_bucket" "api_truststore" { bucket = "${var.name_prefix}-api-truststore" force_destroy = var.enable_bucket_force_destroy tags = { NHSE-Enable-S3-Backup = var.enable_backups ? "True" : "False" } } resource "aws_s3_bucket_policy" "api_truststore_bucket_policy" { bucket = aws_s3_bucket.api_truststore.id policy = jsonencode({ Version = "2012-10-17" Id = "api_truststore_bucket_policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = "*" Action = "s3:*" Resource = [ aws_s3_bucket.api_truststore.arn, "${aws_s3_bucket.api_truststore.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, ] }) } resource "aws_s3_bucket_public_access_block" "api-truststore-public-access-block" { bucket = aws_s3_bucket.api_truststore.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "api_truststore" { bucket = aws_s3_bucket.api_truststore.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "AES256" } } } resource "aws_s3_bucket_versioning" "api_truststore" { bucket = aws_s3_bucket.api_truststore.id versioning_configuration { status = "Enabled" } } resource "aws_s3_object" "api_truststore_certificate" { bucket = aws_s3_bucket.api_truststore.bucket key = "certificates.pem" source = var.server_certificate_file etag = filemd5(var.server_certificate_file) } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/truststore-bucket/vars.tf000066400000000000000000000011251511201605300304600ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "server_certificate_file" { type = string description = "The path to the server certificate file." } variable "enable_bucket_force_destroy" { type = bool description = "A boolean flag to enable force destroy of the S3 bucket, so that all objects in the bucket are deleted when the bucket is destroyed." default = false } variable "enable_backups" { type = bool description = "enable AWS cloud backups" default = false } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/vpc/000077500000000000000000000000001511201605300242325ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/modules/vpc/outputs.tf000066400000000000000000000003351511201605300263110ustar00rootroot00000000000000output "subnet_id" { value = aws_subnet.public_subnet.id } output "private_subnet_id" { value = aws_subnet.private_subnet.id } output "powerbi_gw_security_group_id" { value = aws_security_group.powerbi_gw_sg.id } NRLF-3.0.31/terraform/account-wide-infrastructure/modules/vpc/vars.tf000066400000000000000000000003111511201605300255330ustar00rootroot00000000000000variable "aws_azs" {} variable "enable_dns_hostnames" {} variable "vpc_cidr_block" {} variable "vpc_public_subnets_cidr_block" {} variable "vpc_private_subnets_cidr_block" {} variable "name_prefix" {} NRLF-3.0.31/terraform/account-wide-infrastructure/modules/vpc/vpc.tf000066400000000000000000000037211511201605300253600ustar00rootroot00000000000000resource "aws_vpc" "app_vpc" { cidr_block = var.vpc_cidr_block enable_dns_hostnames = var.enable_dns_hostnames tags = { Name = "${var.name_prefix}-vpc" } } resource "aws_internet_gateway" "igw" { vpc_id = aws_vpc.app_vpc.id tags = { Name = "${var.name_prefix}-igw" } } resource "aws_subnet" "public_subnet" { vpc_id = aws_vpc.app_vpc.id cidr_block = var.vpc_public_subnets_cidr_block map_public_ip_on_launch = true availability_zone = var.aws_azs tags = { Name = "${var.name_prefix}-pubsubnet" } } resource "aws_subnet" "private_subnet" { vpc_id = aws_vpc.app_vpc.id cidr_block = var.vpc_private_subnets_cidr_block availability_zone = var.aws_azs tags = { Name = "${var.name_prefix}-privsubnet" } } resource "aws_route_table" "public_rt" { vpc_id = aws_vpc.app_vpc.id route { cidr_block = "0.0.0.0/0" gateway_id = aws_internet_gateway.igw.id } } resource "aws_route_table" "private_rt" { vpc_id = aws_vpc.app_vpc.id route { cidr_block = "0.0.0.0/0" nat_gateway_id = aws_nat_gateway.nat.id } } resource "aws_eip" "natgw-ip" { } resource "aws_nat_gateway" "nat" { allocation_id = aws_eip.natgw-ip.id subnet_id = aws_subnet.public_subnet.id tags = { Name = "${var.name_prefix}-nat" } } resource "aws_route_table_association" "public_rt_asso" { subnet_id = aws_subnet.public_subnet.id route_table_id = aws_route_table.public_rt.id } resource "aws_route_table_association" "private_rt_asso" { subnet_id = aws_subnet.private_subnet.id route_table_id = aws_route_table.private_rt.id } resource "aws_security_group" "powerbi_gw_sg" { name = "powerbi-gw-sg" description = "Only allow egress traffic" vpc_id = aws_vpc.app_vpc.id egress { from_port = 0 to_port = 0 protocol = "-1" cidr_blocks = ["0.0.0.0/0"] ipv6_cidr_blocks = ["::/0"] } } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/000077500000000000000000000000001511201605300227365ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/prod/.terraform-version000066400000000000000000000000061511201605300264170ustar00rootroot000000000000001.9.8 NRLF-3.0.31/terraform/account-wide-infrastructure/prod/athena.tf000066400000000000000000000005101511201605300245250ustar00rootroot00000000000000module "prod-athena" { count = var.enable_reporting ? 1 : 0 source = "../modules/athena" name_prefix = "nhsd-nrlf--prod" target_bucket_name = module.prod-glue.target_bucket_name bucket_region = data.aws_region.current.region glue_database = module.prod-glue.glue_database } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/aws-backup.tf000066400000000000000000000120731511201605300253310ustar00rootroot00000000000000 resource "aws_s3_bucket" "backup_reports" { bucket_prefix = "${local.prefix}-backup-reports" } resource "aws_s3_bucket_public_access_block" "backup_reports" { bucket = aws_s3_bucket.backup_reports.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "backup_reports" { bucket = aws_s3_bucket.backup_reports.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "AES256" } } } resource "aws_s3_bucket_policy" "backup_reports_bucket_policy" { bucket = aws_s3_bucket.backup_reports.id policy = jsonencode({ Version = "2012-10-17" Id = "backup_reports_bucket_policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = "*" Action = "s3:*" Resource = [ aws_s3_bucket.backup_reports.arn, "${aws_s3_bucket.backup_reports.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, { Sid = "AllowBackupReportsWrite" Effect = "Allow" Principal = { AWS = "arn:aws:iam::${local.account_id}:role/aws-service-role/reports.backup.amazonaws.com/AWSServiceRoleForBackupReports" } Action = "s3:PutObject" Resource = [ "${aws_s3_bucket.backup_reports.arn}/*", ] Condition = { StringEquals = { "s3:x-amz-acl" = "bucket-owner-full-control" } } } ] }) } resource "aws_s3_bucket_ownership_controls" "backup_reports" { bucket = aws_s3_bucket.backup_reports.id rule { object_ownership = "BucketOwnerPreferred" } } resource "aws_s3_bucket_acl" "backup_reports" { depends_on = [aws_s3_bucket_ownership_controls.backup_reports] bucket = aws_s3_bucket.backup_reports.id acl = "private" } resource "aws_kms_key" "backup_notifications" { description = "KMS key for AWS Backup notifications" deletion_window_in_days = 7 enable_key_rotation = true policy = jsonencode({ Version = "2012-10-17" Statement = [ { Effect = "Allow" Sid = "Enable IAM User Permissions" Principal = { AWS = "arn:aws:iam::${var.assume_account}:root" } Action = "kms:*" Resource = "*" }, { Effect = "Allow" Principal = { Service = "sns.amazonaws.com" } Action = ["kms:GenerateDataKey*", "kms:Decrypt"] Resource = "*" }, { Effect = "Allow" Principal = { Service = "backup.amazonaws.com" } Action = ["kms:GenerateDataKey*", "kms:Decrypt"] Resource = "*" }, ] }) } module "source" { source = "../modules/backup-source" backup_copy_vault_account_id = jsondecode(data.aws_secretsmanager_secret_version.backup_destination_parameters.secret_string)["account-id"] backup_copy_vault_arn = jsondecode(data.aws_secretsmanager_secret_version.backup_destination_parameters.secret_string)["vault-arn"] environment_name = local.environment bootstrap_kms_key_arn = aws_kms_key.backup_notifications.arn project_name = "${local.prefix}-" reports_bucket = aws_s3_bucket.backup_reports.bucket terraform_role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" notification_target_email_addresses = local.notification_emails backup_plan_config = { "compliance_resource_types" : [ "S3" ], "enable" : true, "rules" : [ { "copy_action" : [{ "delete_after" : 30, }], "lifecycle" : { "delete_after" : 2 }, "name" : "daily_kept_for_30", "schedule" : "cron(0 0 * * ? *)" } ], "selection_tag" : "NHSE-Enable-S3-Backup" } backup_plan_config_dynamodb = { "compliance_resource_types" : [ "DynamoDB" ], "enable" : true, "rules" : [ { "name" : "daily", "schedule" : "cron(0 0 * * ? *)", "copy_action" : [{ "delete_after" : 28, }], "lifecycle" : { "delete_after" : 2 } }, { "name" : "monthly" "schedule" : "cron(30 0 ? * 4#1)" # first Thursday each month from 00:30 "copy_action" : [{ "cold_storage_after" : 35, "delete_after" : 400 # ensures 1 from previous restore test }], "lifecycle" : { "delete_after" : 2 } }, { "name" : "weekly" # overlaps with monthly "schedule" : "cron(30 0 ? * 4)" # every Thursday from 00:30 to precede releases "copy_action" : [{ "cold_storage_after" : 14 # ensures 2 warm including one from previous release "delete_after" : 15 * 7 }], "lifecycle" : { "delete_after" : 2 } } ], "selection_tag" : "NHSE-Enable-DDB-Backup" } } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/cloudwatch.tf000066400000000000000000000004211511201605300254230ustar00rootroot00000000000000module "lambda_errors_cloudwatch_metric_alarm_dev" { source = "../modules/lambda-errors-metric-alarm" name_prefix = "nhsd-nrlf--prod" notification_emails = local.notification_emails evaluation_periods = 1 period = 60 threshold = 1 } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/data.tf000066400000000000000000000012271511201605300242040ustar00rootroot00000000000000data "aws_region" "current" {} data "aws_caller_identity" "current" {} data "aws_secretsmanager_secret_version" "identities_account_id" { secret_id = aws_secretsmanager_secret.identities_account_id.name } data "aws_secretsmanager_secret" "emails" { name = "${local.prefix}-emails" } data "aws_secretsmanager_secret_version" "emails" { secret_id = data.aws_secretsmanager_secret.emails.id } data "aws_secretsmanager_secret_version" "backup_destination_parameters" { secret_id = aws_secretsmanager_secret.backup_destination_parameters.name } data "external" "current-info" { program = [ "bash", "../../../scripts/get-current-info.sh", ] } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/domain.tf000066400000000000000000000010171511201605300245370ustar00rootroot00000000000000 module "dev-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.prod_api_domain_name domain_zone = aws_route53_zone.prod-ns.name mtls_certificate_file = "s3://${module.prod-truststore-bucket.bucket_name}/${module.prod-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.prod-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.prod-ns] } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/dynamodb__pointers-table.tf000066400000000000000000000004411511201605300302340ustar00rootroot00000000000000module "prod-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--prod" enable_deletion_protection = true enable_pitr = true kms_deletion_window_in_days = 30 enable_backups = true } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/ec2.tf000066400000000000000000000022451511201605300237450ustar00rootroot00000000000000module "vpc" { count = var.enable_reporting && var.enable_powerbi_auto_push ? 1 : 0 source = "../modules/vpc" vpc_cidr_block = var.vpc_cidr_block enable_dns_hostnames = var.enable_dns_hostnames vpc_public_subnets_cidr_block = var.vpc_public_subnets_cidr_block vpc_private_subnets_cidr_block = var.vpc_private_subnets_cidr_block aws_azs = var.aws_azs name_prefix = "nhsd-nrlf--prod" } module "powerbi_gw_instance" { count = var.enable_reporting && var.enable_powerbi_auto_push ? 1 : 0 source = "../modules/powerbi-gw-ec2" use_custom_ami = var.use_powerbi_gw_custom_ami instance_type = var.powerbi_gw_instance_type name_prefix = "nhsd-nrlf--prod-powerbi-gw" target_bucket_arn = module.prod-glue.target_bucket_arn glue_kms_key_arn = module.prod-glue.aws_kms_key_arn athena_kms_key_arn = module.prod-athena[0].kms_key_arn athena_bucket_arn = module.prod-athena[0].bucket_arn subnet_id = module.vpc[0].private_subnet_id security_groups = [module.vpc[0].powerbi_gw_security_group_id] } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/etc/000077500000000000000000000000001511201605300235115ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/prod/etc/prod.tfvars000066400000000000000000000000001511201605300256720ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/prod/glue.tf000066400000000000000000000002661511201605300242310ustar00rootroot00000000000000module "prod-glue" { is_enabled = var.enable_reporting source = "../modules/glue" name_prefix = "nhsd-nrlf--prod" schedule = true python_version = 3 } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/iam__api-gateway-to-cloudwatch.tf000066400000000000000000000015141511201605300312420ustar00rootroot00000000000000resource "aws_iam_role" "api_gateway_to_cloudwatch" { name = "${local.prefix}--api-gateway-cloudwatch-logs" assume_role_policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = "sts:AssumeRole" Effect = "Allow" Principal = { "Service" : "apigateway.amazonaws.com" } } ] }) } resource "aws_iam_role_policy_attachment" "api_gateway_to_cloudwatch" { role = aws_iam_role.api_gateway_to_cloudwatch.name policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs" depends_on = [ aws_iam_role.api_gateway_to_cloudwatch ] } resource "aws_api_gateway_account" "api_gateway_account" { cloudwatch_role_arn = aws_iam_role.api_gateway_to_cloudwatch.arn depends_on = [ aws_iam_role.api_gateway_to_cloudwatch ] } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/iam__ops-role.tf000066400000000000000000000052761511201605300260300ustar00rootroot00000000000000resource "aws_iam_role" "ops_role" { name = "NHSDOpsRole" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { AWS : "arn:aws:iam::${data.aws_secretsmanager_secret_version.identities_account_id.secret_string}:root" }, Effect : "Allow" } ] }) } module "ops_role_read_only_resources" { source = "../modules/role-policy" name = "${local.prefix}--ops-read-only" role_name = aws_iam_role.ops_role.name iam_permissions = [ { Action = [ "acm:Describe*", "acm:Get*", "acm:List*", "cloudwatch:Describe*", "cloudwatch:Get*", "cloudwatch:List*", "dynamodb:BatchGet*", "dynamodb:Describe*", "dynamodb:Get*", "dynamodb:List*", "dynamodb:Query", "dynamodb:Scan", "events:Describe*", "events:List*", "events:Test*", "firehose:Describe*", "firehose:List*", "iam:Generate*", "iam:Get*", "iam:List*", "iam:Simulate*", "kinesis:Describe*", "kinesis:Get*", "kinesis:List*", "logs:Describe*", "logs:Get*", "logs:FilterLogEvents", "logs:ListTagsLogGroup", "logs:TestMetricFilter", "rds:Describe*", "rds:List*", "rds:Download*", "route53:Get*", "route53:List*", "route53:Test*", "secretsmanager:List*", "secretsmanager:Describe*", "secretsmanager:GetResourcePolicy", "sns:Get*", "sns:List*", "sns:Check*", "ssm:Describe*", "ssm:Get*", "ssm:List*", "tag:Get*", "apigateway:GET*" ] Effect = "Allow" Resource = [ "*" ] }, { Action = [ "s3:Get*", "s3:List*", "s3:Head*" ] Effect = "Allow" Resource = [ "*" ] }, { Action = [ "kms:Describe*", "kms:Get*", "kms:List*", "kms:GenerateDataKey*", "kms:Encrypt", "kms:ReEncrypt*", "kms:Decrypt", ] Effect = "Allow" Resource = [ "*" ] }, { Action = [ "sqs:Get*", "sqs:List*", ] Effect = "Allow" Resource = [ "*" ] }, { Action = [ "glue:Get*", "glue:List*", "glue:BatchGet*" ] Effect = "Allow" Resource = [ "*" ] }, { Action = [ "lambda:List*", "lambda:Get*" ] Effect = "Allow" Resource = [ "*" ] } ] } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/locals.tf000066400000000000000000000005051511201605300245460ustar00rootroot00000000000000locals { region = "eu-west-2" project = "nhsd-nrlf" environment = terraform.workspace prefix = "${local.project}--${local.environment}" account_id = data.aws_caller_identity.current.account_id notification_emails = tolist(jsondecode(data.aws_secretsmanager_secret_version.emails.secret_string)) } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/main.tf000066400000000000000000000015131511201605300242150ustar00rootroot00000000000000provider "aws" { region = local.region assume_role { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } default_tags { tags = { project_name = local.project workspace = terraform.workspace } } } provider "awscc" { region = local.region assume_role = { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } } terraform { backend "s3" { encrypt = false region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-account-wide-infrastructure" workspace_key_prefix = "nhsd-nrlf" } required_providers { aws = { source = "hashicorp/aws" version = "~> 6.0" } } } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/outputs.tf000066400000000000000000000016731511201605300250230ustar00rootroot00000000000000output "powerbi_gw_instance_id" { description = "The ID of the PowerBI Gateway EC2 instance." value = var.enable_powerbi_auto_push ? module.powerbi_gw_instance[0].instance_id : null } output "reporting_database_name" { description = "Name of the reporting Athena database" value = var.enable_reporting ? module.prod-glue.glue_database : null } output "athena_workgroup_name" { description = "Name of the Athena workgroup" value = var.enable_reporting ? module.prod-athena[0].workgroup_name : null } output "athena_s3_output_location" { description = "S3 output location for Athena queries" value = var.enable_reporting ? "s3://${module.prod-athena[0].bucket.id}/" : null } output "athena_kms_key_arn" { description = "KMS key ARN for Athena encryption" value = var.enable_reporting ? module.prod-athena[0].kms_key_arn : null } output "version" { value = data.external.current-info.result.version } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/route53.tf000066400000000000000000000001301511201605300245710ustar00rootroot00000000000000resource "aws_route53_zone" "prod-ns" { name = "api.record-locator.national.nhs.uk" } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/s3.tf000066400000000000000000000006221511201605300236160ustar00rootroot00000000000000module "prod-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--prod" enable_backups = true } module "prod-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--prod" server_certificate_file = "../../../truststore/server/prod.pem" enable_backups = true } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/secrets.tf000066400000000000000000000030631511201605300247430ustar00rootroot00000000000000resource "aws_secretsmanager_secret" "identities_account_id" { name = "${local.prefix}--nhs-identities-account-id" } resource "aws_secretsmanager_secret" "prod_smoke_test_apigee_app" { name = "${local.prefix}--prod--apigee-app--smoke-test" description = "APIGEE App used to run Smoke Tests against the PROD environment" } resource "aws_secretsmanager_secret" "prod_smoke_test_parameters" { name = "${local.project}--prod--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the prod environment" } resource "aws_secretsmanager_secret" "prod_splunk_configuration" { name = "${local.project}--prod--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_prod index" } resource "aws_secretsmanager_secret" "prod_environment_configuration" { name = "${local.project}--prod--env-config" description = "The environment configuration for the Prod environment" } resource "aws_secretsmanager_secret" "powerbi_gw_instance_admin_pwd" { name = "${local.project}--prod-powerbi-gw-instance-admin-pwd" description = "Admin password for the PowerBI Gateway EC2 instance" } resource "aws_secretsmanager_secret" "powerbi_gw_recovery_key" { name = "${local.project}--prod-powerbi-gw-recovery-key" description = "Recovery key for the PowerBI Gateway EC2 instance" } resource "aws_secretsmanager_secret" "backup_destination_parameters" { name = "${local.prefix}--backup-destination-parameters" description = "Parameters used to configure the backup destination" } NRLF-3.0.31/terraform/account-wide-infrastructure/prod/vars.tf000066400000000000000000000031471511201605300242510ustar00rootroot00000000000000variable "assume_account" { sensitive = true } variable "assume_role" {} variable "prod_api_domain_name" { description = "The internal DNS name of the API Gateway for the prod environment" default = "prod.api.record-locator.national.nhs.uk" } variable "aws_azs" { type = string description = "AWS Availability Zones" default = "eu-west-2a" } variable "enable_dns_hostnames" { type = bool description = "Enable DNS hostnames in VPC" default = true } variable "enable_reporting" { type = bool description = "Enable account-wide reporting processes in the prod account" default = true } variable "vpc_cidr_block" { type = string description = "Base CIDR Block for VPC" default = "10.0.0.0/16" } variable "vpc_public_subnets_cidr_block" { type = string description = "CIDR Block for Public Subnets in VPC" default = "10.0.0.0/24" } variable "vpc_private_subnets_cidr_block" { type = string description = "CIDR Block for Private Subnets in VPC" default = "10.0.1.0/24" } variable "instance_type" { type = string description = "Type for EC2 Instance" default = "t2.micro" } variable "enable_powerbi_auto_push" { type = bool description = "Enable automatic pushing of info into PowerBI" default = true } variable "powerbi_gw_instance_type" { type = string description = "Type for PowerBI GW EC2 Instance" default = "t2.medium" } variable "use_powerbi_gw_custom_ami" { type = bool description = "Use custom image for PowerBI GW instance" default = true } NRLF-3.0.31/terraform/account-wide-infrastructure/test/000077500000000000000000000000001511201605300227515ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/test/.terraform-version000066400000000000000000000000061511201605300264320ustar00rootroot000000000000001.9.8 NRLF-3.0.31/terraform/account-wide-infrastructure/test/athena.tf000066400000000000000000000005101511201605300245400ustar00rootroot00000000000000module "test-athena" { count = var.enable_reporting ? 1 : 0 source = "../modules/athena" name_prefix = "nhsd-nrlf--test" target_bucket_name = module.test-glue.target_bucket_name bucket_region = data.aws_region.current.region glue_database = module.test-glue.glue_database } NRLF-3.0.31/terraform/account-wide-infrastructure/test/aws-backup.tf000066400000000000000000000120671511201605300253470ustar00rootroot00000000000000 resource "aws_s3_bucket" "backup_reports" { bucket_prefix = "${local.prefix}-backup-reports" } resource "aws_s3_bucket_public_access_block" "backup_reports" { bucket = aws_s3_bucket.backup_reports.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "backup_reports" { bucket = aws_s3_bucket.backup_reports.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "AES256" } } } resource "aws_s3_bucket_policy" "backup_reports_bucket_policy" { bucket = aws_s3_bucket.backup_reports.id policy = jsonencode({ Version = "2012-10-17" Id = "backup_reports_bucket_policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = "*" Action = "s3:*" Resource = [ aws_s3_bucket.backup_reports.arn, "${aws_s3_bucket.backup_reports.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, { Sid = "AllowBackupReportsWrite" Effect = "Allow" Principal = { AWS = "arn:aws:iam::${local.account_id}:role/aws-service-role/reports.backup.amazonaws.com/AWSServiceRoleForBackupReports" } Action = "s3:PutObject" Resource = [ "${aws_s3_bucket.backup_reports.arn}/*", ] Condition = { StringEquals = { "s3:x-amz-acl" = "bucket-owner-full-control" } } } ] }) } resource "aws_s3_bucket_ownership_controls" "backup_reports" { bucket = aws_s3_bucket.backup_reports.id rule { object_ownership = "BucketOwnerPreferred" } } resource "aws_s3_bucket_acl" "backup_reports" { depends_on = [aws_s3_bucket_ownership_controls.backup_reports] bucket = aws_s3_bucket.backup_reports.id acl = "private" } resource "aws_kms_key" "backup_notifications" { description = "KMS key for AWS Backup notifications" deletion_window_in_days = 7 enable_key_rotation = true policy = jsonencode({ Version = "2012-10-17" Statement = [ { Effect = "Allow" Sid = "Enable IAM User Permissions" Principal = { AWS = "arn:aws:iam::${var.assume_account}:root" } Action = "kms:*" Resource = "*" }, { Effect = "Allow" Principal = { Service = "sns.amazonaws.com" } Action = ["kms:GenerateDataKey*", "kms:Decrypt"] Resource = "*" }, { Effect = "Allow" Principal = { Service = "backup.amazonaws.com" } Action = ["kms:GenerateDataKey*", "kms:Decrypt"] Resource = "*" }, ] }) } module "source" { source = "../modules/backup-source" backup_copy_vault_account_id = jsondecode(data.aws_secretsmanager_secret_version.backup_destination_parameters.secret_string)["account-id"] backup_copy_vault_arn = jsondecode(data.aws_secretsmanager_secret_version.backup_destination_parameters.secret_string)["vault-arn"] environment_name = local.environment bootstrap_kms_key_arn = aws_kms_key.backup_notifications.arn project_name = "${local.prefix}-" reports_bucket = aws_s3_bucket.backup_reports.bucket terraform_role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" notification_target_email_addresses = local.notification_emails backup_plan_config = { "compliance_resource_types" : [ "S3" ], "enable" : true, "rules" : [ { "copy_action" : [{ "delete_after" : 4, }], "lifecycle" : { "delete_after" : 2 }, "name" : "daily_kept_for_2_days", "schedule" : "cron(0 0 * * ? *)" } ], "selection_tag" : "NHSE-Enable-S3-Backup" } backup_plan_config_dynamodb = { "compliance_resource_types" : [ "DynamoDB" ], "enable" : true, "rules" : [ { "name" : "daily", "schedule" : "cron(0 0 * * ? *)", "copy_action" : [{ "delete_after" : 4, }], "lifecycle" : { "delete_after" : 2 } }, { "name" : "monthly" "schedule" : "cron(30 0 ? * 4#1)" # first Thursday each month from 00:30 "copy_action" : [{ "cold_storage_after" : 3, "delete_after" : 100 # ensures there will always be min 3 }], "lifecycle" : { "delete_after" : 2 } }, { "name" : "weekly" # overlaps with monthly "schedule" : "cron(30 0 ? * 4)" # every Thursday from 00:30 to precede releases "copy_action" : [{ "cold_storage_after" : 14 # ensures 2 warm including one from previous release "delete_after" : 105 }], "lifecycle" : { "delete_after" : 2 } } ], "selection_tag" : "NHSE-Enable-DDB-Backup" } } NRLF-3.0.31/terraform/account-wide-infrastructure/test/cloudwatch.tf000066400000000000000000000004211511201605300254360ustar00rootroot00000000000000module "lambda_errors_cloudwatch_metric_alarm_dev" { source = "../modules/lambda-errors-metric-alarm" name_prefix = "nhsd-nrlf--test" notification_emails = local.notification_emails evaluation_periods = 1 period = 60 threshold = 1 } NRLF-3.0.31/terraform/account-wide-infrastructure/test/data.tf000066400000000000000000000012271511201605300242170ustar00rootroot00000000000000data "aws_region" "current" {} data "aws_caller_identity" "current" {} data "aws_secretsmanager_secret_version" "identities_account_id" { secret_id = aws_secretsmanager_secret.identities_account_id.name } data "aws_secretsmanager_secret" "emails" { name = "${local.prefix}-emails" } data "aws_secretsmanager_secret_version" "emails" { secret_id = data.aws_secretsmanager_secret.emails.id } data "aws_secretsmanager_secret_version" "backup_destination_parameters" { secret_id = aws_secretsmanager_secret.backup_destination_parameters.name } data "external" "current-info" { program = [ "bash", "../../../scripts/get-current-info.sh", ] } NRLF-3.0.31/terraform/account-wide-infrastructure/test/domain.tf000066400000000000000000000062351511201605300245610ustar00rootroot00000000000000 module "qa-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.qa_api_domain_name domain_zone = aws_route53_zone.test-qa-ns.name mtls_certificate_file = "s3://${module.qa-truststore-bucket.bucket_name}/${module.qa-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.qa-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.test-qa-ns] } module "qasandbox-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.qasandbox_api_domain_name domain_zone = aws_route53_zone.test-qa-ns.name mtls_certificate_file = "s3://${module.qa-truststore-bucket.bucket_name}/${module.qa-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.qa-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.test-qa-ns] } module "int-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.int_api_domain_name domain_zone = aws_route53_zone.test-int-ns.name mtls_certificate_file = "s3://${module.int-truststore-bucket.bucket_name}/${module.int-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.int-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.test-int-ns] } module "intsandbox-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.intsandbox_api_domain_name domain_zone = aws_route53_zone.test-int-ns.name mtls_certificate_file = "s3://${module.int-truststore-bucket.bucket_name}/${module.int-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.int-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.test-int-ns] } module "ref-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.ref_api_domain_name domain_zone = aws_route53_zone.test-ref-ns.name mtls_certificate_file = "s3://${module.ref-truststore-bucket.bucket_name}/${module.ref-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.ref-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.test-ref-ns] } module "perftest-custom-domain-name" { source = "../modules/env-custom-domain-name" domain_name = var.perftest_api_domain_name domain_zone = aws_route53_zone.test-perftest-ns.name mtls_certificate_file = "s3://${module.perftest-truststore-bucket.bucket_name}/${module.perftest-truststore-bucket.certificates_object_key}" mtls_certificate_file_version = module.perftest-truststore-bucket.certificates_object_version depends_on = [aws_route53_zone.test-perftest-ns] } NRLF-3.0.31/terraform/account-wide-infrastructure/test/dynamodb__pointers-table.tf000066400000000000000000000023071511201605300302520ustar00rootroot00000000000000module "qa-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--qa" enable_deletion_protection = true } module "qa-sandbox-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--qa-sandbox" } module "int-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--int" enable_deletion_protection = true enable_pitr = true kms_deletion_window_in_days = 30 enable_backups = true } module "int-sandbox-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--int-sandbox" } module "ref-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--ref" enable_deletion_protection = true enable_pitr = true kms_deletion_window_in_days = 30 } module "perftest-pointers-table" { source = "../modules/pointers-table" name_prefix = "nhsd-nrlf--perftest" enable_deletion_protection = true enable_pitr = true kms_deletion_window_in_days = 30 } NRLF-3.0.31/terraform/account-wide-infrastructure/test/ec2.tf000066400000000000000000000022451511201605300237600ustar00rootroot00000000000000module "vpc" { count = var.enable_reporting && var.enable_powerbi_auto_push ? 1 : 0 source = "../modules/vpc" vpc_cidr_block = var.vpc_cidr_block enable_dns_hostnames = var.enable_dns_hostnames vpc_public_subnets_cidr_block = var.vpc_public_subnets_cidr_block vpc_private_subnets_cidr_block = var.vpc_private_subnets_cidr_block aws_azs = var.aws_azs name_prefix = "nhsd-nrlf--test" } module "powerbi_gw_instance" { count = var.enable_reporting && var.enable_powerbi_auto_push ? 1 : 0 source = "../modules/powerbi-gw-ec2" use_custom_ami = var.use_powerbi_gw_custom_ami instance_type = var.powerbi_gw_instance_type name_prefix = "nhsd-nrlf--test-powerbi-gw" target_bucket_arn = module.test-glue.target_bucket_arn glue_kms_key_arn = module.test-glue.aws_kms_key_arn athena_kms_key_arn = module.test-athena[0].kms_key_arn athena_bucket_arn = module.test-athena[0].bucket_arn subnet_id = module.vpc[0].private_subnet_id security_groups = [module.vpc[0].powerbi_gw_security_group_id] } NRLF-3.0.31/terraform/account-wide-infrastructure/test/etc/000077500000000000000000000000001511201605300235245ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/test/etc/test.tfvars000066400000000000000000000000001511201605300257200ustar00rootroot00000000000000NRLF-3.0.31/terraform/account-wide-infrastructure/test/glue.tf000066400000000000000000000002671511201605300242450ustar00rootroot00000000000000module "test-glue" { is_enabled = var.enable_reporting source = "../modules/glue" name_prefix = "nhsd-nrlf--test" schedule = false python_version = 3 } NRLF-3.0.31/terraform/account-wide-infrastructure/test/iam__api-gateway-to-cloudwatch.tf000066400000000000000000000015141511201605300312550ustar00rootroot00000000000000resource "aws_iam_role" "api_gateway_to_cloudwatch" { name = "${local.prefix}--api-gateway-cloudwatch-logs" assume_role_policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = "sts:AssumeRole" Effect = "Allow" Principal = { "Service" : "apigateway.amazonaws.com" } } ] }) } resource "aws_iam_role_policy_attachment" "api_gateway_to_cloudwatch" { role = aws_iam_role.api_gateway_to_cloudwatch.name policy_arn = "arn:aws:iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs" depends_on = [ aws_iam_role.api_gateway_to_cloudwatch ] } resource "aws_api_gateway_account" "api_gateway_account" { cloudwatch_role_arn = aws_iam_role.api_gateway_to_cloudwatch.arn depends_on = [ aws_iam_role.api_gateway_to_cloudwatch ] } NRLF-3.0.31/terraform/account-wide-infrastructure/test/iam__developer-role.tf000066400000000000000000000012471511201605300272210ustar00rootroot00000000000000resource "aws_iam_role" "developer_role" { name = "NHSDDeveloperRole" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { AWS : "arn:aws:iam::${data.aws_secretsmanager_secret_version.identities_account_id.secret_string}:root" }, Effect : "Allow", Condition : { Bool : { "aws:MultiFactorAuthPresent" : true } } } ] }) } resource "aws_iam_role_policy_attachment" "policy_attachment" { role = aws_iam_role.developer_role.name policy_arn = "arn:aws:iam::aws:policy/AdministratorAccess" } NRLF-3.0.31/terraform/account-wide-infrastructure/test/iam__ops-role.tf000066400000000000000000000024071511201605300260340ustar00rootroot00000000000000resource "aws_iam_role" "ops_role" { name = "NHSDOpsRole" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { AWS : "arn:aws:iam::${data.aws_secretsmanager_secret_version.identities_account_id.secret_string}:root" }, Effect : "Allow" } ] }) } module "ops_role_permissions" { source = "../modules/role-policy" name = "${local.prefix}--ops-permissions" role_name = aws_iam_role.ops_role.name iam_permissions = [ { Action = [ "acm:Describe*", "acm:Get*", "acm:List*", "cloudwatch:*", "dynamodb:*", "firehose:Describe*", "firehose:List*", "glue:*", "iam:Generate*", "iam:Get*", "iam:List*", "iam:Simulate*", "kinesis:Describe*", "kinesis:Get*", "kinesis:List*", "kms:*", "lambda:*", "logs:*", "route53:Get*", "route53:List*", "route53:Test*", "s3:*", "secretsmanager:*", "sns:*", "sqs:*", "ssm:*", "tag:*", "apigateway:*" ] Effect = "Allow" Resource = [ "*" ] } ] } NRLF-3.0.31/terraform/account-wide-infrastructure/test/locals.tf000066400000000000000000000005051511201605300245610ustar00rootroot00000000000000locals { region = "eu-west-2" project = "nhsd-nrlf" environment = terraform.workspace prefix = "${local.project}--${local.environment}" account_id = data.aws_caller_identity.current.account_id notification_emails = tolist(jsondecode(data.aws_secretsmanager_secret_version.emails.secret_string)) } NRLF-3.0.31/terraform/account-wide-infrastructure/test/main.tf000066400000000000000000000015121511201605300242270ustar00rootroot00000000000000provider "aws" { region = local.region assume_role { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } default_tags { tags = { project_name = local.project workspace = terraform.workspace } } } provider "awscc" { region = local.region assume_role = { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } } terraform { backend "s3" { encrypt = false region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-account-wide-infrastructure" workspace_key_prefix = "nhsd-nrlf" } required_providers { aws = { source = "hashicorp/aws" version = "~> 6.0" } } } NRLF-3.0.31/terraform/account-wide-infrastructure/test/outputs.tf000066400000000000000000000016731511201605300250360ustar00rootroot00000000000000output "powerbi_gw_instance_id" { description = "The ID of the PowerBI Gateway EC2 instance." value = var.enable_powerbi_auto_push ? module.powerbi_gw_instance[0].instance_id : null } output "reporting_database_name" { description = "Name of the reporting Athena database" value = var.enable_reporting ? module.test-glue.glue_database : null } output "athena_workgroup_name" { description = "Name of the Athena workgroup" value = var.enable_reporting ? module.test-athena[0].workgroup_name : null } output "athena_s3_output_location" { description = "S3 output location for Athena queries" value = var.enable_reporting ? "s3://${module.test-athena[0].bucket.id}/" : null } output "athena_kms_key_arn" { description = "KMS key ARN for Athena encryption" value = var.enable_reporting ? module.test-athena[0].kms_key_arn : null } output "version" { value = data.external.current-info.result.version } NRLF-3.0.31/terraform/account-wide-infrastructure/test/route53.tf000066400000000000000000000011051511201605300246070ustar00rootroot00000000000000resource "aws_route53_zone" "test-qa-ns" { name = "qa.record-locator.national.nhs.uk" } resource "aws_route53_zone" "NEW_test-int-ns" { name = "int.record-locator.national.nhs.uk" } resource "aws_route53_zone" "test-int-ns" { name = "api.record-locator.int.national.nhs.uk" } resource "aws_route53_zone" "NEW_test-ref-ns" { name = "ref.record-locator.national.nhs.uk" } resource "aws_route53_zone" "test-ref-ns" { name = "api.record-locator.ref.national.nhs.uk" } resource "aws_route53_zone" "test-perftest-ns" { name = "perftest.record-locator.national.nhs.uk" } NRLF-3.0.31/terraform/account-wide-infrastructure/test/s3.tf000066400000000000000000000041061511201605300236320ustar00rootroot00000000000000module "qa-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--qa" } module "qa-sandbox-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--qa-sandbox" } module "int-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--int" enable_backups = true } module "int-sandbox-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--int-sandbox" } module "ref-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--ref" } module "perftest-permissions-store-bucket" { source = "../modules/permissions-store-bucket" name_prefix = "nhsd-nrlf--perftest" } module "qa-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--qa" server_certificate_file = "../../../truststore/server/qa.pem" } module "qa-sandbox-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--qa-sandbox" server_certificate_file = "../../../truststore/server/qa.pem" } module "int-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--int" server_certificate_file = "../../../truststore/server/int.pem" } module "int-sandbox-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--int-sandbox" server_certificate_file = "../../../truststore/server/int.pem" } module "ref-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--ref" server_certificate_file = "../../../truststore/server/ref.pem" } module "perftest-truststore-bucket" { source = "../modules/truststore-bucket" name_prefix = "nhsd-nrlf--perftest" server_certificate_file = "../../../truststore/server/perftest.pem" } NRLF-3.0.31/terraform/account-wide-infrastructure/test/secrets.tf000066400000000000000000000124271511201605300247620ustar00rootroot00000000000000resource "aws_secretsmanager_secret" "identities_account_id" { name = "${local.prefix}--nhs-identities-account-id" } resource "aws_secretsmanager_secret" "qa_smoke_test_apigee_app" { name = "${local.prefix}--qa--apigee-app--smoke-test" description = "APIGEE App used to run Smoke Tests against the QA environment" } resource "aws_secretsmanager_secret" "int_smoke_test_apigee_app" { name = "${local.prefix}--int--apigee-app--smoke-test" description = "APIGEE App used to run Smoke Tests against the INT/UAT environment" } resource "aws_secretsmanager_secret" "ref_smoke_test_apigee_app" { name = "${local.prefix}--ref--apigee-app--smoke-test" description = "APIGEE App used to run Smoke Tests against the REF environment" } resource "aws_secretsmanager_secret" "perftest_smoke_test_apigee_app" { name = "${local.prefix}--perftest--apigee-app--smoke-test" description = "APIGEE App used to run Smoke Tests against the perftest environment" } resource "aws_secretsmanager_secret" "backup_destination_parameters" { name = "${local.prefix}--backup-destination-parameters" description = "Parameters used to configure the backup destination" } # # Smoke test parameters secrets # resource "aws_secretsmanager_secret" "qa_smoke_test_parameters" { name = "${local.project}--qa--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the QA environment" } resource "aws_secretsmanager_secret" "qasandbox_smoke_test_parameters" { name = "${local.project}--qa-sandbox--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the QA sandbox environment" } resource "aws_secretsmanager_secret" "int_smoke_test_parameters" { name = "${local.project}--int--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the int environment" } resource "aws_secretsmanager_secret" "intsandbox_smoke_test_parameters" { name = "${local.project}--int-sandbox--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the int sandbox environment" } resource "aws_secretsmanager_secret" "ref_smoke_test_parameters" { name = "${local.project}--ref--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the ref environment" } resource "aws_secretsmanager_secret" "perftest_smoke_test_parameters" { name = "${local.project}--perftest--smoke-test-parameters" description = "Parameters used to run Smoke Tests against the perftest environment" } # # Splunk Configuration secrets # resource "aws_secretsmanager_secret" "qa_splunk_configuration" { name = "${local.project}--qa--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_qa index" } resource "aws_secretsmanager_secret" "qa_sandbox_splunk_configuration" { name = "${local.project}--qasandbox--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_qasandbox index" } resource "aws_secretsmanager_secret" "int_splunk_configuration" { name = "${local.project}--int--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_int index" } resource "aws_secretsmanager_secret" "int_sandbox_splunk_configuration" { name = "${local.project}--intsandbox--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_intsandbox index" } resource "aws_secretsmanager_secret" "ref_splunk_configuration" { name = "${local.project}--ref--splunk-configuration" description = "Splunk configuration for the aws_recordlocator_ref index" } # # Environment Configuration secrets # resource "aws_secretsmanager_secret" "qa_environment_configuration" { name = "${local.project}--qa--env-config" description = "The environment configuration for the QA environment" } resource "aws_secretsmanager_secret" "qasandbox_environment_configuration" { name = "${local.project}--qa-sandbox--env-config" description = "The environment configuration for the QA Sandbox environment" } resource "aws_secretsmanager_secret" "int_environment_configuration" { name = "${local.project}--int--env-config" description = "The environment configuration for the Int environment" } resource "aws_secretsmanager_secret" "intsandbox_environment_configuration" { name = "${local.project}--int-sandbox--env-config" description = "The environment configuration for the Int Sandbox environment" } resource "aws_secretsmanager_secret" "ref_environment_configuration" { name = "${local.project}--ref--env-config" description = "The environment configuration for the Ref environment" } resource "aws_secretsmanager_secret" "perftest_environment_configuration" { name = "${local.project}--perftest--env-config" description = "The environment configuration for the Perftest environment" } # # PowerBI secrets # resource "aws_secretsmanager_secret" "powerbi_gw_instance_admin_pwd" { name = "${local.project}--test-powerbi-gw-instance-admin-pwd" description = "Admin password for the PowerBI Gateway EC2 instance" } resource "aws_secretsmanager_secret" "powerbi_gw_recovery_key" { name = "${local.project}--test-powerbi-gw-recovery-key" description = "Recovery key for the PowerBI Gateway EC2 instance" } NRLF-3.0.31/terraform/account-wide-infrastructure/test/vars.tf000066400000000000000000000046371511201605300242710ustar00rootroot00000000000000variable "assume_account" { sensitive = true } variable "assume_role" {} variable "qa_api_domain_name" { description = "The internal DNS name of the API Gateway for the QA environment" default = "api.qa.record-locator.national.nhs.uk" } variable "qasandbox_api_domain_name" { description = "The internal DNS name of the API Gateway for the QA sandbox environment" default = "api-sandbox.qa.record-locator.national.nhs.uk" } variable "int_api_domain_name" { description = "The internal DNS name of the API Gateway for the int environment" default = "int.api.record-locator.int.national.nhs.uk" } variable "intsandbox_api_domain_name" { description = "The internal DNS name of the API Gateway for the int sandbox environment" default = "int-sandbox.api.record-locator.int.national.nhs.uk" } variable "ref_api_domain_name" { description = "The internal DNS name of the API Gateway for the ref environment" default = "ref.api.record-locator.ref.national.nhs.uk" } variable "perftest_api_domain_name" { description = "The internal DNS name of the API Gateway for the perftest environment" default = "api.perftest.record-locator.national.nhs.uk" } variable "enable_reporting" { type = bool description = "Enable account-wide reporting processes in the test account" default = true } variable "aws_azs" { type = string description = "AWS Availability Zones" default = "eu-west-2a" } variable "enable_dns_hostnames" { type = bool description = "Enable DNS hostnames in VPC" default = true } variable "vpc_cidr_block" { type = string description = "Base CIDR Block for VPC" default = "10.0.0.0/16" } variable "vpc_public_subnets_cidr_block" { type = string description = "CIDR Block for Public Subnets in VPC" default = "10.0.0.0/24" } variable "vpc_private_subnets_cidr_block" { type = string description = "CIDR Block for Private Subnets in VPC" default = "10.0.1.0/24" } variable "enable_powerbi_auto_push" { type = bool description = "Enable automatic pushing of info into PowerBI" default = true } variable "powerbi_gw_instance_type" { type = string description = "Type for PowerBI GW EC2 Instance" default = "t2.medium" } variable "use_powerbi_gw_custom_ami" { type = bool description = "Use custom image for PowerBI GW instance" default = true } NRLF-3.0.31/terraform/backup-infrastructure/000077500000000000000000000000001511201605300206555ustar00rootroot00000000000000NRLF-3.0.31/terraform/backup-infrastructure/README.md000066400000000000000000000055671511201605300221510ustar00rootroot00000000000000# NRLF Backup Infrastructure This directory contains AWS backup terraform resources which are global to a given account. Each subdirectory corresponds to each AWS account (`prod` and `test`). **Backup infrastructure should be deployed manually and not be run as part of CI.** ## Table of Contents 1. [Prerequisites](#prerequisites) 2. [Initialise shell environment](#initialise-shell-environment) 3. [Deploy backup resources](#deploy-backup-resources) 4. [Tear down backup resources](#tear-down-backup-resources) ## Prerequisites Before deploying the NRLF backup infrastructure, you will need: - An AWS backup account that have already been bootstrapped, as described in [bootstrap/README.md](../bootstrap/README.md). This is a one-time account setup step. ## Deploy backup resources To deploy the backup resources, first login to the AWS mgmt account on the CLI. Then, initialise the terraform backup workspace. For the test account: ```shell $ cd test $ terraform init && ( \ terraform workspace new test || \ terraform workspace select test ) ``` If you want to apply changes to prod, use the `prod` directory and the `backup-infra-prod` terraform workspace. Once you have your workspace set, you can plan your changes with: ```shell $ terraform plan \ -var 'source_account_id=SOURCE_ACCOUNT_ID" \ -var 'assume_account=AWS_ACCOUNT_ID' \ -var 'assume_role=terraform' ``` Replacing SOURCE_ACCOUNT with the account id that will be sending backups to the backup account and AWS_ACCOUNT_ID with the AWS account id of your backup account. Once you're happy with your planned changes, you can apply them with: ```shell $ terraform apply \ -var 'source_account_id=SOURCE_ACCOUNT_ID" \ -var 'assume_account=AWS_ACCOUNT_ID' \ -var 'assume_role=terraform' ``` Replacing SOURCE_ACCOUNT with the account id that will be sending backups to the backup account and AWS_ACCOUNT_ID with the AWS account id of your backup account. ## Tear down backup resources WARNING - This action will destroy all backup resources from the AWS account. This should only be done if you are sure that this is safe and are sure that you are signed into the correct AWS account. To tear down backup resources, first login to the AWS mgmt account on the CLI. Then, initialise your terraform workspace. For the test account: ```shell $ cd test $ terraform init && ( \ terraform workspace new test || \ terraform workspace select test ) ``` If you want to destroy resources in prod, use the `prod` directory and the `backup-infra-prod` terraform workspace. And then, to tear down: ```shell $ terraform destroy \ -var 'source_account_id=SOURCE_ACCOUNT_ID" \ -var 'assume_account=AWS_ACCOUNT_ID' \ -var 'assume_role=terraform' ``` Replacing SOURCE_ACCOUNT with the account id that will be sending backups to the backup account and AWS_ACCOUNT_ID with the AWS account id of your backup account. NRLF-3.0.31/terraform/backup-infrastructure/modules/000077500000000000000000000000001511201605300223255ustar00rootroot00000000000000NRLF-3.0.31/terraform/backup-infrastructure/modules/aws-backup-destination/000077500000000000000000000000001511201605300267015ustar00rootroot00000000000000NRLF-3.0.31/terraform/backup-infrastructure/modules/aws-backup-destination/README.md000066400000000000000000000114711511201605300301640ustar00rootroot00000000000000# AWS Backup Module The AWS Backup Module helps automates the setup of AWS Backup resources in a destination account. It streamlines the process of creating, managing, and standardising backup configurations. ## Inputs | Name | Description | Type | Default | Required | | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------------- | :------: | | [account_id](#input_account_id) | The id of the account that the vault will be in | `string` | n/a | yes | | [changeable_for_days](#input_changeable_for_days) | How long you want the vault lock to be changeable for, only applies to compliance mode. This value is expressed in days no less than 3 and no greater than 36,500; otherwise, an error will return. | `number` | `14` | no | | [enable_vault_protection](#input_enable_vault_protection) | Flag which controls if the vault lock is enabled | `bool` | `false` | no | | [kms_key](#input_kms_key) | The KMS key used to secure the vault | `string` | n/a | yes | | [region](#input_region) | The region we should be operating in | `string` | `"eu-west-2"` | no | | [source_account_id](#input_source_account_id) | The id of the account that backups will come from | `string` | n/a | yes | | [source_account_name](#input_source_account_name) | The name of the account that backups will come from | `string` | n/a | yes | | [vault_lock_max_retention_days](#input_vault_lock_max_retention_days) | The maximum retention period that the vault retains its recovery points | `number` | `365` | no | | [vault_lock_min_retention_days](#input_vault_lock_min_retention_days) | The minimum retention period that the vault retains its recovery points | `number` | `365` | no | | [vault_lock_type](#input_vault_lock_type) | The type of lock that the vault should be, will default to governance | `string` | `"governance"` | no | ## Example ```terraform module "test_backup_vault" { source = "./modules/aws_backup" source_account_name = "test" account_id = local.aws_accounts_ids["backup"] source_account_id = local.aws_accounts_ids["test"] kms_key = aws_kms_key.backup_key.arn enable_vault_protection = true } ``` NRLF-3.0.31/terraform/backup-infrastructure/modules/aws-backup-destination/backup.tf000066400000000000000000000002731511201605300305030ustar00rootroot00000000000000resource "aws_backup_vault" "vault" { name = "${var.source_account_name}-backup-vault" kms_key_arn = var.kms_key } output "vault_arn" { value = aws_backup_vault.vault.arn } NRLF-3.0.31/terraform/backup-infrastructure/modules/aws-backup-destination/backup_vault_lock.tf000066400000000000000000000006011511201605300327210ustar00rootroot00000000000000resource "aws_backup_vault_lock_configuration" "vault_lock" { count = var.enable_vault_protection ? 1 : 0 backup_vault_name = aws_backup_vault.vault.name changeable_for_days = var.vault_lock_type == "compliance" ? var.changeable_for_days : null max_retention_days = var.vault_lock_max_retention_days min_retention_days = var.vault_lock_min_retention_days } NRLF-3.0.31/terraform/backup-infrastructure/modules/aws-backup-destination/backup_vault_policy.tf000066400000000000000000000032321511201605300332730ustar00rootroot00000000000000resource "aws_backup_vault_policy" "vault_policy" { backup_vault_name = aws_backup_vault.vault.name policy = data.aws_iam_policy_document.vault_policy.json } data "aws_iam_policy_document" "vault_policy" { statement { sid = "AllowCopyToVault" effect = "Allow" principals { type = "AWS" identifiers = ["arn:aws:iam::${var.source_account_id}:root"] } actions = [ "backup:CopyIntoBackupVault" ] resources = ["*"] } dynamic "statement" { for_each = var.enable_vault_protection ? [1] : [] content { sid = "DenyBackupVaultAccess" effect = "Deny" principals { type = "AWS" identifiers = ["*"] } actions = [ "backup:DeleteRecoveryPoint", "backup:PutBackupVaultAccessPolicy", "backup:UpdateRecoveryPointLifecycle", "backup:DeleteBackupVault", "backup:StartRestoreJob", "backup:DeleteBackupVaultLockConfiguration", ] resources = ["*"] } } dynamic "statement" { for_each = var.enable_vault_protection ? [1] : [] content { sid = "DenyBackupCopyExceptToSourceAccount" effect = "Deny" principals { type = "AWS" identifiers = ["arn:aws:iam::${var.account_id}:root"] } actions = [ "backup:CopyFromBackupVault" ] resources = ["*"] condition { test = "StringNotEquals" variable = "backup:CopyTargets" values = [ "arn:aws:backup:${var.region}:${var.source_account_id}:backup-vault:${var.region}-${var.source_account_id}-backup-vault" ] } } } } NRLF-3.0.31/terraform/backup-infrastructure/modules/aws-backup-destination/variables.tf000066400000000000000000000046651511201605300312170ustar00rootroot00000000000000variable "source_account_name" { # This is used as a prefix for the vault name, and referenced by the policy and the lock. # It doesn't have to match anything in the source AWS account. description = "The name of the account that backups will come from" type = string } variable "source_account_id" { # The source account ID is used in the policy to allow permit root in the source account # to copy backups into the vault. description = "The id of the account that backups will come from" type = string } variable "account_id" { # This is used to deny root from being able to copy backups from the vault # to anywhere other than the source account. The constraint will need to # be removed if the original source account is lost. description = "The id of the account that the vault will be in" type = string } variable "region" { description = "The region we should be operating in" type = string default = "eu-west-2" } variable "kms_key" { description = "The KMS key used to secure the vault" type = string } variable "enable_vault_protection" { # With this set to true, privileges are locked down so that the vault can't be deleted or # have its policy changed. The minimum and maximum retention periods are also set only if this is true. description = "Flag which controls if the vault lock is enabled" type = bool default = false } variable "vault_lock_type" { description = "The type of lock that the vault should be, will default to governance" type = string # See toplevel README.md: # DO NOT SET THIS TO compliance UNTIL YOU ARE SURE THAT YOU WANT TO LOCK THE VAULT PERMANENTLY # When you do, you will also need to set "enable_vault_protection" to true for it to take effect. default = "governance" } variable "vault_lock_min_retention_days" { description = "The minimum retention period that the vault retains its recovery points" type = number default = 365 } variable "vault_lock_max_retention_days" { description = "The maximum retention period that the vault retains its recovery points" type = number default = 365 } variable "changeable_for_days" { description = "How long you want the vault lock to be changeable for, only applies to compliance mode. This value is expressed in days no less than 3 and no greater than 36,500; otherwise, an error will return." type = number default = 14 } NRLF-3.0.31/terraform/backup-infrastructure/prod/000077500000000000000000000000001511201605300216215ustar00rootroot00000000000000NRLF-3.0.31/terraform/backup-infrastructure/prod/aws-backup.tf000066400000000000000000000024551511201605300242170ustar00rootroot00000000000000 # We need a key for the backup vaults. This key will be used to encrypt the backups themselves. # We need one per vault (on the assumption that each vault will be in a different account). resource "aws_kms_key" "destination_backup_key" { description = "KMS key for AWS Backup vaults" deletion_window_in_days = 7 enable_key_rotation = true policy = jsonencode({ Version = "2012-10-17" Statement = [ { Effect = "Allow" Sid = "Enable IAM User Permissions" Principal = { AWS = "arn:aws:iam::${local.destination_account_id}:root" } Action = "kms:*" Resource = "*" } ] }) } module "destination" { source = "../modules/aws-backup-destination" source_account_name = "prod" # please note that the assigned value would be the prefix in aws_backup_vault.vault.name account_id = local.destination_account_id source_account_id = local.source_account_id kms_key = aws_kms_key.destination_backup_key.arn enable_vault_protection = false } ### # Destination vault ARN output ### output "destination_vault_arn" { # The ARN of the backup vault in the destination account is needed by # the source account to copy backups into it. value = module.destination.vault_arn } NRLF-3.0.31/terraform/backup-infrastructure/prod/data.tf000066400000000000000000000000501511201605300230600ustar00rootroot00000000000000data "aws_caller_identity" "current" {} NRLF-3.0.31/terraform/backup-infrastructure/prod/locals.tf000066400000000000000000000003141511201605300234270ustar00rootroot00000000000000locals { # Adjust these as required project_name = "nrlf-prod-backup" environment_name = "prod" source_account_id = var.source_account_id destination_account_id = var.assume_account } NRLF-3.0.31/terraform/backup-infrastructure/prod/main.tf000066400000000000000000000012721511201605300231020ustar00rootroot00000000000000provider "aws" { region = "eu-west-2" assume_role { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } default_tags { tags = { project_name = local.project_name workspace = terraform.workspace } } } terraform { required_providers { aws = { source = "hashicorp/aws" version = "~> 5.76.0" } } backend "s3" { region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-backup-infrastructure" workspace_key_prefix = "nhsd-nrlf" encrypt = false } } NRLF-3.0.31/terraform/backup-infrastructure/prod/vars.tf000066400000000000000000000005751511201605300231360ustar00rootroot00000000000000variable "assume_account" { description = "The account id to deploy the infrastructure to" sensitive = true } variable "assume_role" { description = "Name of the role to assume to deploy the infrastructure" type = string } variable "source_account_id" { description = "The account id of the backup source account" type = string sensitive = true } NRLF-3.0.31/terraform/backup-infrastructure/test/000077500000000000000000000000001511201605300216345ustar00rootroot00000000000000NRLF-3.0.31/terraform/backup-infrastructure/test/aws-backup.tf000066400000000000000000000024551511201605300242320ustar00rootroot00000000000000 # We need a key for the backup vaults. This key will be used to encrypt the backups themselves. # We need one per vault (on the assumption that each vault will be in a different account). resource "aws_kms_key" "destination_backup_key" { description = "KMS key for AWS Backup vaults" deletion_window_in_days = 7 enable_key_rotation = true policy = jsonencode({ Version = "2012-10-17" Statement = [ { Effect = "Allow" Sid = "Enable IAM User Permissions" Principal = { AWS = "arn:aws:iam::${local.destination_account_id}:root" } Action = "kms:*" Resource = "*" } ] }) } module "destination" { source = "../modules/aws-backup-destination" source_account_name = "test" # please note that the assigned value would be the prefix in aws_backup_vault.vault.name account_id = local.destination_account_id source_account_id = local.source_account_id kms_key = aws_kms_key.destination_backup_key.arn enable_vault_protection = false } ### # Destination vault ARN output ### output "destination_vault_arn" { # The ARN of the backup vault in the destination account is needed by # the source account to copy backups into it. value = module.destination.vault_arn } NRLF-3.0.31/terraform/backup-infrastructure/test/data.tf000066400000000000000000000000501511201605300230730ustar00rootroot00000000000000data "aws_caller_identity" "current" {} NRLF-3.0.31/terraform/backup-infrastructure/test/locals.tf000066400000000000000000000003141511201605300234420ustar00rootroot00000000000000locals { # Adjust these as required project_name = "nrlf-test-backup" environment_name = "test" source_account_id = var.source_account_id destination_account_id = var.assume_account } NRLF-3.0.31/terraform/backup-infrastructure/test/main.tf000066400000000000000000000012721511201605300231150ustar00rootroot00000000000000provider "aws" { region = "eu-west-2" assume_role { role_arn = "arn:aws:iam::${var.assume_account}:role/${var.assume_role}" } default_tags { tags = { project_name = local.project_name workspace = terraform.workspace } } } terraform { required_providers { aws = { source = "hashicorp/aws" version = "~> 5.76.0" } } backend "s3" { region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-backup-infrastructure" workspace_key_prefix = "nhsd-nrlf" encrypt = false } } NRLF-3.0.31/terraform/backup-infrastructure/test/vars.tf000066400000000000000000000005751511201605300231510ustar00rootroot00000000000000variable "assume_account" { description = "The account id to deploy the infrastructure to" sensitive = true } variable "assume_role" { description = "Name of the role to assume to deploy the infrastructure" type = string } variable "source_account_id" { description = "The account id of the backup source account" type = string sensitive = true } NRLF-3.0.31/terraform/bootstrap/000077500000000000000000000000001511201605300163475ustar00rootroot00000000000000NRLF-3.0.31/terraform/bootstrap/README.md000066400000000000000000000063521511201605300176340ustar00rootroot00000000000000# NRLF AWS Account Initial Bootstrap This directory contains files needed for initial setup for brand new AWS accounts. Directory is split in to two sub directories. `mgmt` directory contains files required for initial bootstrap of the `mgmt` account. `non-mgmt` directory contains files required for initial bootstrap of `prod`, `test` and `dev` accounts. The setup creates AWS resources to enable terraform deployments to AWS accounts. This should only be required to be performed once. ## Table of Contents 1. [Prerequisites](#prerequisites) 2. [Bootstrapping the environments](#bootstrapping-the-environments) 3. [Tearing down the environments](#tearing-down-the-environments) ## Prerequisites Before you begin deploying NRLF bootstrap components, you will need: - Four AWS accounts created. These will be assigned as: mgmt, prod, test and dev - The required packages to build NRLF, see [the Setup section in README.md](../../README.md#before-you-begin). ## Bootstrapping the environments To bootstrap the environments, you need to follow these steps. **These steps should only need to be run once when starting the project** ### Setup mgmt account resources This will set up your terraform state buckets and import them into your project. It will create resources on mgmt account required for terraform to work. This includes: - terraform state bucket - terraform state lock table - secret managers to hold account ids for the non-mgmt accounts To create these resource, first login to the AWS mgmt account on your CLI and then run: ```shell ./scripts/bootstrap.sh create-mgmt ``` Now log on to AWS web console and manually add the aws account ids to each respective secrets: - `nhsd-nrlf--mgmt--mgmt-account-id` - `nhsd-nrlf--mgmt--prod-account-id` - `nhsd-nrlf--mgmt--test-account-id` - `nhsd-nrlf--mgmt--test-backup-account-id` - `nhsd-nrlf--mgmt--dev-account-id` Generate a Github PAT for the NRLF source repo and add it to the `nhsd-nrlf--codebuild-github-pat` secret following the documentation on [AWS Codebuild Access Tokens for Github](https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens-github.html). This is required for codebuild to be used for Github Self-Hosted Runners. ### Create trust role for `mgmt` for your `prod`, `test` and `dev` accounts In order to allow `mgmt` to create resources in `prod`, `test` and `dev` accounts you need to create a trust role in each of these accounts. To create this role, first login to your non-mgmt account on your CLI and then run: ```shell ./scripts/bootstrap.sh create-non-mgmt ``` ## Tearing down the environments When closing AWS accounts, resources created by this setup will need to be torn down. ### Tear down `prod`, `test` and `dev` account resources This will tear down resources created in this [step](#create-trust-role-for-mgmt-for-your-prod-test-and-dev-accounts) To tear down the non-mgmt account, first login to that non-mgmt AWS account on your CLI and then run: ```shell ./scripts/bootstrap.sh delete-non-mgmt ``` ### Tear down mgmt account resources This will tear down resources created in this [step](#setup-mgmt-account-resources). To tear down management resource, first login to the AWS mgmt account on your CLI and then run: ```shell ./scripts/bootstrap.sh delete-mgmt ``` NRLF-3.0.31/terraform/bootstrap/mgmt/000077500000000000000000000000001511201605300173135ustar00rootroot00000000000000NRLF-3.0.31/terraform/bootstrap/mgmt/locktable.json000066400000000000000000000005251511201605300221500ustar00rootroot00000000000000{ "TableName": "nhsd-nrlf--terraform-state-lock", "KeySchema": [ { "AttributeName": "LockID", "KeyType": "HASH" } ], "AttributeDefinitions": [ { "AttributeName": "LockID", "AttributeType": "S" } ], "ProvisionedThroughput": { "ReadCapacityUnits": 20, "WriteCapacityUnits": 20 } } NRLF-3.0.31/terraform/bootstrap/non-mgmt/000077500000000000000000000000001511201605300201035ustar00rootroot00000000000000NRLF-3.0.31/terraform/bootstrap/non-mgmt/terraform-trust-policy.json000066400000000000000000000003601511201605300254520ustar00rootroot00000000000000{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::REPLACEME:root" }, "Action": ["sts:AssumeRole", "sts:TagSession"], "Condition": {} } ] } NRLF-3.0.31/terraform/infrastructure/000077500000000000000000000000001511201605300174125ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/.terraform-version000066400000000000000000000000061511201605300230730ustar00rootroot000000000000001.9.8 NRLF-3.0.31/terraform/infrastructure/Makefile000066400000000000000000000037131511201605300210560ustar00rootroot00000000000000 ENV ?= dev TF_WORKSPACE_NAME ?= $(shell (whoami || hostname) | head -c 5)-$(ENV) TF_ARGS ?= ENV_ACCOUNT_NAME ?= $(shell ../../scripts/get-account-name-for-env.sh $(ENV)) ENV_ACCOUNT_ID ?= $(shell aws secretsmanager get-secret-value --secret-id nhsd-nrlf--mgmt--$(ENV_ACCOUNT_NAME)-account-id --query SecretString --output text) USE_SHARED_RESOURCES ?= $(shell poetry run python ../../scripts/are_resources_shared_for_stack.py $(TF_WORKSPACE_NAME)) export ENV ENV_ACCOUNT_NAME TF_WORKSPACE_NAME help: ## Show this help message @echo "Usage: make [target]" @echo @echo "where [target] can be:" @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-30s\033[0m %s\n", $$1, $$2}' check: ## Check the deploy environment is setup correctly @(cd ../.. && ./scripts/check-deploy-environment.sh) check-warn: @(cd ../.. && SHOULD_WARN_ONLY=true ./scripts/check-deploy-environment.sh) build-artifacts: ## Build the NRLF artifacts to deploy (cd ../.. && $(MAKE) build) init: check-warn ## Initialise the Terraform workspace -(cd ../.. && $(MAKE) ENV=$(ENV) truststore-pull-server) terraform init (terraform workspace select $(TF_WORKSPACE_NAME) || terraform workspace new $(TF_WORKSPACE_NAME)) plan: check-warn ## Plan the Terraform changes terraform plan \ -var-file=./etc/$(ENV).tfvars \ -var 'assume_role_arn=arn:aws:iam::$(ENV_ACCOUNT_ID):role/terraform' \ -var 'use_shared_resources=$(USE_SHARED_RESOURCES)' \ $(TF_ARGS) apply: check-warn ## Apply the Terraform changes terraform apply \ -var-file=./etc/$(ENV).tfvars \ -var 'assume_role_arn=arn:aws:iam::$(ENV_ACCOUNT_ID):role/terraform' \ -var 'use_shared_resources=$(USE_SHARED_RESOURCES)' \ $(TF_ARGS) destroy: check-warn ## Destroy the Terraform resources terraform destroy \ -var-file=./etc/$(ENV).tfvars \ -var 'assume_role_arn=arn:aws:iam::$(ENV_ACCOUNT_ID):role/terraform' \ -var 'use_shared_resources=$(USE_SHARED_RESOURCES)' \ $(TF_ARGS) NRLF-3.0.31/terraform/infrastructure/README.md000066400000000000000000000137111511201605300206740ustar00rootroot00000000000000# NRLF main infrastructure This directory contains terraform to build the main NRLF api infrastructure. NRLF project uses terraform workspaces to handle deploying multiple NRLF stacks to each of our environments. NRFL stacks are identified by their TF workspace id. Resources in each stack will contain the workspace id in its name. (e.g. nhsd-nrlf--dev-pointers-table or nhsd-nrlf--469d5da6-pointers-table). Each developer/QA can create their own ephemeral instance of the NRLF infrastructure. These are deployed as isolated NRLF stacks into the dev AWS account and use variables in `etc/dev.tfvars`. This project has a number of "persistent environments", similar to traditional dev, ref and prod environments. Each of these environments will typically contain multiple NRLF stacks, allowing for blue/green style deployment, and have shared storage infrastructure like DynamoDB tables and S3 buckets. The persistent environments are deployed as follows: | Environment | TF Workspace | TF Config | AWS Account | Internal Domain | Public Domain | | ------------ | ------------- | --------------------- | ----------- | ----------------------------------------- | ----------------------------------------- | | internal-dev | dev-N | `etc/dev.tfvars` | dev | `record-locator.dev.national.nhs.uk` | `internal-dev.api.service.nhs.uk` | | dev-sandbox | dev-sandbox-N | `etc/dev.tfvars` | dev | `record-locator.dev.national.nhs.uk` | `internal-dev-sandbox.api.service.nhs.uk` | | internal-qa | qa-N | `etc/qa.tfvars` | test | `qa.record-locator.national.nhs.uk` | `internal-qa.api.service.nhs.uk` | | qa-sandbox | qa-sandbox-N | `etc/qa.tfvars` | test | `qa.record-locator.national.nhs.uk` | `internal-qa-sandbox.api.service.nhs.uk` | | int | int-N | `etc/int.tfvars` | test | `record-locator.int.national.nhs.uk` | `int.api.service.nhs.uk` | | sandbox | int-sandbox-N | `etc/int.tfvars` | test | `record-locator.int.national.nhs.uk` | `sandbox.api.service.nhs.uk` | | perftest | perftest-N | `etc/perftest.tfvars` | test | `perftest.record-locator.national.nhs.uk` | `perftest.api.service.nhs.uk` | | ref | ref-N | `etc/ref.tfvars` | test | `record-locator.ref.national.nhs.uk` | `ref.api.service.nhs.uk` | | prod | prod-N | `etc/prod.tfvars` | prod | `record-locator.national.nhs.uk` | `api.service.nhs.uk` | The `N` in the TF workspace name repesents the stack id in that environment. So, for example, the internal-dev environment might have two stacks, `dev-1` and `dev-2` with TF workspace names matching their stack names. All resources for the `dev-1` stack will be contained within the `dev-1` TF workspace. CI pipeline creates infrastructure in the dev AWS account. These will have workspace id of `nrl-` and use variables in `etc/dev.tfvars` ## Table of Contents 1. [Prerequisites](#prerequisites) 2. [Deploy infrastructure](#deploy-infrastructure) 3. [Teardown infrastructure](#teardown-infrastructure) ## Prerequisites Before you begin deploying NRLF infrastructure, you will need: - An NRLF-enabled AWS account, ideally `dev`. See [bootstrap](../bootstrap/README.md) for details on setting up a new account. - The required packages to build NRLF, see [the Setup section in README.md](../../README.md#before-you-begin). - To be logged into the AWS mgmt account on the CLI that you are deploying from. If infrastructure changes require account wide AWS resources. Please deploy the corresponding [NRLF account wide infrastructure](../account-wide-infrastructure/README.md) first. ## Deploy infrastructure To deploy the infrastructure, you need to build the NRLF artifacts and then deploy them with Terraform. The steps are as follows: ### Build artifacts for deployment First, build the NRLF artifacts that will be deployed by Terraform: ```shell $ make build-artifacts ``` ### Init your local workspace On the first deployment, you will need to initialise and create your workspace. To create a new ephemeral dev workspace, run: ```shell $ make init ``` If you want to use an existing workspace, or if you want to use the workspace of a persistent environment, do the following: ```shell $ make ENV={ENV_NAME} TF_WORKSPACE_NAME={WORKSPACE_NAME} init ``` replacing `{ENV_NAME}` with the environment name (e.g. `dev`, `qa`, `qa-sandbox` etc) and `{WORKSPACE_NAME}` with the name of the workspace/stack you want to use. So, for example, if you want to use the `qa` environment and deploy to the `qa-1` stack, you'd do the following: ```shell $ make ENV=qa TF_WORKSPACE_NAME=qa-1 init ``` If your Terraform provider config changes, you may need to reinitialise your workspace. ### Create a Terraform plan To create a Terraform plan for a dev workspace: ```shell $ make plan ``` To create a Terraform plan for a workspace in another environment: ```shell $ make ENV={ENV_NAME} plan ``` replacing `{ENV_NAME}` with the environment name (e.g. `dev`, `qa`, `qa-sandbox` etc). ### Apply the changes with Terraform To apply your changes to a dev workspace: ```shell $ make apply ``` To apply your changes to a workspace in another environment: ```shell $ make ENV={ENV_NAME} apply ``` replacing `{ENV_NAME}` with the environment name (e.g. `dev`, `qa`, `qa-sandbox` etc). ## Tear down infrastructure To tear down the infrastructure, you need to use Terraform to destroy the resources in your Terraform workspace. To teardown the infrastructure, do the following: ``` $ make ENV={ENV_NAME} TF_WORKSPACE_NAME={WORKSPACE_NAME} init destroy ``` replacing `{ENV_NAME}` with the environment name (e.g. `dev`, `qa`, `qa-sandbox` etc) and `{WORKSPACE_NAME}` with the name of the workspace/stack you want to destroy. NRLF-3.0.31/terraform/infrastructure/api_gateway.tf000066400000000000000000000112061511201605300222370ustar00rootroot00000000000000module "consumer__gateway" { source = "./modules/api_gateway" apitype = "consumer" prefix = local.prefix lambdas = { environment = terraform.workspace method_countDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--consumer--countDocumentReference", 0, 64)}/invocations" method_searchDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--consumer--searchDocumentReference", 0, 64)}//invocations" method_searchPostDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--consumer--searchPostDocumentReference", 0, 64)}/invocations" method_readDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--consumer--readDocumentReference", 0, 64)}/invocations" method_status = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--consumer--status", 0, 64)}/invocations" } endpoint_allowed_methods = { "/DocumentReference" = "GET", "/DocumentReference/{id}" = "GET" } kms_key_id = module.kms__cloudwatch.kms_arn domain = local.apis.domain path = local.apis.consumer.path capability_statement_content = templatefile("${path.module}/consumer.tftpl", { domain = local.public_domain, id = filesha1("${path.module}/consumer.tftpl") }) depends_on = [ aws_acm_certificate_validation.validation ] retention = var.log_retention_period } module "producer__gateway" { source = "./modules/api_gateway" apitype = "producer" prefix = local.prefix lambdas = { environment = terraform.workspace method_searchDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--searchDocumentReference", 0, 64)}/invocations" method_searchPostDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--searchPostDocumentReference", 0, 64)}/invocations" method_readDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--readDocumentReference", 0, 64)}/invocations" method_createDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--createDocumentReference", 0, 64)}/invocations" method_updateDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--updateDocumentReference", 0, 64)}/invocations" method_upsertDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--upsertDocumentReference", 0, 64)}/invocations" method_deleteDocumentReference = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--deleteDocumentReference", 0, 64)}/invocations" method_status = "arn:aws:apigateway:eu-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:eu-west-2:${local.aws_account_id}:function:${substr("${local.prefix}--api--producer--status", 0, 64)}/invocations" } endpoint_allowed_methods = { "/DocumentReference" = "GET,POST", "/DocumentReference/{id}" = "GET,PUT,DELETE" } kms_key_id = module.kms__cloudwatch.kms_arn domain = local.apis.domain path = local.apis.producer.path capability_statement_content = templatefile("${path.module}/producer.tftpl", { domain = local.public_domain, id = filesha1("${path.module}/producer.tftpl") }) depends_on = [ aws_acm_certificate_validation.validation ] retention = var.log_retention_period } NRLF-3.0.31/terraform/infrastructure/consumer.tftpl000066400000000000000000000077461511201605300223360ustar00rootroot00000000000000{ "resourceType": "CapabilityStatement", "id": "${id}", "url": "https://${domain}/record-locator/consumer/FHIR/R4/metadata", "name": "NRLConsumerAPICapabilityStatement", "status": "active", "version": "1.0.1", "experimental": false, "date": "2024-03-13", "publisher": "NHS England", "contact": [ { "name": "NRL Team", "telecom": [ { "system": "email", "use": "work", "value": "nrls@nhs.net" } ] } ], "description": "Capability Statement for the National Record Locator FHIR R4 Consumer API", "kind": "instance", "software": { "name": "National Record Locator FHIR R4 API - Consumer", "version": "v3.0" }, "implementation": { "description": "NRL v3.0 Consumer API FHIR Server", "url": "https://${domain}/record-locator/consumer/FHIR/R4/" }, "fhirVersion": "4.0.1", "format": ["json"], "rest": [ { "mode": "server", "security": { "cors": true, "service": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/restful-security-service", "code": "OAuth", "display": "OAuth" } ] } ] }, "resource": [ { "type": "CapabilityStatement", "interaction": [ { "code": "read" } ], "versioning": "version", "readHistory": false }, { "type": "DocumentReference", "profile": "http://hl7.org/fhir/R4/documentreference.html", "documentation": "Additional business rules apply to constrain patient, organisation and type/category content. Note that HEAD requests are not supported.", "interaction": [ { "code": "read", "documentation": "Get a single pointer by ID." }, { "code": "search-type", "documentation": "Retrieve a set of pointers matching certain filter criteria. Both GET and POST are supported." } ], "versioning": "no-version", "readHistory": false, "updateCreate": true, "conditionalCreate": false, "conditionalRead": "not-supported", "conditionalUpdate": false, "conditionalDelete": "not-supported", "referencePolicy": ["logical"], "searchParam": [ { "name": "custodian", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-custodian", "type": "reference", "documentation": "Allows DocumentReference search results to be filtered by custodian organisation (ODS code)." }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category", "type": "token", "documentation": "Allows DocumentReference search results to be filtered by pointer category (SNOMED code)." }, { "name": "type", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-type", "type": "token", "documentation": "Allows DocumentReference search results to be filtered by pointer type (SNOMED or NICIP code)." }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject", "type": "reference", "documentation": "Allows DocumentReference search results to be filtered by patient (NHS number). The subject:identifier parameter should be used." } ] } ] } ] } NRLF-3.0.31/terraform/infrastructure/data.tf000066400000000000000000000025231511201605300206600ustar00rootroot00000000000000data "aws_caller_identity" "current" {} data "aws_s3_object" "api-truststore-certificate" { bucket = "${local.shared_prefix}-api-truststore" key = "certificates.pem" } data "aws_s3_bucket" "authorization-store" { count = var.use_shared_resources ? 1 : 0 bucket = "${local.shared_prefix}-authorization-store" } data "aws_iam_policy" "auth-store-read-policy" { count = var.use_shared_resources ? 1 : 0 name = "${local.shared_prefix}-read-s3-authorization-store" } data "aws_dynamodb_table" "pointers-table" { count = var.use_shared_resources ? 1 : 0 name = "${local.shared_prefix}-pointers-table" } data "aws_iam_policy" "pointers-table-read" { count = var.use_shared_resources ? 1 : 0 name = "${local.shared_prefix}-pointers-table-read" } data "aws_iam_policy" "pointers-table-write" { count = var.use_shared_resources ? 1 : 0 name = "${local.shared_prefix}-pointers-table-write" } data "aws_iam_policy" "pointers-kms-read-write" { count = var.use_shared_resources ? 1 : 0 name = "${local.shared_prefix}-pointers-kms-read-write" } data "external" "current-info" { program = [ "bash", "../../scripts/get-current-info.sh", ] } data "aws_s3_bucket" "source-data-bucket" { bucket = "${local.account_prefix}-source-data-bucket" } data "aws_kms_key" "glue" { key_id = "alias/${local.account_prefix}-glue" } NRLF-3.0.31/terraform/infrastructure/domain.tf000066400000000000000000000036441511201605300212230ustar00rootroot00000000000000data "aws_route53_zone" "zone" { name = local.apis.zone private_zone = false } resource "aws_acm_certificate" "certificate" { domain_name = local.apis.domain subject_alternative_names = [ local.apis.domain ] validation_method = "DNS" lifecycle { create_before_destroy = true } } resource "aws_route53_record" "route" { for_each = { for dvo in aws_acm_certificate.certificate.domain_validation_options : dvo.domain_name => { name = dvo.resource_record_name record = dvo.resource_record_value type = dvo.resource_record_type } } allow_overwrite = true name = each.value.name records = [each.value.record] ttl = 60 type = each.value.type zone_id = data.aws_route53_zone.zone.zone_id } resource "aws_acm_certificate_validation" "validation" { certificate_arn = aws_acm_certificate.certificate.arn validation_record_fqdns = [for record in aws_route53_record.route : record.fqdn] } resource "aws_api_gateway_domain_name" "domain" { domain_name = aws_acm_certificate.certificate.domain_name regional_certificate_arn = aws_acm_certificate.certificate.arn security_policy = "TLS_1_2" endpoint_configuration { types = ["REGIONAL"] } mutual_tls_authentication { truststore_uri = "s3://${data.aws_s3_object.api-truststore-certificate.bucket}/${data.aws_s3_object.api-truststore-certificate.key}" truststore_version = data.aws_s3_object.api-truststore-certificate.version_id } depends_on = [ aws_acm_certificate_validation.validation ] } resource "aws_route53_record" "cname" { zone_id = data.aws_route53_zone.zone.id name = local.apis.domain type = "CNAME" ttl = "5" records = [ aws_api_gateway_domain_name.domain.regional_domain_name ] } output "zone" { value = local.apis.zone } output "domain" { value = local.apis.domain } NRLF-3.0.31/terraform/infrastructure/ephemeral-resources.tf000066400000000000000000000006431511201605300237220ustar00rootroot00000000000000module "ephemeral-s3-permission-store" { count = var.use_shared_resources ? 0 : 1 source = "./modules/permissions-store-bucket" name_prefix = local.prefix enable_bucket_force_destroy = true } module "ephemeral-pointers-table" { count = var.use_shared_resources ? 0 : 1 source = "./modules/pointers-table" name_prefix = local.prefix } NRLF-3.0.31/terraform/infrastructure/etc/000077500000000000000000000000001511201605300201655ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/etc/dev.tfvars000066400000000000000000000004511511201605300221720ustar00rootroot00000000000000account_name = "dev" aws_account_name = "dev" domain = "api.record-locator.dev.national.nhs.uk" public_domain = "internal-dev.api.service.nhs.uk" public_sandbox_domain = "internal-dev-sandbox.api.service.nhs.uk" log_retention_period = 90 enable_reporting = false NRLF-3.0.31/terraform/infrastructure/etc/int.tfvars000066400000000000000000000004551511201605300222120ustar00rootroot00000000000000account_name = "int" aws_account_name = "test" domain = "api.record-locator.int.national.nhs.uk" deletion_protection = true public_domain = "int.api.service.nhs.uk" public_sandbox_domain = "sandbox.api.service.nhs.uk" log_retention_period = 90 enable_reporting = true NRLF-3.0.31/terraform/infrastructure/etc/perftest.tfvars000066400000000000000000000006041511201605300232500ustar00rootroot00000000000000account_name = "perftest" aws_account_name = "test" domain = "perftest.record-locator.national.nhs.uk" public_domain = "perftest.api.service.nhs.uk" deletion_protection = true log_retention_period = 30 enable_reporting = false disable_firehose_lambda_subscriptions = true NRLF-3.0.31/terraform/infrastructure/etc/prod.tfvars000066400000000000000000000003611511201605300223600ustar00rootroot00000000000000account_name = "prod" aws_account_name = "prod" domain = "api.record-locator.national.nhs.uk" public_domain = "api.service.nhs.uk" deletion_protection = true log_retention_period = 2192 enable_reporting = true NRLF-3.0.31/terraform/infrastructure/etc/qa.tfvars000066400000000000000000000004421511201605300220150ustar00rootroot00000000000000account_name = "qa" aws_account_name = "test" domain = "qa.record-locator.national.nhs.uk" public_domain = "internal-qa.api.service.nhs.uk" public_sandbox_domain = "internal-qa-sandbox.api.service.nhs.uk" log_retention_period = 90 enable_reporting = false NRLF-3.0.31/terraform/infrastructure/etc/ref.tfvars000066400000000000000000000003331511201605300221670ustar00rootroot00000000000000account_name = "ref" aws_account_name = "test" domain = "api.record-locator.ref.national.nhs.uk" public_domain = "ref.api.service.nhs.uk" log_retention_period = 30 enable_reporting = false NRLF-3.0.31/terraform/infrastructure/firehose.tf000066400000000000000000000011711511201605300215510ustar00rootroot00000000000000module "firehose__processor" { count = var.use_shared_resources && !var.disable_firehose_lambda_subscriptions ? 1 : 0 source = "./modules/firehose" assume_account = local.aws_account_id prefix = local.prefix region = local.region environment = local.environment cloudwatch_kms_arn = module.kms__cloudwatch.kms_arn splunk_environment = local.splunk_environment splunk_index = local.splunk_index destination = "splunk" reporting_bucket_arn = local.reporting_bucket_arn reporting_kms_arn = local.reporting_kms_arn } NRLF-3.0.31/terraform/infrastructure/kms.tf000066400000000000000000000002501511201605300205340ustar00rootroot00000000000000module "kms__cloudwatch" { source = "./modules/kms" name = "cloudwatch" assume_account = local.aws_account_id prefix = local.prefix } NRLF-3.0.31/terraform/infrastructure/lambda.tf000066400000000000000000000354201511201605300211710ustar00rootroot00000000000000module "consumer__readDocumentReference" { source = "./modules/lambda" parent_path = "api/consumer" name = "readDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.consumer__gateway.api_gateway_id}/*/GET/DocumentReference/{id}"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index AUTH_STORE = local.auth_store_id TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "read_document_reference.handler" retention = var.log_retention_period } module "consumer__searchDocumentReference" { source = "./modules/lambda" parent_path = "api/consumer" name = "searchDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.consumer__gateway.api_gateway_id}/*/GET/DocumentReference"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "search_document_reference.handler" retention = var.log_retention_period } module "consumer__searchPostDocumentReference" { source = "./modules/lambda" parent_path = "api/consumer" name = "searchPostDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.consumer__gateway.api_gateway_id}/*/POST/DocumentReference/_search"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "search_post_document_reference.handler" retention = var.log_retention_period } module "producer__createDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "createDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/POST/DocumentReference"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id SPLUNK_INDEX = local.splunk_index POWERTOOLS_LOG_LEVEL = local.log_level TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_write_policy_arn, local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "create_document_reference.handler" retention = var.log_retention_period } module "producer__deleteDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "deleteDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/DELETE/DocumentReference/{id}"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_write_policy_arn, local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "delete_document_reference.handler" retention = var.log_retention_period } module "producer__readDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "readDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/GET/DocumentReference/{id}"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "read_document_reference.handler" retention = var.log_retention_period } module "producer__searchDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "searchDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/GET/DocumentReference"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "search_document_reference.handler" retention = var.log_retention_period } module "producer__searchPostDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "searchPostDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/POST/DocumentReference/_search"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "search_post_document_reference.handler" retention = var.log_retention_period } module "producer__updateDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "updateDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/PUT/DocumentReference/{id}"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_table_write_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "update_document_reference.handler" retention = var.log_retention_period } module "producer__upsertDocumentReference" { source = "./modules/lambda" parent_path = "api/producer" name = "upsertDocumentReference" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/PUT/DocumentReference"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_write_policy_arn, local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehose_lambda_subscriptions handler = "upsert_document_reference.handler" retention = var.log_retention_period } module "consumer__status" { source = "./modules/lambda" parent_path = "api/consumer" name = "status" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.consumer__gateway.api_gateway_id}/*/GET/_status"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index DYNAMODB_TIMEOUT = local.dynamodb_timeout_seconds TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehost_lambda_splunk_only_subscription handler = "status.handler" retention = var.log_retention_period } module "producer__status" { source = "./modules/lambda" parent_path = "api/producer" name = "status" region = local.region prefix = local.prefix layers = [module.nrlf.layer_arn, module.third_party.layer_arn, module.nrlf_permissions.layer_arn] api_gateway_source_arn = ["arn:aws:execute-api:${local.region}:${local.aws_account_id}:${module.producer__gateway.api_gateway_id}/*/GET/_status"] kms_key_id = module.kms__cloudwatch.kms_arn environment_variables = { PREFIX = "${local.prefix}--" ENVIRONMENT = local.environment AUTH_STORE = local.auth_store_id POWERTOOLS_LOG_LEVEL = local.log_level SPLUNK_INDEX = local.splunk_index DYNAMODB_TIMEOUT = local.dynamodb_timeout_seconds TABLE_NAME = local.pointers_table_name } additional_policies = [ local.pointers_table_read_policy_arn, local.pointers_kms_read_write_arn, local.auth_store_read_policy_arn ] firehose_subscriptions = local.firehost_lambda_splunk_only_subscription handler = "status.handler" retention = var.log_retention_period } NRLF-3.0.31/terraform/infrastructure/layer.tf000066400000000000000000000004701511201605300210620ustar00rootroot00000000000000module "nrlf" { source = "./modules/layer" name = "nrlf" prefix = local.prefix } module "third_party" { source = "./modules/layer" name = "dependency_layer" prefix = local.prefix } module "nrlf_permissions" { source = "./modules/layer" name = "nrlf_permissions" prefix = local.prefix } NRLF-3.0.31/terraform/infrastructure/locals.tf000066400000000000000000000056261511201605300212330ustar00rootroot00000000000000locals { region = "eu-west-2" project = "nhsd-nrlf" stack_name = terraform.workspace deletion_protection = var.deletion_protection prefix = "${local.project}--${local.stack_name}" account_prefix = "${local.project}--${var.aws_account_name}" aws_account_id = data.aws_caller_identity.current.account_id kms = { deletion_window_in_days = 7 } apis = { zone = var.domain domain = "${terraform.workspace}.${var.domain}" consumer = { path = var.consumer_api_path } producer = { path = var.producer_api_path } } dynamodb_timeout_seconds = "3" is_sandbox_env = length(regexall("-sandbox-", local.stack_name)) > 0 environment = local.is_sandbox_env ? "${var.account_name}-sandbox" : var.account_name shared_prefix = "${local.project}--${local.environment}" public_domain = local.is_sandbox_env ? var.public_sandbox_domain : var.public_domain reporting_bucket_arn = data.aws_s3_bucket.source-data-bucket.arn reporting_kms_arn = data.aws_kms_key.glue.arn firehose_lambda_subscriptions = var.use_shared_resources && !var.disable_firehose_lambda_subscriptions ? ( var.enable_reporting ? { "splunk_subscription" = module.firehose__processor[0].firehose_subscription, "reports_subscription" = module.firehose__processor[0].firehose_reporting_subscription } : { "splunk_subscription" = module.firehose__processor[0].firehose_subscription } ) : {} firehost_lambda_splunk_only_subscription = var.use_shared_resources && !var.disable_firehose_lambda_subscriptions ? { "splunk_subscription" : module.firehose__processor[0].firehose_subscription } : {} splunk_environment = local.is_sandbox_env ? "${var.account_name}sandbox" : var.account_name splunk_index = "aws_recordlocator_${local.splunk_environment}" log_level = var.account_name == "dev" || var.account_name == "qa" ? "DEBUG" : "INFO" auth_store_id = var.use_shared_resources ? data.aws_s3_bucket.authorization-store[0].id : module.ephemeral-s3-permission-store[0].bucket_id auth_store_read_policy_arn = var.use_shared_resources ? data.aws_iam_policy.auth-store-read-policy[0].arn : module.ephemeral-s3-permission-store[0].bucket_read_policy_arn pointers_table_name = var.use_shared_resources ? data.aws_dynamodb_table.pointers-table[0].name : module.ephemeral-pointers-table[0].table_name pointers_table_read_policy_arn = var.use_shared_resources ? data.aws_iam_policy.pointers-table-read[0].arn : module.ephemeral-pointers-table[0].read_policy_arn pointers_table_write_policy_arn = var.use_shared_resources ? data.aws_iam_policy.pointers-table-write[0].arn : module.ephemeral-pointers-table[0].write_policy_arn pointers_kms_read_write_arn = var.use_shared_resources ? data.aws_iam_policy.pointers-kms-read-write[0].arn : module.ephemeral-pointers-table[0].kms_read_write_policy_arn } NRLF-3.0.31/terraform/infrastructure/main.tf000066400000000000000000000013241511201605300206710ustar00rootroot00000000000000provider "aws" { region = local.region assume_role { role_arn = var.assume_role_arn } default_tags { tags = { project_name = local.project workspace = terraform.workspace } } } terraform { backend "s3" { encrypt = false region = "eu-west-2" bucket = "nhsd-nrlf--terraform-state" dynamodb_table = "nhsd-nrlf--terraform-state-lock" key = "terraform-state-infrastructure" workspace_key_prefix = "nhsd-nrlf" } required_providers { aws = { source = "hashicorp/aws" version = "~> 5.0" } random = { source = "hashicorp/random" version = "~> 3.0" } } } NRLF-3.0.31/terraform/infrastructure/modules/000077500000000000000000000000001511201605300210625ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/000077500000000000000000000000001511201605300233545ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/api_gateway.tf000066400000000000000000000102131511201605300261760ustar00rootroot00000000000000resource "aws_api_gateway_rest_api" "api_gateway_rest_api" { name = "${var.prefix}--${var.apitype}" description = "Manages an API Gateway Rest API." disable_execute_api_endpoint = true body = templatefile( "${path.module}/../../../../api/${var.apitype}/swagger.yaml", merge(var.lambdas, { capability_statement_json = var.capability_statement_content }) ) } resource "aws_api_gateway_deployment" "api_gateway_deployment" { rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id triggers = { redeployment = sha1(jsonencode(aws_api_gateway_rest_api.api_gateway_rest_api.body)) resource_change = "${md5(file("${path.module}/api_gateway.tf"))}" capabilities = sha1(var.capability_statement_content) head_responses_change = md5(file("${path.module}/head_responses.tf")) parent_api_gateway_change = md5(file("${path.module}/../../api_gateway.tf")) } lifecycle { create_before_destroy = true } depends_on = [ aws_api_gateway_rest_api.api_gateway_rest_api, aws_api_gateway_integration_response.head_integration_response ] } resource "aws_api_gateway_stage" "api_gateway_stage" { deployment_id = aws_api_gateway_deployment.api_gateway_deployment.id rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id stage_name = "production" xray_tracing_enabled = true access_log_settings { destination_arn = aws_cloudwatch_log_group.api_gateway_access_logs.arn format = jsonencode({ requestid : "$context.requestId", ip : "$context.identity.sourceIp", user_agent : "$context.identity.userAgent", request_time : "$context.requestTime", http_method : "$context.httpMethod", path : "$context.path", status : "$context.status", protocol : "$context.protocol", response_length : "$context.responseLength", x_correlationid : "$context.authorizer.x-correlation-id", nhsd_correlationid : "$context.authorizer.nhsd-correlation-id" environment : terraform.workspace }) } depends_on = [ aws_api_gateway_deployment.api_gateway_deployment, aws_api_gateway_rest_api.api_gateway_rest_api, aws_cloudwatch_log_group.api_gateway_access_logs ] } resource "aws_api_gateway_method_settings" "api_gateway_method_settings" { rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id stage_name = aws_api_gateway_stage.api_gateway_stage.stage_name method_path = "*/*" settings { logging_level = "ERROR" data_trace_enabled = true } depends_on = [ aws_api_gateway_rest_api.api_gateway_rest_api, aws_api_gateway_stage.api_gateway_stage ] } resource "aws_api_gateway_gateway_response" "api_access_denied" { rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id status_code = "403" response_type = "ACCESS_DENIED" response_templates = { "application/json" = jsonencode({ resourceType : "OperationOutcome", issue : [{ severity : "error", code : "processing", diagnostics : "$context.authorizer.error" }] }) } response_parameters = { "gatewayresponse.header.Access-Control-Allow-Origin" = "'*'" } } resource "aws_api_gateway_gateway_response" "api_default_4xx" { rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id response_type = "DEFAULT_4XX" response_templates = { "application/json" = jsonencode({ resourceType : "OperationOutcome", issue : [{ severity : "error", code : "processing" diagnostics : "$context.error.message" }] }) } response_parameters = { "gatewayresponse.header.Access-Control-Allow-Origin" = "'*'" } } resource "aws_api_gateway_gateway_response" "api_default_5xx" { rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id response_type = "DEFAULT_5XX" response_templates = { "application/json" = jsonencode({ resourceType : "OperationOutcome", issue : [{ severity : "error", code : "exception" }] }) } response_parameters = { "gatewayresponse.header.Access-Control-Allow-Origin" = "'*'" } } NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/cloudwatch.tf000066400000000000000000000011411511201605300260410ustar00rootroot00000000000000resource "aws_cloudwatch_log_group" "api_gateway_access_logs" { name = "/aws/api-gateway/access-logs/${aws_api_gateway_rest_api.api_gateway_rest_api.name}" kms_key_id = var.kms_key_id depends_on = [ aws_api_gateway_rest_api.api_gateway_rest_api ] retention_in_days = var.retention } resource "aws_cloudwatch_log_group" "api_gateway_execution_logs" { name = "API-Gateway-Execution-Logs_${aws_api_gateway_rest_api.api_gateway_rest_api.id}/production" kms_key_id = var.kms_key_id depends_on = [ aws_api_gateway_rest_api.api_gateway_rest_api ] retention_in_days = var.retention } NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/custom_domain_mapping.tf000066400000000000000000000004641511201605300302670ustar00rootroot00000000000000resource "aws_api_gateway_base_path_mapping" "mapping" { api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id stage_name = aws_api_gateway_stage.api_gateway_stage.stage_name domain_name = var.domain base_path = var.path depends_on = [ aws_api_gateway_stage.api_gateway_stage ] } NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/head_responses.tf000066400000000000000000000043661511201605300267220ustar00rootroot00000000000000# Define a reusable map of allowed methods for each path data "aws_api_gateway_resource" "resource" { for_each = var.endpoint_allowed_methods rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id path = each.key depends_on = [aws_api_gateway_rest_api.api_gateway_rest_api] } # Add HEAD method to each resource with 405 response resource "aws_api_gateway_method" "head_method" { for_each = var.endpoint_allowed_methods rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id resource_id = data.aws_api_gateway_resource.resource[each.key].id http_method = "HEAD" authorization = "NONE" } resource "aws_api_gateway_integration" "head_integration" { for_each = var.endpoint_allowed_methods rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id resource_id = data.aws_api_gateway_resource.resource[each.key].id http_method = aws_api_gateway_method.head_method[each.key].http_method type = "MOCK" passthrough_behavior = "WHEN_NO_TEMPLATES" request_templates = { "application/json" = <<-EOF { "statusCode": 405 } EOF "application/json+fhir" = <<-EOF { "statusCode": 405 } EOF "application/fhir+json" = <<-EOF { "statusCode": 405 } EOF } } resource "aws_api_gateway_method_response" "head_method_response" { for_each = var.endpoint_allowed_methods rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id resource_id = data.aws_api_gateway_resource.resource[each.key].id http_method = aws_api_gateway_method.head_method[each.key].http_method status_code = "405" response_parameters = { "method.response.header.Allow" = true } } resource "aws_api_gateway_integration_response" "head_integration_response" { for_each = var.endpoint_allowed_methods rest_api_id = aws_api_gateway_rest_api.api_gateway_rest_api.id resource_id = data.aws_api_gateway_resource.resource[each.key].id http_method = aws_api_gateway_method.head_method[each.key].http_method status_code = aws_api_gateway_method_response.head_method_response[each.key].status_code selection_pattern = "" # default catch-all response_parameters = { "method.response.header.Allow" = "'${each.value}'" } } NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/iam.tf000066400000000000000000000005631511201605300244610ustar00rootroot00000000000000resource "aws_iam_role" "api_authorizer" { name = "${var.prefix}-${var.apitype}-api-authorizer" assume_role_policy = jsonencode({ Version = "2012-10-17", Statement = [ { Action = "sts:AssumeRole", Principal = { Service = "apigateway.amazonaws.com" }, Effect = "Allow", Sid = "" } ] }) } NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/output.tf000066400000000000000000000002401511201605300252430ustar00rootroot00000000000000output "api_gateway_id" { value = aws_api_gateway_rest_api.api_gateway_rest_api.id } output "api_base_url" { value = "https://${var.domain}/${var.path}" } NRLF-3.0.31/terraform/infrastructure/modules/api_gateway/vars.tf000066400000000000000000000005401511201605300246610ustar00rootroot00000000000000variable "prefix" {} variable "apitype" {} variable "lambdas" {} variable "kms_key_id" {} variable "domain" { type = string } variable "path" { type = string } variable "capability_statement_content" { type = string } variable "retention" { default = 90 type = number } variable "endpoint_allowed_methods" { type = map(string) } NRLF-3.0.31/terraform/infrastructure/modules/firehose/000077500000000000000000000000001511201605300226665ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/firehose/cloudwatch.tf000066400000000000000000000013031511201605300253530ustar00rootroot00000000000000resource "aws_cloudwatch_log_group" "firehose" { name = "/aws/kinesisfirehose/${var.prefix}-firehose" retention_in_days = local.cloudwatch.retention.days } resource "aws_cloudwatch_log_stream" "firehose" { name = "${var.prefix}-firehose" log_group_name = aws_cloudwatch_log_group.firehose.name } resource "aws_cloudwatch_log_group" "firehose_reporting" { name = "/aws/kinesisfirehose/${var.prefix}-firehose-reporting" retention_in_days = local.cloudwatch.retention.days } resource "aws_cloudwatch_log_stream" "firehose_reporting" { name = "${var.prefix}-firehose-reporting" log_group_name = aws_cloudwatch_log_group.firehose_reporting.name } NRLF-3.0.31/terraform/infrastructure/modules/firehose/iam_firehose.tf000066400000000000000000000035371511201605300256630ustar00rootroot00000000000000 resource "aws_iam_role" "firehose" { name = "${var.prefix}-firehose" description = "IAM Role for Kinesis Firehose" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { Service : "firehose.amazonaws.com" }, Effect : "Allow", Sid : "" } ] }) } data "aws_iam_policy_document" "firehose" { statement { actions = [ "s3:AbortMultipartUpload", "s3:GetBucketLocation", "s3:GetObject", "s3:ListBucket", "s3:ListBucketMultipartUploads", "s3:PutObject", ] resources = compact([ aws_s3_bucket.firehose.arn, "${aws_s3_bucket.firehose.arn}/*", var.reporting_bucket_arn, local.iam_firehose.reporting_s3_arn, ]) effect = "Allow" } statement { actions = [ "kms:DescribeKey", "kms:GenerateDataKey*", "kms:Encrypt", "kms:ReEncrypt*", "kms:Decrypt", ] resources = local.iam_kms_resources } statement { actions = [ "kms:DescribeKey", "kms:Decrypt", ] resources = [ "${var.cloudwatch_kms_arn}", ] } statement { actions = [ "kms:ListAliases", ] resources = ["*"] } statement { actions = [ "logs:PutLogEvents", ] resources = compact([ aws_cloudwatch_log_group.firehose.arn, aws_cloudwatch_log_stream.firehose.arn, local.iam_firehose.cloudwatch_reporting_log_group_arn, local.iam_firehose.cloudwatch_reporting_log_stream_arn, ]) effect = "Allow" } } resource "aws_iam_policy" "firehose" { name = "${var.prefix}-firehose" policy = data.aws_iam_policy_document.firehose.json } resource "aws_iam_role_policy_attachment" "firehose" { role = aws_iam_role.firehose.name policy_arn = aws_iam_policy.firehose.arn } NRLF-3.0.31/terraform/infrastructure/modules/firehose/iam_subscriptions.tf000066400000000000000000000024101511201605300267530ustar00rootroot00000000000000resource "aws_iam_role" "firehose_subscription" { name = "${var.prefix}-firehose-subscription" description = "Role for CloudWatch Log Group subscription" assume_role_policy = jsonencode({ Version : "2012-10-17", Statement : [ { Action : "sts:AssumeRole", Principal : { Service : "logs.eu-west-2.amazonaws.com" }, Effect : "Allow", Sid : "" } ] }) } data "aws_iam_policy_document" "firehose_subscription" { statement { actions = [ "firehose:*", ] effect = "Allow" resources = compact([ aws_kinesis_firehose_delivery_stream.firehose.arn, local.iam_subscriptions.firehose_reporting_stream_arn, ]) } statement { actions = [ "iam:PassRole", ] effect = "Allow" resources = [ aws_iam_role.firehose_subscription.arn ] } } resource "aws_iam_policy" "firehose_subscription" { name = "${var.prefix}-firehose-subscription" description = "Cloudwatch to Firehose Subscription Policy" policy = data.aws_iam_policy_document.firehose_subscription.json } resource "aws_iam_role_policy_attachment" "firehose_subscription" { role = aws_iam_role.firehose_subscription.name policy_arn = aws_iam_policy.firehose_subscription.arn } NRLF-3.0.31/terraform/infrastructure/modules/firehose/kinesis.tf000066400000000000000000000054541511201605300246760ustar00rootroot00000000000000 locals { splunk_configuration = jsondecode(data.aws_secretsmanager_secret_version.splunk_configuration.secret_string) hec_endpoint = "https://${local.splunk_configuration["nhs_splunk_url"]}/services/collector/event" hec_token = local.splunk_configuration["hec_token"] } resource "aws_kinesis_firehose_delivery_stream" "firehose" { name = "${var.prefix}--cloudwatch-delivery-stream" destination = var.destination splunk_configuration { hec_endpoint = local.hec_endpoint hec_token = local.hec_token hec_acknowledgment_timeout = 300 hec_endpoint_type = "Event" s3_backup_mode = "FailedEventsOnly" retry_duration = 0 processing_configuration { enabled = "true" processors { type = "Decompression" parameters { parameter_name = "CompressionFormat" parameter_value = "GZIP" } } processors { type = "CloudWatchLogProcessing" parameters { parameter_name = "DataMessageExtraction" parameter_value = "true" } } } cloudwatch_logging_options { enabled = true log_group_name = aws_cloudwatch_log_group.firehose.name log_stream_name = aws_cloudwatch_log_stream.firehose.name } s3_configuration { role_arn = aws_iam_role.firehose.arn prefix = "processing-failed/${local.s3_configuration.prefix}" error_output_prefix = local.s3_configuration.error_output_prefix bucket_arn = aws_s3_bucket.firehose.arn buffering_size = local.s3_configuration.buffer_size buffering_interval = local.s3_configuration.buffer_interval compression_format = local.s3_configuration.compression_format } } } resource "aws_kinesis_firehose_delivery_stream" "reporting_stream" { name = "${var.prefix}--cloudwatch-reporting-delivery-stream" destination = "extended_s3" extended_s3_configuration { role_arn = aws_iam_role.firehose.arn bucket_arn = var.reporting_bucket_arn buffering_size = 64 buffering_interval = 600 processing_configuration { enabled = true processors { type = "Decompression" parameters { parameter_name = "CompressionFormat" parameter_value = "GZIP" } } processors { type = "CloudWatchLogProcessing" parameters { parameter_name = "DataMessageExtraction" parameter_value = "true" } } } cloudwatch_logging_options { enabled = true log_group_name = aws_cloudwatch_log_group.firehose_reporting.name log_stream_name = aws_cloudwatch_log_stream.firehose_reporting.name } } } NRLF-3.0.31/terraform/infrastructure/modules/firehose/kms.tf000066400000000000000000000002561511201605300240160ustar00rootroot00000000000000resource "aws_kms_key" "firehose" { } resource "aws_kms_alias" "firehose" { name = "alias/${var.prefix}-firehose" target_key_id = aws_kms_key.firehose.key_id } NRLF-3.0.31/terraform/infrastructure/modules/firehose/locals.tf000066400000000000000000000024261511201605300245020ustar00rootroot00000000000000locals { s3 = { transition_storage = { infrequent_access = { storage_class = "STANDARD_IA" days = 150 } glacier = { storage_class = "GLACIER" days = 200 } } expiration = { days = 1095 } } cloudwatch = { retention = { days = 30 } } s3_configuration = { # Note could add partition key info to prefix to help debug, requires more investigation prefix = "!{timestamp:yyyy}/!{timestamp:MM}/!{timestamp:dd}/!{timestamp:HH}/" error_output_prefix = "${var.error_prefix}/!{timestamp:yyyy}/!{timestamp:MM}/!{timestamp:dd}/!{timestamp:HH}/!{firehose:error-output-type}/" buffer_size = 5 buffer_interval = 300 compression_format = "GZIP" } iam_firehose = { cloudwatch_reporting_log_group_arn = aws_cloudwatch_log_group.firehose_reporting.arn cloudwatch_reporting_log_stream_arn = aws_cloudwatch_log_stream.firehose_reporting.arn reporting_s3_arn = "${var.reporting_bucket_arn}/*" } iam_subscriptions = { firehose_reporting_stream_arn = aws_kinesis_firehose_delivery_stream.reporting_stream.arn } iam_kms_resources = compact([ aws_kms_key.firehose.arn, var.reporting_kms_arn ]) } NRLF-3.0.31/terraform/infrastructure/modules/firehose/output.tf000066400000000000000000000034451511201605300245670ustar00rootroot00000000000000output "delivery_stream" { value = { arn = aws_kinesis_firehose_delivery_stream.firehose.arn s3 = { # By concatenating the extended_s3_configuration and s3_configuration we get the S3 bucket data in either the case # that we've enabled Splunk (persistent environments) or not enabled Splunk (developer and CI workspaces) arn = aws_kinesis_firehose_delivery_stream.firehose.splunk_configuration[0].s3_configuration.*.bucket_arn prefix = aws_kinesis_firehose_delivery_stream.firehose.splunk_configuration[0].s3_configuration.*.prefix error_prefix = aws_kinesis_firehose_delivery_stream.firehose.splunk_configuration[0].s3_configuration.*.error_output_prefix } } } output "firehose_subscription" { value = { destination = { arn = aws_kinesis_firehose_delivery_stream.firehose.arn } role = { arn = aws_iam_role.firehose_subscription.arn } filter = { # At least two items, and the first not any of INIT_START, START, END, REPORT pattern = "[first_item_on_this_log_line != \"INIT_START\" && first_item_on_this_log_line != \"START\" && first_item_on_this_log_line != \"END\" && first_item_on_this_log_line != \"REPORT\", everything_else_on_this_log_line]" } } } output "firehose_reporting_subscription" { value = { destination = { arn = local.iam_subscriptions.firehose_reporting_stream_arn } role = { arn = aws_iam_role.firehose_subscription.arn } filter = { # At least two items, and the first not any of INIT_START, START, END, REPORT pattern = "[first_item_on_this_log_line != \"INIT_START\" && first_item_on_this_log_line != \"START\" && first_item_on_this_log_line != \"END\" && first_item_on_this_log_line != \"REPORT\", everything_else_on_this_log_line]" } } } NRLF-3.0.31/terraform/infrastructure/modules/firehose/s3.tf000066400000000000000000000047441511201605300235570ustar00rootroot00000000000000resource "aws_s3_bucket" "firehose" { bucket = "${var.prefix}-firehose" force_destroy = true } resource "aws_s3_bucket_server_side_encryption_configuration" "firehose" { bucket = aws_s3_bucket.firehose.id rule { apply_server_side_encryption_by_default { kms_master_key_id = aws_kms_key.firehose.arn sse_algorithm = "aws:kms" } } } resource "aws_s3_bucket_policy" "firehose-policy" { bucket = aws_s3_bucket.firehose.id policy = jsonencode({ Version = "2012-10-17" Id = "firehose-policy" Statement = [ { Sid = "HTTPSOnly" Effect = "Deny" Principal = "*" Action = "s3:*" Resource = [ aws_s3_bucket.firehose.arn, "${aws_s3_bucket.firehose.arn}/*", ] Condition = { Bool = { "aws:SecureTransport" = "false" } } }, ] }) } resource "aws_s3_bucket_public_access_block" "firehose-public-access-block" { bucket = aws_s3_bucket.firehose.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_lifecycle_configuration" "firehose" { bucket = aws_s3_bucket.firehose.id rule { id = "FirehoseLifecycle" status = "Enabled" transition { days = local.s3.transition_storage.infrequent_access.days storage_class = local.s3.transition_storage.infrequent_access.storage_class } transition { days = local.s3.transition_storage.glacier.days storage_class = local.s3.transition_storage.glacier.storage_class } expiration { days = local.s3.expiration.days } } } resource "aws_s3_bucket_versioning" "firehose" { bucket = aws_s3_bucket.firehose.id versioning_configuration { status = "Enabled" } } resource "aws_iam_policy" "firehose-alert--s3-read" { name = "${var.prefix}--firehose-alert--s3-read" description = "Read errors files from the Firehose S3 bucket" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey" ] Effect = "Allow" Resource = [ aws_kms_key.firehose.arn ] }, { Action = [ "s3:GetObject" ] Effect = "Allow" Resource = [ "${aws_s3_bucket.firehose.arn}/${var.error_prefix}/*" ] } ] }) } NRLF-3.0.31/terraform/infrastructure/modules/firehose/secrets.tf000066400000000000000000000005471511201605300246770ustar00rootroot00000000000000data "aws_secretsmanager_secret_version" "splunk_configuration" { # Note that this secret should have a value which is a JSON string # according to the following template: # # { # "nhs_splunk_url": "mysplunkserver.example.com:8088", # "hec_token": "12345" # } # secret_id = "nhsd-nrlf--${var.splunk_environment}--splunk-configuration" } NRLF-3.0.31/terraform/infrastructure/modules/firehose/vars.tf000066400000000000000000000015671511201605300242050ustar00rootroot00000000000000variable "prefix" {} variable "assume_account" {} variable "region" {} variable "environment" {} variable "cloudwatch_kms_arn" {} variable "destination" { default = "extended_s3" type = string validation { condition = contains(["splunk", "extended_s3"], var.destination) error_message = "Valid value is one of the following: splunk, extended_s3." } } variable "splunk_environment" { type = string } variable "splunk_index" { type = string default = "aws_recordlocator_dev" validation { condition = startswith(var.splunk_index, "aws_recordlocator_") error_message = "Splunk Index must start with aws_recordlocator_" } } variable "error_prefix" { type = string default = "errors" } variable "reporting_bucket_arn" { type = string default = null } variable "reporting_kms_arn" { type = string default = null } NRLF-3.0.31/terraform/infrastructure/modules/kms/000077500000000000000000000000001511201605300216545ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/kms/iam.tf000066400000000000000000000016661511201605300227660ustar00rootroot00000000000000data "aws_iam_policy_document" "policy_document" { source_policy_documents = [ data.aws_iam_policy_document.kms_default_policy.json ] statement { principals { type = "Service" identifiers = [ "logs.eu-west-2.amazonaws.com" ] } actions = [ "kms:Encrypt*", "kms:Decrypt*", "kms:ReEncrypt*", "kms:GenerateDataKey*", "kms:Describe*" ] resources = ["*"] condition { test = "ArnLike" variable = "kms:EncryptionContext:aws:logs:arn" values = [ "arn:aws:logs:eu-west-2:${var.assume_account}:log-group:*" ] } } } data "aws_iam_policy_document" "kms_default_policy" { statement { principals { type = "AWS" identifiers = [ "arn:aws:iam::${var.assume_account}:root", ] } actions = [ "kms:*", ] resources = [ "*" ] sid = "Enable IAM User Permissions" } } NRLF-3.0.31/terraform/infrastructure/modules/kms/kms.tf000066400000000000000000000006251511201605300230040ustar00rootroot00000000000000resource "aws_kms_key" "kms_key" { description = "${title(var.name)} KMS key" deletion_window_in_days = local.kms.deletion_window_in_days policy = data.aws_iam_policy_document.policy_document.json } resource "aws_kms_alias" "kms_alias" { name = "alias/${var.prefix}--${var.name}" target_key_id = aws_kms_key.kms_key.key_id depends_on = [ aws_kms_key.kms_key ] } NRLF-3.0.31/terraform/infrastructure/modules/kms/locals.tf000066400000000000000000000000711511201605300234620ustar00rootroot00000000000000locals { kms = { deletion_window_in_days = 7 } } NRLF-3.0.31/terraform/infrastructure/modules/kms/output.tf000066400000000000000000000000671511201605300235520ustar00rootroot00000000000000output "kms_arn" { value = aws_kms_key.kms_key.arn } NRLF-3.0.31/terraform/infrastructure/modules/kms/vars.tf000066400000000000000000000001071511201605300231600ustar00rootroot00000000000000variable "prefix" {} variable "name" {} variable "assume_account" {} NRLF-3.0.31/terraform/infrastructure/modules/kms_read_write_policy/000077500000000000000000000000001511201605300254405ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/kms_read_write_policy/iam.tf000066400000000000000000000014421511201605300265420ustar00rootroot00000000000000resource "aws_iam_policy" "kms-read-write" { name = "${var.prefix}--${var.name}--kms-read-write" description = "Encrypt and decrypt with the kms key" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey", "kms:Encrypt", "kms:GenerateDataKey" ] Effect = "Allow" Resource = [ aws_kms_key.kms_key.arn ] } ] }) } data "aws_iam_policy_document" "kms_default_policy" { statement { principals { type = "AWS" identifiers = [ "arn:aws:iam::${var.assume_account}:root", ] } actions = [ "kms:*", ] resources = [ "*" ] sid = "Enable IAM User Permissions" } } NRLF-3.0.31/terraform/infrastructure/modules/kms_read_write_policy/kms.tf000066400000000000000000000006341511201605300265700ustar00rootroot00000000000000resource "aws_kms_key" "kms_key" { description = "${title(var.name)} table KMS key" deletion_window_in_days = local.kms.deletion_window_in_days #policy = data.aws_iam_policy_document.policy_document.json } resource "aws_kms_alias" "kms_alias" { name = "alias/${var.prefix}--${var.name}" target_key_id = aws_kms_key.kms_key.key_id depends_on = [ aws_kms_key.kms_key ] } NRLF-3.0.31/terraform/infrastructure/modules/kms_read_write_policy/locals.tf000066400000000000000000000000711511201605300272460ustar00rootroot00000000000000locals { kms = { deletion_window_in_days = 7 } } NRLF-3.0.31/terraform/infrastructure/modules/kms_read_write_policy/output.tf000066400000000000000000000000671511201605300273360ustar00rootroot00000000000000output "kms_arn" { value = aws_kms_key.kms_key.arn } NRLF-3.0.31/terraform/infrastructure/modules/kms_read_write_policy/vars.tf000066400000000000000000000001071511201605300267440ustar00rootroot00000000000000variable "prefix" {} variable "name" {} variable "assume_account" {} NRLF-3.0.31/terraform/infrastructure/modules/lambda/000077500000000000000000000000001511201605300223025ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/lambda/cloudwatch.tf000066400000000000000000000012151511201605300247710ustar00rootroot00000000000000resource "aws_cloudwatch_log_group" "lambda_cloudwatch_log_group" { name = "/aws/lambda/${aws_lambda_function.lambda_function.function_name}" retention_in_days = var.retention kms_key_id = var.kms_key_id } resource "aws_cloudwatch_log_subscription_filter" "lambda_log_filter" { for_each = var.firehose_subscriptions name = "${aws_lambda_function.lambda_function.function_name}_${each.key}_filter" log_group_name = aws_cloudwatch_log_group.lambda_cloudwatch_log_group.name role_arn = each.value.role.arn destination_arn = each.value.destination.arn filter_pattern = each.value.filter.pattern } NRLF-3.0.31/terraform/infrastructure/modules/lambda/iam.tf000066400000000000000000000015151511201605300234050ustar00rootroot00000000000000resource "aws_iam_role" "lambda_role" { name = substr("${var.prefix}--${replace(var.parent_path, "/", "--")}--${var.name}", 0, 64) assume_role_policy = jsonencode({ Version = "2012-10-17", Statement = [ { Effect = "Allow", Principal = { Service = "lambda.amazonaws.com" }, Action = "sts:AssumeRole" } ] }) } resource "aws_iam_role_policy_attachment" "lambda_policy_attachment" { role = aws_iam_role.lambda_role.name policy_arn = "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole" depends_on = [ aws_iam_role.lambda_role ] } resource "aws_iam_role_policy_attachment" "additional_policies" { role = aws_iam_role.lambda_role.name count = length(var.additional_policies) policy_arn = var.additional_policies[count.index] } NRLF-3.0.31/terraform/infrastructure/modules/lambda/lambda.tf000066400000000000000000000031201511201605300240510ustar00rootroot00000000000000resource "aws_lambda_function" "lambda_function" { function_name = substr("${var.prefix}--${replace(var.parent_path, "/", "--")}--${var.name}", 0, 64) runtime = "python3.12" handler = var.handler role = aws_iam_role.lambda_role.arn filename = "${path.module}/../../../../dist/${local.api_type}-${var.name}.zip" source_code_hash = filebase64sha256("${path.module}/../../../../dist/${local.api_type}-${var.name}.zip") timeout = local.lambda_timeout memory_size = 512 environment { variables = merge(var.environment_variables, { "SOURCE" : "${var.prefix}--${replace(var.parent_path, "/", "--")}--${var.name}" }) } layers = var.layers depends_on = [ aws_iam_role.lambda_role ] dynamic "vpc_config" { for_each = length(var.vpc) > 0 ? toset([1]) : toset([]) content { subnet_ids = var.vpc.subnet_ids security_group_ids = var.vpc.security_group_ids } } } resource "aws_lambda_runtime_management_config" "lambda_runtime_config" { function_name = aws_lambda_function.lambda_function.function_name update_runtime_on = "FunctionUpdate" } resource "aws_lambda_permission" "lambda_permission" { count = length(var.api_gateway_source_arn) statement_id = "AllowExecutionFromAPIGateway-${count.index}" action = "lambda:InvokeFunction" function_name = aws_lambda_function.lambda_function.function_name principal = "apigateway.amazonaws.com" source_arn = var.api_gateway_source_arn[count.index] depends_on = [ aws_lambda_function.lambda_function ] } NRLF-3.0.31/terraform/infrastructure/modules/lambda/locals.tf000066400000000000000000000002231511201605300241070ustar00rootroot00000000000000locals { lambda_timeout = 30 lambda_log_retention_in_days = 30 api_type = split("/", var.parent_path)[1] } NRLF-3.0.31/terraform/infrastructure/modules/lambda/output.tf000066400000000000000000000006251511201605300242000ustar00rootroot00000000000000output "invoke_arn" { value = aws_lambda_function.lambda_function.invoke_arn } output "arn" { value = aws_lambda_function.lambda_function.arn } output "function_name" { value = aws_lambda_function.lambda_function.function_name } output "log_group_name" { value = aws_cloudwatch_log_group.lambda_cloudwatch_log_group.name } output "lambda_role_name" { value = aws_iam_role.lambda_role.name } NRLF-3.0.31/terraform/infrastructure/modules/lambda/vars.tf000066400000000000000000000010531511201605300236070ustar00rootroot00000000000000variable "prefix" {} variable "region" {} variable "parent_path" {} variable "name" {} variable "api_gateway_source_arn" { default = [] } variable "layers" {} variable "kms_key_id" {} variable "environment_variables" {} variable "additional_policies" { default = [] } variable "handler" {} variable "firehose_subscriptions" { description = "The firehose subscriptions to attach to the lambda logs" type = map(any) default = {} } variable "vpc" { default = {} } variable "retention" { default = 90 type = number } NRLF-3.0.31/terraform/infrastructure/modules/layer/000077500000000000000000000000001511201605300221765ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/layer/lambda_layer.tf000066400000000000000000000005141511201605300251450ustar00rootroot00000000000000resource "aws_lambda_layer_version" "lambda_layer" { layer_name = "${var.prefix}--${replace(var.name, "_", "-")}" filename = "${path.module}/../../../../dist/${var.name}.zip" source_code_hash = filebase64sha256("${path.module}/../../../../dist/${var.name}.zip") compatible_runtimes = ["python3.12"] } NRLF-3.0.31/terraform/infrastructure/modules/layer/output.tf000066400000000000000000000001131511201605300240640ustar00rootroot00000000000000output "layer_arn" { value = aws_lambda_layer_version.lambda_layer.arn } NRLF-3.0.31/terraform/infrastructure/modules/layer/vars.tf000066400000000000000000000000511511201605300235000ustar00rootroot00000000000000variable "prefix" {} variable "name" {} NRLF-3.0.31/terraform/infrastructure/modules/permissions-store-bucket/000077500000000000000000000000001511201605300260425ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/permissions-store-bucket/iam.tf000066400000000000000000000010121511201605300271350ustar00rootroot00000000000000resource "aws_iam_policy" "read-s3-authorization-store" { name = "${var.name_prefix}-read-s3-authorization-store" description = "Read the authorization store S3 bucket" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "s3:GetObject", "s3:ListBucket", ] Effect = "Allow" Resource = [ aws_s3_bucket.authorization-store.arn, "${aws_s3_bucket.authorization-store.arn}/*", ] }, ] }) } NRLF-3.0.31/terraform/infrastructure/modules/permissions-store-bucket/output.tf000066400000000000000000000006771511201605300277470ustar00rootroot00000000000000output "bucket_arn" { description = "Name of the authorization store S3 bucket" value = aws_s3_bucket.authorization-store.arn } output "bucket_id" { description = "Name of the authorization store S3 bucket" value = aws_s3_bucket.authorization-store.id } output "bucket_read_policy_arn" { description = "Policy to read from the authorization store S3 bucket" value = aws_iam_policy.read-s3-authorization-store.arn } NRLF-3.0.31/terraform/infrastructure/modules/permissions-store-bucket/s3.tf000066400000000000000000000016451511201605300267300ustar00rootroot00000000000000resource "aws_s3_bucket" "authorization-store" { bucket = "${var.name_prefix}-authorization-store" force_destroy = var.enable_bucket_force_destroy tags = { Name = "authorization store" Environment = "${var.name_prefix}" } } resource "aws_s3_bucket_public_access_block" "authorization-store-public-access-block" { bucket = aws_s3_bucket.authorization-store.id block_public_acls = true block_public_policy = true ignore_public_acls = true restrict_public_buckets = true } resource "aws_s3_bucket_server_side_encryption_configuration" "authorization-store" { bucket = aws_s3_bucket.authorization-store.bucket rule { apply_server_side_encryption_by_default { sse_algorithm = "AES256" } } } resource "aws_s3_bucket_versioning" "authorization-store" { bucket = aws_s3_bucket.authorization-store.id versioning_configuration { status = "Enabled" } } NRLF-3.0.31/terraform/infrastructure/modules/permissions-store-bucket/vars.tf000066400000000000000000000005461511201605300273550ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "enable_bucket_force_destroy" { type = bool description = "A boolean flag to enable force destroy of the S3 bucket, so that all objects in the bucket are deleted when the bucket is destroyed." default = false } NRLF-3.0.31/terraform/infrastructure/modules/pointers-table/000077500000000000000000000000001511201605300240125ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/pointers-table/dynamodb.tf000066400000000000000000000020341511201605300261410ustar00rootroot00000000000000resource "aws_dynamodb_table" "pointers" { name = "${var.name_prefix}-pointers-table" billing_mode = "PAY_PER_REQUEST" hash_key = "pk" range_key = "sk" deletion_protection_enabled = var.enable_deletion_protection attribute { name = "pk" type = "S" } attribute { name = "sk" type = "S" } attribute { name = "patient_key" type = "S" } attribute { name = "patient_sort" type = "S" } attribute { name = "masterid_key" type = "S" } global_secondary_index { name = "patient_gsi" hash_key = "patient_key" range_key = "patient_sort" projection_type = "ALL" } global_secondary_index { name = "masterid_gsi" hash_key = "masterid_key" projection_type = "ALL" } server_side_encryption { enabled = true kms_key_arn = aws_kms_key.pointers-table-key.arn } point_in_time_recovery { enabled = var.enable_pitr } } NRLF-3.0.31/terraform/infrastructure/modules/pointers-table/iam.tf000066400000000000000000000035271511201605300251220ustar00rootroot00000000000000resource "aws_iam_policy" "pointers-table-read" { name = "${var.name_prefix}-pointers-table-read" description = "Read the pointers-table" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey" ] Effect = "Allow" Resource = [ aws_kms_key.pointers-table-key.arn ] }, { Effect = "Allow" Action = [ "dynamodb:Query", "dynamodb:Scan", "dynamodb:GetItem", ], Resource = [ "${aws_dynamodb_table.pointers.arn}*" ] } ] }) } resource "aws_iam_policy" "pointers-table-write" { name = "${var.name_prefix}-pointers-table-write" description = "Write to the pointers-table" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Encrypt", "kms:GenerateDataKey" ] Effect = "Allow" Resource = [ aws_kms_key.pointers-table-key.arn ] }, { Effect = "Allow" Action = [ "dynamodb:PutItem", "dynamodb:UpdateItem", "dynamodb:DeleteItem", ], Resource = [ "${aws_dynamodb_table.pointers.arn}*" ] } ] }) } resource "aws_iam_policy" "pointers-kms-read-write" { name = "${var.name_prefix}-pointers-kms-read-write" description = "Encrypt and decrypt with the pointers table kms key" policy = jsonencode({ Version = "2012-10-17" Statement = [ { Action = [ "kms:Decrypt", "kms:DescribeKey", "kms:Encrypt", "kms:GenerateDataKey" ] Effect = "Allow" Resource = [ aws_kms_key.pointers-table-key.arn ] } ] }) } NRLF-3.0.31/terraform/infrastructure/modules/pointers-table/kms.tf000066400000000000000000000005301511201605300251350ustar00rootroot00000000000000resource "aws_kms_key" "pointers-table-key" { description = "Document pointers table KMS key" deletion_window_in_days = var.kms_deletion_window_in_days } resource "aws_kms_alias" "pointers-table-alias" { name = "alias/${var.name_prefix}-pointers-table-key" target_key_id = aws_kms_key.pointers-table-key.key_id } NRLF-3.0.31/terraform/infrastructure/modules/pointers-table/output.tf000066400000000000000000000011121511201605300257000ustar00rootroot00000000000000output "table_name" { description = "Name of the pointers table" value = aws_dynamodb_table.pointers.name } output "read_policy_arn" { description = "Policy to read from the pointers table" value = aws_iam_policy.pointers-table-read.arn } output "write_policy_arn" { description = "Policy to write to the pointers table" value = aws_iam_policy.pointers-table-write.arn } output "kms_read_write_policy_arn" { description = "Policy to encrypt and decrypt the pointers table with the kms key" value = aws_iam_policy.pointers-kms-read-write.arn } NRLF-3.0.31/terraform/infrastructure/modules/pointers-table/vars.tf000066400000000000000000000011401511201605300253140ustar00rootroot00000000000000variable "name_prefix" { type = string description = "The prefix to apply to all resources in the module." } variable "enable_deletion_protection" { type = bool description = "Enable deletion protection for the DynamoDB table." default = false } variable "enable_pitr" { type = bool description = "Enable point-in-time recovery for the DynamoDB table." default = false } variable "kms_deletion_window_in_days" { type = number description = "The duration in days after which the key is deleted after destruction of the resource." default = 7 } NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/000077500000000000000000000000001511201605300250205ustar00rootroot00000000000000NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/cloudwatch.tf000066400000000000000000000020051511201605300275050ustar00rootroot00000000000000resource "aws_cloudwatch_log_group" "lambda_cloudwatch_log_group" { name = "/aws/lambda/${aws_lambda_function.lambda_function.function_name}" retention_in_days = local.lambda_log_retention_in_days kms_key_id = var.kms_key_id } resource "aws_cloudwatch_event_rule" "event_rule" { name = "${var.prefix}--event_rule" description = "Rule to fire to clear and reseed sandbox data" schedule_expression = "cron(0 3 ? * * *)" # 3am, every day } resource "aws_cloudwatch_event_target" "event_target" { target_id = "${var.prefix}--event_target" rule = aws_cloudwatch_event_rule.event_rule.name arn = aws_lambda_function.lambda_function.arn } resource "aws_lambda_permission" "allow_execution_from_cloudwatch" { statement_id = "AllowExecutionFromCloudWatch" action = "lambda:InvokeFunction" function_name = aws_lambda_function.lambda_function.arn principal = "events.amazonaws.com" source_arn = aws_cloudwatch_event_rule.event_rule.arn } NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/iam.tf000066400000000000000000000014311511201605300261200ustar00rootroot00000000000000resource "aws_iam_role" "lambda_role" { name = "${var.prefix}--sandbox-seeder" assume_role_policy = jsonencode({ Version = "2012-10-17", Statement = [ { Effect = "Allow", Principal = { Service = "lambda.amazonaws.com" }, Action = "sts:AssumeRole" } ] }) } resource "aws_iam_role_policy_attachment" "lambda_policy_attachment" { role = aws_iam_role.lambda_role.name policy_arn = "arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole" depends_on = [ aws_iam_role.lambda_role ] } resource "aws_iam_role_policy_attachment" "additional_policies" { role = aws_iam_role.lambda_role.name count = length(var.additional_policies) policy_arn = var.additional_policies[count.index] } NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/lambda.tf000066400000000000000000000012061511201605300265720ustar00rootroot00000000000000resource "aws_lambda_function" "lambda_function" { function_name = "${var.prefix}--sandbox-seeder" runtime = "python3.9" handler = "cron.seed_sandbox.index.handler" role = aws_iam_role.lambda_role.arn filename = "${path.module}/../../../../cron/seed_sandbox/dist/seed_sandbox.zip" source_code_hash = filebase64sha256("${path.module}/../../../../cron/seed_sandbox/dist/seed_sandbox.zip") timeout = local.lambda_timeout memory_size = 128 environment { variables = var.environment_variables } layers = var.layers depends_on = [ aws_iam_role.lambda_role ] } NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/locals.tf000066400000000000000000000001231511201605300266240ustar00rootroot00000000000000locals { lambda_timeout = 30 lambda_log_retention_in_days = 30 } NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/output.tf000066400000000000000000000003551511201605300267160ustar00rootroot00000000000000output "invoke_arn" { value = aws_lambda_function.lambda_function.invoke_arn } output "arn" { value = aws_lambda_function.lambda_function.arn } output "function_name" { value = aws_lambda_function.lambda_function.function_name } NRLF-3.0.31/terraform/infrastructure/modules/seed_sandbox_lambda/vars.tf000066400000000000000000000002631511201605300263270ustar00rootroot00000000000000variable "prefix" {} variable "region" {} variable "layers" {} variable "kms_key_id" {} variable "environment_variables" {} variable "additional_policies" { default = [] } NRLF-3.0.31/terraform/infrastructure/output.tf000066400000000000000000000015711511201605300213110ustar00rootroot00000000000000output "account_name" { value = var.account_name } output "workspace" { value = terraform.workspace } output "prefix" { value = local.prefix } output "dynamodb" { value = { document_pointer = { name = local.pointers_table_name } } } output "api_base_urls" { value = { producer = module.producer__gateway.api_base_url consumer = module.consumer__gateway.api_base_url } } output "status_lambda_function_names" { value = { producer = module.producer__status.function_name consumer = module.consumer__status.function_name } } output "certificate_domain_name" { value = aws_acm_certificate.certificate.domain_name } # output "firehose" { # value = { # processor = module.firehose__processor # } # } output "auth_store" { value = local.auth_store_id } output "version" { value = data.external.current-info.result.version } NRLF-3.0.31/terraform/infrastructure/producer.tftpl000066400000000000000000000104631511201605300223140ustar00rootroot00000000000000{ "resourceType": "CapabilityStatement", "id": "${id}", "url": "https://${domain}/record-locator/producer/FHIR/R4/metadata", "name": "NRLProducerAPICapabilityStatement", "status": "active", "version": "1.0.1", "experimental": false, "date": "2024-03-13", "publisher": "NHS England", "contact": [ { "name": "NRL Team", "telecom": [ { "system": "email", "use": "work", "value": "nrls@nhs.net" } ] } ], "description": "Capability Statement for the National Record Locator FHIR R4 Producer API", "kind": "instance", "software": { "name": "National Record Locator FHIR R4 API - Producer", "version": "v3.0" }, "implementation": { "description": "NRL v3.0 Producer API FHIR Server", "url": "https://${domain}/record-locator/producer/FHIR/R4/" }, "fhirVersion": "4.0.1", "format": ["json"], "rest": [ { "mode": "server", "security": { "cors": true, "service": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/restful-security-service", "code": "OAuth", "display": "OAuth" } ] } ] }, "resource": [ { "type": "CapabilityStatement", "interaction": [ { "code": "read" } ], "versioning": "version", "readHistory": false }, { "type": "DocumentReference", "profile": "http://hl7.org/fhir/R4/documentreference.html", "documentation": "Additional business rules apply to validate patient, organisation and type/category content. Note that HEAD requests are not supported.", "interaction": [ { "code": "read", "documentation": "Get a pointer by ID. Producers can only view their own pointers." }, { "code": "search-type", "documentation": "Retrieve a set of pointers matching certain filter criteria. Both GET and POST are supported." }, { "code": "update", "documentation": "Update a pointer by ID. Producers can only update their own pointers, and not all fields can be changed." }, { "code": "create", "documentation": "Create a new document reference pointer. Producer organisations must have permission to create pointers of the type and category requested." }, { "code": "delete", "documentation": "Delete a pointer by ID. Producers can only delete pointers they have created." } ], "versioning": "no-version", "readHistory": false, "updateCreate": true, "conditionalCreate": false, "conditionalRead": "not-supported", "conditionalUpdate": false, "conditionalDelete": "not-supported", "referencePolicy": ["logical"], "searchParam": [ { "name": "type", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-type", "type": "token", "documentation": "Allows DocumentReference search results to be filtered by pointer type (SNOMED or NICIP code)." }, { "name": "category", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category", "type": "token", "documentation": "Allows DocumentReference search results to be filtered by pointer category (SNOMED code)." }, { "name": "subject", "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-subject", "type": "reference", "documentation": "Allows DocumentReference search results to be filtered by patient (NHS number). The subject:identifier parameter should be used." } ] } ] } ] } NRLF-3.0.31/terraform/infrastructure/seed_sandbox_lambda.tf000066400000000000000000000012551511201605300237060ustar00rootroot00000000000000 # module "seed_sandbox_lambda" { # count = endswith(local.environment, "-sandbox") ? 1 : 0 # source = "./modules/seed_sandbox_lambda" # region = local.region # prefix = local.prefix # layers = [module.lambda-utils.layer_arn, module.nrlf.layer_arn, module.third_party.layer_arn] # kms_key_id = module.kms__cloudwatch.kms_arn # environment_variables = { # PREFIX = "${local.prefix}--" # ENVIRONMENT = local.environment # } # additional_policies = [ # aws_iam_policy.document-pointer__dynamodb-write.arn, # aws_iam_policy.document-pointer__dynamodb-read.arn, # aws_iam_policy.document-pointer__kms-read-write.arn # ] # } NRLF-3.0.31/terraform/infrastructure/vars.tf000066400000000000000000000030441511201605300207210ustar00rootroot00000000000000variable "account_name" { type = string description = "The name of the AWS environment in the account, e.g. dev, qa, int, prod" } variable "aws_account_name" { type = string description = "The name of the AWS account, e.g. dev, test, prod" default = "dev" } variable "assume_role_arn" { type = string sensitive = true } # What domain should the APIs be hosted under variable "domain" { type = string } variable "public_domain" { type = string description = "The public domain for the persistent environment" } variable "public_sandbox_domain" { type = string description = "The public domain for the sandbox environment (optional)" nullable = true default = null } variable "consumer_api_path" { type = string default = "consumer" } variable "producer_api_path" { type = string default = "producer" } variable "deletion_protection" { type = bool default = false } variable "use_shared_resources" { type = bool default = false } variable "log_retention_period" { default = 90 type = number } variable "enable_reporting" { type = bool description = "Enable reporting for this environment" default = false } variable "disable_firehose_lambda_subscriptions" { description = "Disable firehose lambda subscriptions (e.g: splunk, reporting) for shared environments (e.g: perftest). This doesn't affect ephemeral environments as the firehose subscriptions are disabled regardless of this setting" type = bool default = false } NRLF-3.0.31/tests/000077500000000000000000000000001511201605300134735ustar00rootroot00000000000000NRLF-3.0.31/tests/data/000077500000000000000000000000001511201605300144045ustar00rootroot00000000000000NRLF-3.0.31/tests/data/DocumentReference/000077500000000000000000000000001511201605300200015ustar00rootroot00000000000000NRLF-3.0.31/tests/data/DocumentReference/RQI-736253002-Valid.json000066400000000000000000000050671511201605300233650ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RQI-99999-99999-999999", "status": "current", "docStatus": "final", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RQI" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RQI" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-736253002-Valid-with-date-and-meta-lastupdated.json000066400000000000000000000052451511201605300314330ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "date": "2024-03-20T00:00:01.000Z", "meta": { "lastUpdated": "2024-03-20T00:00:01.000Z" }, "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-736253002-Valid-with-date.json000066400000000000000000000051461511201605300254370ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "date": "2024-03-20T00:00:01.000Z", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-736253002-Valid-with-master-id.json000066400000000000000000000053151511201605300264050ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } }, "masterIdentifier": { "system": "https://fhir.nhs.uk/Id/document-reference-master-id", "value": "Y05868-736253002-0000000001" } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-736253002-Valid-with-meta-lastupdated.json000066400000000000000000000051771511201605300277640ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "meta": { "lastUpdated": "2024-03-20T00:00:01.000Z" }, "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-736253002-Valid-with-ssp-content.json000066400000000000000000000053451511201605300270000ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "ssp://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-736253002-Valid.json000066400000000000000000000051001511201605300235410ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } } } NRLF-3.0.31/tests/data/DocumentReference/Y05868-Appointment-Valid.json000066400000000000000000000053131511201605300250520ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "Y05868-99999-99999-999999", "status": "current", "docStatus": "final", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "749001000000101", "display": "Appointment" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "419891008", "display": "Record artifact" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "Y05868" } }, "description": "Physical document mental health crisis plan", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ], "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-US", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "size": 3654, "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "sourcePatientInfo": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "6700028191" } } }, "masterIdentifier": { "system": "https://fhir.nhs.uk/Id/document-reference-master-id", "value": "Y05868-736253002-0000000001" } } NRLF-3.0.31/tests/data/bars/000077500000000000000000000000001511201605300153335ustar00rootroot00000000000000NRLF-3.0.31/tests/data/bars/1_bars_sample_original.json000066400000000000000000000056401511201605300226270ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RYE-423456781055", "masterIdentifier": [ { "system": "TBC should be a unique ID for the pointer", "value": "TBC by NRL" } ], "identifier": [ { "system": "https://fhir.nhs.uk/Id/BaRS-Identifier", "value": "8c63d621-4d86-4f57-8699-e8e22d49935d" }, { "value": "2000072491", "system": "https://fhir.nhs.uk/Id/dos-service-id" }, { "system": "https://fhir.nhs.uk/id/ods-organization-code", "value": "RYE" } ], "status": "current", "docStatus": "preliminary", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "749001000000101", "display": "Appointment (booking)" } ] }, "category": [ { "coding": [ { "system": "http://ihe.net/xds/connectathon/classCodes", "code": "History and Physical", "display": "History and Physical" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9556274839" } }, "author": [ { "reference": "Practitioner/11638428", "display": "Model, User 154 Cerner" } ], "authenticator": { "reference": "Organization/RX898" }, "custodian": { "identifier": { "system": "https://fhir.nhs.uk/id/ods-organization-code", "value": "RYE" } }, "relatesTo": [ { "code": "replaces", "target": { "type": "DocumentReference", "identifier": { "value": "RYE-42345678105" } } } ], "description": "Physical", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "M", "display": "moderate" } ] } ], "content": [ { "attachment": { "language": "en-UK", "url": "http://fhir.nhs.uk/Id/dos-service-id|111111111", "title": "Physical", "creation": "2005-12-24T09:35:00+11:00" }, "format": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/message-events-bars", "code": "servicerequest-request" }, { "system": "https://fhir.nhs.uk/CodeSystem/message-category-servicerequest", "code": "referral", "display": "Transfer of Care" } ] } ] } ], "context": { "encounter": [ { "reference": "Encounter/xcda" } ], "period": { "start": "2020-11-10T19:57:26.961Z", "end": "2021-11-20T19:57:26.961Z" }, "event": [ { "coding": [ { "system": "http://ihe.net/xds/connectathon/eventCodes", "code": "T-D8200", "display": "Arm" } ] } ] } } NRLF-3.0.31/tests/data/bars/2_bars_sample_fhir_compliant.json000066400000000000000000000051351511201605300240210ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RYE-423456781055", "masterIdentifier": { "system": "https://some-bars-uri.org", "value": "TBC by NRL" }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/BaRS-Identifier", "value": "8c63d621-4d86-4f57-8699-e8e22d49935d" }, { "value": "2000072491", "system": "https://fhir.nhs.uk/Id/dos-service-id" }, { "system": "https://fhir.nhs.uk/id/ods-organization-code", "value": "RYE" } ], "status": "current", "docStatus": "preliminary", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "749001000000101", "display": "Appointment (booking)" } ] }, "category": [ { "coding": [ { "system": "http://ihe.net/xds/connectathon/classCodes", "code": "History and Physical", "display": "History and Physical" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9556274839" } }, "author": [ { "reference": "Practitioner/11638428", "display": "Model, User 154 Cerner" } ], "authenticator": { "reference": "Organization/RX898" }, "custodian": { "identifier": { "system": "https://fhir.nhs.uk/id/ods-organization-code", "value": "RYE" } }, "relatesTo": [ { "code": "replaces", "target": { "type": "DocumentReference", "identifier": { "value": "RYE-42345678105" } } } ], "description": "Physical", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "M", "display": "moderate" } ] } ], "content": [ { "attachment": { "language": "en-UK", "url": "http://fhir.nhs.uk/Id/dos-service-id|111111111", "title": "Physical", "creation": "2005-12-24T09:35:00+11:00" }, "format": { "system": "https://fhir.nhs.uk/CodeSystem/message-events-bars", "code": "servicerequest-request" } } ], "context": { "encounter": [ { "reference": "Encounter/xcda" } ], "period": { "start": "2020-11-10T19:57:26.961Z", "end": "2021-11-20T19:57:26.961Z" }, "event": [ { "coding": [ { "system": "http://ihe.net/xds/connectathon/eventCodes", "code": "T-D8200", "display": "Arm" } ] } ] } } NRLF-3.0.31/tests/data/bars/3_bars_sample_accepted.json000066400000000000000000000046331511201605300225760ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RYE-423456781055", "masterIdentifier": { "system": "https://some-bars-uri.org", "value": "TBC by NRL" }, "identifier": [ { "system": "https://fhir.nhs.uk/Id/BaRS-Identifier", "value": "8c63d621-4d86-4f57-8699-e8e22d49935d" }, { "value": "2000072491", "system": "https://fhir.nhs.uk/Id/dos-service-id" }, { "system": "https://fhir.nhs.uk/id/ods-organization-code", "value": "RYE" } ], "status": "current", "docStatus": "preliminary", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "749001000000101", "display": "Appointment (booking)" } ] }, "category": [ { "coding": [ { "system": "http://ihe.net/xds/connectathon/classCodes", "code": "History and Physical", "display": "History and Physical" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9556274839" } }, "author": [ { "reference": "Practitioner/11638428", "display": "Model, User 154 Cerner" } ], "authenticator": { "reference": "Organization/RX898" }, "custodian": { "identifier": { "system": "https://fhir.nhs.uk/id/ods-organization-code", "value": "RYE" } }, "description": "Physical", "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "M", "display": "moderate" } ] } ], "content": [ { "attachment": { "language": "en-UK", "url": "http://fhir.nhs.uk/Id/dos-service-id|111111111", "title": "Physical", "creation": "2005-12-24T09:35:00+11:00" }, "format": { "system": "https://fhir.nhs.uk/CodeSystem/message-events-bars", "code": "servicerequest-request" } } ], "context": { "encounter": [ { "reference": "Encounter/xcda" } ], "period": { "start": "2020-11-10T19:57:26.961Z", "end": "2021-11-20T19:57:26.961Z" }, "event": [ { "coding": [ { "system": "http://ihe.net/xds/connectathon/eventCodes", "code": "T-D8200", "display": "Arm" } ] } ] } } NRLF-3.0.31/tests/data/bars/README.md000066400000000000000000000005661511201605300166210ustar00rootroot00000000000000# BaRS data 1. `1_bars_sample_original.json` is the document submitted to us by BaRS 1. `2_bars_sample_fhir_compliant.json` is the cut down version of the original that can be accepted by the current API. 1. `3_bars_sample_accepted.json` is the version the api accepted, which had to remove the `relatesTo` because those documents didn't exist in our system. NRLF-3.0.31/tests/data/samples/000077500000000000000000000000001511201605300160505ustar00rootroot00000000000000NRLF-3.0.31/tests/data/samples/11X_ADVANCE_CARE_PLAN_Feb25.json000066400000000000000000000045421511201605300227710ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "11X-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.326Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736366004", "display": "Advance care plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.326Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "L85012" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "11X" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.326Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "1060971000000108", "display": "General practice service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/11X_PERSONALISED_CARE_AND_SUPPORT_PLAN_Feb25.json000066400000000000000000000045721511201605300255410ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "11X-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.327Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "2181441000000107", "display": "Personalised Care and Support Plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.327Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "L85609" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "11X" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.327Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "1060971000000108", "display": "General practice service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/11X_TREATMENT_ESCALATION_PLAN_Feb25.json000066400000000000000000000045521511201605300242040ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "11X-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.327Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "735324008", "display": "Treatment escalation plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.327Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "L85023" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "11X" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.327Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "1060971000000108", "display": "General practice service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/B3H2B_EMERGENCY_HEALTHCARE_PLAN_Feb25.json000066400000000000000000000047441511201605300243270ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "B3H2B-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.326Z" }, "masterIdentifier": { "system": "better.pdfCompositionUid", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "887701000000100", "display": "Emergency health care plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.326Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "B3H2B" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "B3H2B" } }, "relatesTo": [ { "code": "replaces", "target": { "identifier": { "value": "rel_c2a99222-eb50-4451-ad6e-1e951627800e" } } } ], "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "224891009", "display": "Healthcare services" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/G3H9E_LLOYD_GEORGE_RECORD_FOLDER_Aug25.json000066400000000000000000000041321511201605300245510ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "G3H9E-1c9c2030-6ef4-4564-ac62-c9c321659cc9", "meta": { "lastUpdated": "2025-01-06T16:04:28.966Z" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "16521000000101", "display": "Lloyd George record folder" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9730326991" } }, "date": "2025-01-06T16:04:28.966Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "G3H9E" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "G3H9E" } }, "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-UK", "url": "https://dev.api.service.nhs.uk/national-document-repository/FHIR/R4/DocumentReference/f0c41c3a-d43d-4c7a-9d96-61c6903bf2bd" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "1060971000000108", "display": "General practice service" } ] } } } NRLF-3.0.31/tests/data/samples/QUY_RESPECT_FORM_Feb25.json000066400000000000000000000046401511201605300223600ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "QUY-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.327Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "1382601000000107", "display": "ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.327Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "L81014" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "QUY" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.327Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "1060971000000108", "display": "General practice service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RAT_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232160ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RAT-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.326Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.326Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RAT" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RAT" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.326Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/README.md000066400000000000000000000010611511201605300173250ustar00rootroot00000000000000# Supplier sample data This directory contains sample pointer data from our suppliers. Samples have been sourced directly from suppliers or anonymised from live data. To add a new sample to this folder, follow these steps: - Remove any real PII from the DocumentReference data (NHS numbers, URLs, ids etc) - Add the DocumentReference data to a .json file with a name describing the supplier and the pointer type, something like __.json - Run the tests to verify that the pointer works with our model and validators NRLF-3.0.31/tests/data/samples/RHA_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232020ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RHA-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.328Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.328Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RHA" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RHA" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.328Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RKL_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232200ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RKL-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.328Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.328Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RKL" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RKL" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.328Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RP7_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232000ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RP7-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.326Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.326Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RP7" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RP7" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.326Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RPG_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000065271511201605300232270ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RPG-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.328Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.328Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RPG" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RPG" } }, "relatesTo": [ { "code": "replaces", "target": { "identifier": { "value": "rel_c2a99222-eb50-4451-ad6e-1e951627800e" } } } ], "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.328Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RQY_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232430ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RQY-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.325Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.325Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RQY" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RQY" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.325Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.325Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.325Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RRE_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232200ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RRE-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.328Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.328Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RRE" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RRE" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.328Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RV5_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000065131511201605300232060ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RV5-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.327Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.327Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RV5" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RV5" } }, "relatesTo": [ { "code": "replaces", "target": { "identifier": { "value": "rel_c2a99222-eb50-4451-ad6e-1e951627800e" } } } ], "content": [ { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.327Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "708168004", "display": "Mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RW1_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000065271511201605300232100ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RW1-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.327Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.327Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RW1" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RW1" } }, "relatesTo": [ { "code": "replaces", "target": { "identifier": { "value": "rel_c2a99222-eb50-4451-ad6e-1e951627800e" } } } ], "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.327Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RW4_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232040ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RW4-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.327Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.327Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RW4" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RW4" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.327Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.327Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/RWK_MENTAL_HEALTH_PLAN_Feb25.json000066400000000000000000000062411511201605300232330ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "RWK-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-10T16:48:27.328Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.328Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RWK" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RWK" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-10T16:48:27.328Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.328Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "892811000000109", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/SYNTHETIC_IN_CONTEXT_LAUNCH_EXAMPLE.json000066400000000000000000000051761511201605300243250ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "INCTX-197ca0ca-f547-42b6-a68c-99b75a3a2df5", "meta": { "lastUpdated": "2025-02-10T16:48:27.326Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_197ca0ca-f547-42b6-a68c-99b75a3a2df5" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-10T16:48:27.326Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "L85012" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "INCTX" } }, "content": [ { "attachment": { "contentType": "text/html", "url": "https://supplier.inctxlaunch.example/content", "creation": "2025-02-10T16:48:27.326Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:structured", "display": "Structured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "dynamic", "display": "Dynamic" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" }, { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "InContext", "display": "Direct using In-Context" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" } ] } ], "context": { "period": { "start": "2025-02-10T16:48:27.326Z" }, "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "1060971000000108", "display": "General practice service" } ] } } } NRLF-3.0.31/tests/data/samples/VM8W7_EMERGENCY_HEALTHCARE_PLAN_Feb25.json000066400000000000000000000061371511201605300244150ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "VM8W7-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-11T12:25:44.382Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "887701000000100", "display": "Emergency health care plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-11T12:25:44.382Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "VM8W7" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "VM8W7" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-11T12:25:44.382Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-11T12:25:44.382Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "224891009", "display": "Healthcare services" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/VM8W7_EOL_COORDINATION_SUMMARY_Feb25.json000066400000000000000000000061521511201605300244060ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "VM8W7-c2a99222-eb50-4451-ad6e-1e951627800e", "meta": { "lastUpdated": "2025-02-11T12:25:44.435Z" }, "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "mid_c2a99222-eb50-4451-ad6e-1e951627800e" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "861421000000109", "display": "End of life care coordination summary" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "date": "2025-02-11T12:25:44.435Z", "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "VM8W7" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "VM8W7" } }, "content": [ { "attachment": { "contentType": "application/pdf", "url": "ssp://content.test.local/content", "creation": "2025-02-11T12:25:44.435Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] }, { "attachment": { "contentType": "text/html", "url": "https://content.test.local/content", "creation": "2025-02-11T12:25:44.435Z" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] }, "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability" } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "224891009", "display": "Healthcare services" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/data/samples/YGM91_MENTAL_HEALTH_PLAN_Orion_Feb2025.json000066400000000000000000000043741511201605300247130ustar00rootroot00000000000000{ "resourceType": "DocumentReference", "id": "YGM91-b5a1aef1-a3ee-4c38-be31-e98968fe7ae9", "masterIdentifier": { "system": "urn:ietf:rfc:3986", "value": "b5a1aef1-a3ee-4c38-be31-e98968fe7ae9" }, "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9658218873" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "YGM91" } } ], "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "YGM91" } }, "content": [ { "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "dynamic", "display": "Dynamic" } ] } } ], "attachment": { "contentType": "application/pdf", "language": "en", "url": "ssp://endpoint.nrlproducer.thirdparty.nhs.uk/nrl/content", "title": "Treatment Escalation Plan" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" } } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "92221000000103", "display": "Mental health home treatment team" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "012345678910" } } ] } } NRLF-3.0.31/tests/features/000077500000000000000000000000001511201605300153115ustar00rootroot00000000000000NRLF-3.0.31/tests/features/consumer/000077500000000000000000000000001511201605300171445ustar00rootroot00000000000000NRLF-3.0.31/tests/features/consumer/headOnGetEndpoint.feature000066400000000000000000000053371511201605300240700ustar00rootroot00000000000000Feature: Consumer - HEAD Requests Scenario Outline: DocumentReference with HEAD fails (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When consumer 'RX898' sends HEAD request to 'DocumentReference' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 405 And the response has an empty body And the Allow header is 'GET' And the Content-Length header is '0' Examples: | content_type | | application/json | | application/json+fhir | | application/fhir+json | Scenario Outline: DocumentReference/{id} with HEAD fails (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When consumer 'RX898' sends HEAD request to 'DocumentReference/random-id' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 405 And the response has an empty body And the Allow header is 'GET' And the Content-Length header is '0' Examples: | content_type | | application/json | | application/json+fhir | | application/fhir+json | Scenario Outline: DocumentReference with HEAD fails with 415 with unsupported (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When consumer 'RX898' sends HEAD request to 'DocumentReference' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 415 And the Content-Type header is 'application/json' And the Content-Length header is '0' And the Allow header is not present Examples: | content_type | | application/notsupported | | application/helloworld | | application/harold | Scenario Outline: DocumentReference/{id} with HEAD fails (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When consumer 'RX898' sends HEAD request to 'DocumentReference/random-id' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 415 And the response has an empty body And the Content-Type header is 'application/json' And the Content-Length header is '0' And the Allow header is not present Examples: | content_type | | application/notsupported | | application/helloworld | | application/harold | NRLF-3.0.31/tests/features/consumer/readDocumentReference-failure.feature000066400000000000000000000167271511201605300264140ustar00rootroot00000000000000# Invalid ID (X26|Something-) Feature: Consumer - readDocumentReference - Failure Scenarios Scenario: Pointer not found Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' reads a DocumentReference with ID 'X26-000000000-000000000' Then the response status code is 404 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "not-found", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "NO_RECORD_FOUND", "display": "No record found" } ] }, "diagnostics": "The requested DocumentReference could not be found" } """ # TODO: This scenario is not valid as the ID is not valid - additional validation required Scenario: Invalid ID in path parameters Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' reads a DocumentReference with ID 'X26`DROP TABLE 'pointers';--Something-000000000-000000000' Then the response status code is 404 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "not-found", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "NO_RECORD_FOUND", "display": "No record found" } ] }, "diagnostics": "The requested DocumentReference could not be found" } """ Scenario: No permissions to access any resources Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | When consumer 'RX898' reads a DocumentReference with ID 'X26-000000000-000000000' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: No permissions to access specific pointer type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-ReadDocRefNoAuthForType | | subject | 9278693472 | | status | current | | type | 887701000000100 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' reads a DocumentReference with ID '02V-1111111111-ReadDocRefNoAuthForType' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "The requested DocumentReference is not of a type that this organisation is allowed to access" } """ Scenario: No permissions to access any pointers in S3 Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | When consumer 'RX898' reads a DocumentReference with ID 'X26-000000000-000000000' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: No permissions to access specific pointer type in S3 Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-ReadDocRefNoAuthForTypeS3 | | subject | 9278693472 | | status | current | | type | 887701000000100 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' reads a DocumentReference with ID '02V-1111111111-ReadDocRefNoAuthForTypeS3' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "The requested DocumentReference is not of a type that this organisation is allowed to access" } """ NRLF-3.0.31/tests/features/consumer/readDocumentReference-success.feature000066400000000000000000000224341511201605300264250ustar00rootroot00000000000000Feature: Consumer - readDocumentReference - Success Scenarios Scenario: Read document reference by ID - Requesting org is custodian Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898-9999999999-ReadDocRefSameCustodian | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | RX898 | When consumer 'RX898' reads a DocumentReference with ID 'RX898-9999999999-ReadDocRefSameCustodian' Then the response status code is 200 And the response is a DocumentReference with JSON value: """ { "resourceType": "DocumentReference", "id": "RX898-9999999999-ReadDocRefSameCustodian", "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RX898" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RX898" } } ], "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788007007", "display": "General practice service" } ] } } } """ Scenario: Read document reference by ID - Requesting org is not custodian Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | X26-9999999999-ReadDocRefDiffCustodian | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | X26 | | author | RX898 | When consumer 'RX898' reads a DocumentReference with ID 'X26-9999999999-ReadDocRefDiffCustodian' Then the response status code is 200 And the response is a DocumentReference with JSON value: """ { "resourceType": "DocumentReference", "id": "X26-9999999999-ReadDocRefDiffCustodian", "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "X26" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RX898" } } ], "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788007007", "display": "General practice service" } ] } } } """ Scenario: Read document reference by ID - urlencoded Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898\|001-1234567890-ReadDocRefUrlEncoded | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898\|001 | | author | RX898 | When consumer 'RX898' reads a DocumentReference with ID 'RX898%7C001-1234567890-ReadDocRefUrlEncoded' Then the response status code is 200 NRLF-3.0.31/tests/features/consumer/searchDocumentReference-failure.feature000066400000000000000000000323701511201605300267360ustar00rootroot00000000000000Feature: Consumer - searchDocumentReference - Failure Scenarios Scenario: Search fails to return a bundle when extra parameters are found Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | extra | parameter | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_PARAMETER", "display": "Invalid parameter" }] }, "diagnostics": "Invalid query parameter (extra: Extra inputs are not permitted)", "expression": ["extra"] } """ Scenario: Search fails to return a bundle when no subject:identifier is provided Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_PARAMETER", "display": "Invalid parameter" }] }, "diagnostics": "Invalid query parameter (subject:identifier: Field required)", "expression": ["subject:identifier"] } """ Scenario: Search rejects request with type system they are not allowed to use Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | type | http://incorrect.info/sct\|736253002 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "Invalid query parameter (The provided type does not match the allowed types for this organisation)", "expression": ["type"] } """ Scenario: Search rejects request with type they are not allowed to use Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | type | http://snomed.info/sct\|887701000000100 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "Invalid query parameter (The provided type does not match the allowed types for this organisation)", "expression": ["type"] } """ Scenario: Search rejects request when the NHS number provided is invalid Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 123 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number" }] }, "diagnostics": "A valid NHS number is required to search for document references", "expression": ["subject:identifier"] } """ Scenario: Search rejects request if the organisation has no registered pointer types Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" }] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Search rejects request if the organisation has no registered pointer types but uses category filter Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000 | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" }] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Search returns no results if category filter is used without any relevant type permissions Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 8FW23-537854543-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 8FW23 | | author | 8FW23 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://snomed.info/sct\|1102421000000108 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&category=http://snomed.info/sct|1102421000000108' And the Bundle has a total of 0 And the Bundle has 0 entries Scenario: Search gives 403 if no permission Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And a DocumentReference resource exists with values: | property | value | | id | 8FW23-1114567890-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 8FW23 | | author | 8FW23 | When consumer 'Z26' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | type | 736253002 | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" }] }, "diagnostics": "Your organisation 'Z26' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Search rejects request with invalid category system Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://incorrect.info/sct\|736253002 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "Invalid query parameter (The provided category is not valid)", "expression": ["category"] } """ Scenario: Search rejects request with multiple categories and one invalid category Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000,http://snomed.info/sct\|invalid | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "Invalid query parameter (The provided category is not valid)", "expression": ["category"] } """ NRLF-3.0.31/tests/features/consumer/searchDocumentReference-success.feature000066400000000000000000001011121511201605300267460ustar00rootroot00000000000000Feature: Consumer - searchDocumentReference - Success Scenarios Scenario: Search for a DocumentReference by NHS Number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | Scenario: Search for a DocumentReference and Accession Number is in response Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | | identifier | 02V.123456789 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | | identifier | 02V.123456789 | Scenario: Search for a DocumentReference by NHS Number and Custodian where both search parameters match Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | custodian | 02V | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|02V' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | Scenario: Search for a DocumentReference by NHS Number and Custodian where Custodian filter matches one pointer from result set Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | DK94-1111111112-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | DK94 | | author | DK94 | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | custodian | 02V | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|02V' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | Scenario: Search for a DocumentReference by NHS Number and Custodian where NHS number filter matches one pointer from result set Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111112-SearchDocRefTest | | subject | 9785146901 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | custodian | 02V | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|02V' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 02V | | author | 02V | Scenario: Search for multiple DocumentReferences by NHS number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 887701000000100 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472' And the Bundle has a total of 2 And the Bundle has 2 entries And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | 02V | | author | 02V | And the Bundle does not contain a DocumentReference with ID '02V-1111111111-SearchMultipleRefTest3' Scenario: Search for a DocumentReference by NHS Number where 0 pointers are found Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'DK94' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 861421000000109 | And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 861421000000109 | And a DocumentReference resource exists with values: | property | value | | id | DK94-111-DeleteDocRefTest1 | | subject | 9278693472 | | status | current | | type | 861421000000109 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | DK94 | | author | N64 | When producer 'DK94' requests to delete DocumentReference with id 'DK94-111-DeleteDocRefTest1' And consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | custodian | RX898 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|RX898' And the Bundle has a total of 0 And the Bundle has 0 entry Scenario: Search for multiple DocumentReferences by NHS number and Category Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&category=http://snomed.info/sct|734163000' And the Bundle has a total of 2 And the Bundle has 2 entries And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | 02V | | author | 02V | And the Bundle does not contain a DocumentReference with ID '02V-1111111111-SearchMultipleRefTest3' Scenario: Search for DocumentReference by NHS number and Category and type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://snomed.info/sct\|1102421000000108 | | type | http://snomed.info/sct\|736253002 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&type=http://snomed.info/sct|736253002&category=http://snomed.info/sct|1102421000000108' And the Bundle has a total of 0 And the Bundle has 0 entries And the Bundle does not contain a DocumentReference with ID '02V-1111111111-SearchMultipleRefTest1' And the Bundle does not contain a DocumentReference with ID '02V-1111111111-SearchMultipleRefTest3' Scenario: Search for DocumentReference by NHS number and Summary Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | _summary | count | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&_summary=count' And the Bundle has a total of 2 Scenario: Search for multiple DocumentReferences by NHS number and Multiple Categories Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 824321000000109 | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | 02V | | author | 02V | And a DocumentReference resource exists with values: | property | value | | id | 02V-1111111111-SearchMultipleRefTest4 | | subject | 9278693472 | | status | current | | type | 824321000000109 | | category | 823651000000106 | | contentType | application/pdf | | url | https://example.org/my-doc-4.pdf | | custodian | 02V | | author | 02V | When consumer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000,http://snomed.info/sct\|823651000000106 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&category=http://snomed.info/sct|734163000,http://snomed.info/sct|823651000000106' And the Bundle has a total of 3 And the Bundle has 3 entries And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | 02V | | author | 02V | And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | 02V | | author | 02V | And the Bundle contains an DocumentReference with values | property | value | | id | 02V-1111111111-SearchMultipleRefTest4 | | subject | 9278693472 | | status | current | | type | 824321000000109 | | category | 823651000000106 | | contentType | application/pdf | | url | https://example.org/my-doc-4.pdf | | custodian | 02V | | author | 02V | And the Bundle does not contain a DocumentReference with ID '02V-1111111111-SearchMultipleRefTest3' # No pointers found - done # Pointers exist but no permissions - covered in failure scenarios # Search by custodian - done NRLF-3.0.31/tests/features/consumer/searchPostDocumentReference-failure.feature000066400000000000000000000270211511201605300276010ustar00rootroot00000000000000Feature: Consumer - searchDocumentReference - Failure Scenarios Scenario: Search fails to return a bundle when extra keys are found Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | extra | parameter | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" }] }, "diagnostics": "Request body could not be parsed (extra: Extra inputs are not permitted)", "expression": ["extra"] } """ Scenario: Search fails to return a bundle when no subject:identifier is provided Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" }] }, "diagnostics": "Request body could not be parsed (subject:identifier: Field required)", "expression": ["subject:identifier"] } """ Scenario: Search rejects request with type system they are not allowed to use Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | type | http://incorrect.info/sct\|736253002 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "The provided type does not match the allowed types for this organisation", "expression": ["type"] } """ Scenario: Search rejects request with type they are not allowed to use Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | type | http://snomed.info/sct\|887701000000100 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "The provided type does not match the allowed types for this organisation", "expression": ["type"] } """ Scenario: Search rejects request when the NHS number provided is invalid Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 123 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_NHS_NUMBER", "display": "Invalid NHS number" }] }, "diagnostics": "A valid NHS number is required to search for document references", "expression": ["subject:identifier"] } """ Scenario: Search rejects request if the organisation has no registered pointer types Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" }] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Search returns 403 if no permissions Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And a DocumentReference resource exists with values: | property | value | | id | 8FW23-1114567890-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 8FW23 | | author | 8FW23 | When consumer 'X26' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | type | 736253002 | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" }] }, "diagnostics": "Your organisation 'X26' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Search rejects request if the organisation has no registered pointer types Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" }] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Search rejects request with category system they are not allowed to use Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | category | http://incorrect.info/sct\|736253002 | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "The provided category is not valid", "expression": ["category"] } """ Scenario: Search rejects request with multiple categories and one that is invalid Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000,http://snomed.info/sct\|invalid | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "code-invalid", "details": { "coding": [{ "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "INVALID_CODE_SYSTEM", "display": "Invalid code system" }] }, "diagnostics": "The provided category is not valid", "expression": ["category"] } """ NRLF-3.0.31/tests/features/consumer/searchPostDocumentReference-success.feature000066400000000000000000000656701511201605300276360ustar00rootroot00000000000000Feature: Consumer - searchDocumentReference - Success Scenarios Scenario: Search for a DocumentReference by NHS Number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | 8FW23-1234567890-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 8FW23 | | author | 8FW23 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | 8FW23-1234567890-SearchDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | 8FW23 | | author | 8FW23 | Scenario: Search for a Document Reference using NHS number and custodian in request body Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898-1111111111-SearchPOSTDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | RX898 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | custodian | RX898 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|RX898' And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | RX898-1111111111-SearchPOSTDocRefTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | RX898 | Scenario: Search for multiple DocumentReferences by NHS number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTestDifferentType | | subject | 9278693472 | | status | current | | type | 887701000000100 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | X26 | | author | X26 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 2 And the Bundle has 2 entries And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And the Bundle does not contain a DocumentReference with ID 'X26-1111111111-SearchMultipleRefTestDifferentType' Scenario: Search for multiple DocumentReferences by NHS number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTestDifferentType | | subject | 9278693472 | | status | current | | type | 887701000000100 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | X26 | | author | X26 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 2 And the Bundle has 2 entries And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And the Bundle does not contain a DocumentReference with ID 'X26-1111111111-SearchMultipleRefTestDifferentType' Scenario: Search for a DocumentReference by NHS Number where 0 pointers are found Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'DK94' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 861421000000109 | And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 861421000000109 | And a DocumentReference resource exists with values: | property | value | | id | DK94-111-DeleteDocRefTest1 | | subject | 9278693472 | | status | current | | type | 861421000000109 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | DK94 | | author | N64 | When producer 'DK94' requests to delete DocumentReference with id 'DK94-111-DeleteDocRefTest1' And consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | custodian | RX898 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a self link matching 'DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9278693472&custodian:identifier=https://fhir.nhs.uk/Id/ods-organization-code|RX898' And the Bundle has a total of 0 And the Bundle has 0 entry Scenario: Search for multiple DocumentReferences by NHS number and Category Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | x26-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | x26 | | author | x26 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 2 And the Bundle has 2 entries And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And the Bundle does not contain a DocumentReference with ID 'x26-1111111111-SearchMultipleRefTest3' Scenario: Search for multiple DocumentReferences by NHS number and Summary Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | x26-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | x26 | | author | x26 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | _summary | count | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 3 Scenario: Search for multiple DocumentReferences by NHS number and Multiple Categories Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 824321000000109 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | x26-1111111111-SearchMultipleRefTest3 | | subject | 9278693472 | | status | current | | type | 1363501000000100 | | category | 1102421000000108 | | contentType | application/pdf | | url | https://example.org/my-doc-3.pdf | | custodian | x26 | | author | x26 | And a DocumentReference resource exists with values: | property | value | | id | X26-1111111111-SearchMultipleRefTest4 | | subject | 9278693472 | | status | current | | type | 824321000000109 | | category | 823651000000106 | | contentType | application/pdf | | url | https://example.org/my-doc-4.pdf | | custodian | X26 | | author | X26 | When consumer 'RX898' searches for DocumentReferences using POST with request body: | key | value | | subject | 9278693472 | | category | http://snomed.info/sct\|734163000,http://snomed.info/sct\|823651000000106 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 3 And the Bundle has 3 entries And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-1.pdf | | custodian | X26 | | author | X26 | And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest2 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc-2.pdf | | custodian | X26 | | author | X26 | And the Bundle contains an DocumentReference with values | property | value | | id | X26-1111111111-SearchMultipleRefTest4 | | subject | 9278693472 | | status | current | | type | 824321000000109 | | category | 823651000000106 | | contentType | application/pdf | | url | https://example.org/my-doc-4.pdf | | custodian | X26 | | author | X26 | And the Bundle does not contain a DocumentReference with ID 'x26-1111111111-SearchMultipleRefTest3' NRLF-3.0.31/tests/features/consumer/status-success.feature000066400000000000000000000000251511201605300235070ustar00rootroot00000000000000# Status returns 200 NRLF-3.0.31/tests/features/environment.py000066400000000000000000000023441511201605300202320ustar00rootroot00000000000000import os from behave.runner import Context from tests.features.utils.certificates import get_cert_path_for_environment os.environ.setdefault("POWERTOOLS_LOG_LEVEL", "ERROR") os.environ.setdefault("AWS_DEFAULT_REGION", "eu-west-2") from nrlf.core.dynamodb.repository import DocumentPointerRepository def before_all(context: Context): """ This function is called before all the tests are executed """ context.env = context.config.userdata.get("env") context.account_name = context.config.userdata.get("account_name") context.is_shared_resources = context.config.userdata.get("is_shared_resources") context.stack_name = ( context.account_name if context.is_shared_resources else context.env ) context.base_url = f"https://{context.env}.api.record-locator.dev.national.nhs.uk/" context.request_id = "feature-test-request-id" context.correlation_id = "feature-test-correlation-id" print(f"Running tests in {context.env} environment: {context.base_url}") # noqa default_table_name = f"nhsd-nrlf--{context.stack_name}-pointers-table" context.client_cert = get_cert_path_for_environment(context.env) context.repository = DocumentPointerRepository(table_name=default_table_name) NRLF-3.0.31/tests/features/producer/000077500000000000000000000000001511201605300171345ustar00rootroot00000000000000NRLF-3.0.31/tests/features/producer/createDocumentReference-duplicateField.feature000066400000000000000000000110511511201605300302040ustar00rootroot00000000000000Feature: Producer - createDocumentReference - Duplicate Field Scenarios Scenario: Duplicate url field in attachment Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf", "url": "https://example.org/duplicate-url.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['url']", "expression": [ "DocumentReference.content[0].attachment.url" ] } """ Scenario: Duplicate format and attachement field in content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "attachment": { "contentType": "text/html", "url": "https://example.org/contact-details.html" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['attachment', 'format']", "expression": [ "DocumentReference.content[0].attachment", "DocumentReference.content[0].format" ] } """ NRLF-3.0.31/tests/features/producer/createDocumentReference-failure.feature000066400000000000000000001635301511201605300267270ustar00rootroot00000000000000# Invalid document reference - structure # Invalid document reference - required fields missing # Invalid document reference - extra fields provided # Invalid document reference - missing custodian identifier # Invalid document reference - missing subject identifier # Invalid document reference - invalid custodian system # Invalid document reference - invalid subject system # Invalid document reference - invalid relatesTo code # Invalid document reference - invalid relatesTo target # Invalid document reference - multiple type.coding # Invalid document reference - invalid custodian suffix Feature: Producer - createDocumentReference - Failure Scenarios Scenario: Producer and custodian ODS mismatch Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | N0TANGY | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "The custodian of the provided DocumentReference does not match the expected ODS code for this organisation", "expression": [ "custodian.identifier.value" ] } """ Scenario: Invalid NHS number (correct length but not valid) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 1234567890 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | # NRL-765 known bug: this response is not handled properly, currently gives a 500 # Then the response status code is 400 Then the response is an OperationOutcome with 1 issue # And the OperationOutcome contains the issue: # """ # { # "severity": "error", # "code": "informational", # "details": { # "coding": [ # { # "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", # "code": "BAD_REQUEST", # "display": "Bad request" # } # ] # }, # "diagnostics": "Invalid NHS number" # } # """ Scenario: Invalid NHS number (valid number but wrong system) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'subject' is: """ "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/not-nhs-number", "value": "9999999999" } } """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Provided subject identifier system is not the NHS number system (expected 'https://fhir.nhs.uk/Id/nhs-number')", "expression": [ "subject.identifier.system" ] } """ Scenario: Invalid Author Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'author' is: """ "author":[{ "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "!!!!!" } }] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid author value: '!!!!!' Author value must be alphanumeric", "expression": [ "author[0].identifier.value" ] } """ Scenario: Invalid Author System Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'author' is: """ "author":[{ "identifier": { "system": "ddddd", "value": "123" } }] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid author system: 'ddddd' Author system must be 'https://fhir.nhs.uk/Id/ods-organization-code'", "expression": [ "author[0].identifier.system" ] } """ # Invalid document reference - invalid relatesTo target # Invalid document reference - invalid producer ID in relatesTo target Scenario: Unauthorised supersede - target belongs to a different custodian Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | N0TANGY-111-UnauthSupersedeTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | N0TANGY | | author | HAR1 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/newdoc.pdf | | supercedes | N0TANGY-111-UnauthSupersedeTest | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "The relatesTo target identifier value does not include the expected ODS code for this organisation", "expression": [ "relatesTo[0].target.identifier.value" ] } """ And the Document Reference 'N0TANGY-111-UnauthSupersedeTest' exists with values: | property | value | | id | N0TANGY-111-UnauthSupersedeTest | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | N0TANGY | # Invalid document reference - superseded document reference not found # Invalid document reference - superseded document reference NHS number mismatch # Invalid document reference - superseded document reference pointer type mismatch # Credentials - no pointer types allowed Scenario: Producer lacks permissions to create any pointer types Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "Your organisation 'ANGY1' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Invalid status Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'X26' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | type | 736253002 | | category | 734163000 | | custodian | X26 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | status | invalid | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (status: String should match pattern '^current$')", "expression": [ "status" ] } """ Scenario: Producer lacks the permission for the pointer type requested Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | 887701000000100 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error" } ] }, "diagnostics": "The type of the provided DocumentReference is not in the list of allowed types for this organisation", "expression": [ "type.coding[0].code" ] } """ Scenario: Invalid category for type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'X26' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 1102421000000108 | | custodian | X26 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "The Category code of the provided document 'http://snomed.info/sct|1102421000000108' must match the allowed category for pointer type 'http://snomed.info/sct|736253002' with a category value of 'http://snomed.info/sct|734163000'", "expression": [ "category.coding[0].code" ] } """ Scenario: Invalid format code for attachment type contact details Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "text/html", "url": "someContact.co.uk" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid content format code: urn:nhs-ic:unstructured format code must be 'urn:nhs-ic:record-contact' for Contact details attachments.", "expression": [ "content[0].format.code" ] } """ Scenario: Invalid format code for attachment type pdf Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-UK", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid content format code: urn:nhs-ic:record-contact format code must be 'urn:nhs-ic:unstructured' for Unstructured Document attachments.", "expression": [ "content[0].format.code" ] } """ # Invalid document reference - empty content[0].attachment.url # Invalid document reference - create another producers document # Invalid document reference - bad JSON # Invalid document reference - invalid content (NRL-518) # Invalid document reference - invalid context.related for an SSP url # Invalid document reference - missing context.related for an SSP url # Invalid document reference - invalid docStatus (NRL-477) # Invalid document reference - duplicate keys # Invalid document reference - duplicate relatesTo targets in URL # Invalid document reference - supersede with duplicate error # Invalid document reference - missing audit date when permission to set audit date # Invalid document reference - SSP URL? Scenario: System not supported in NRL 3.0 Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type_system | http://invalidsystem.info/sct | | type_display | Mental health crisis plan | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid type system: http://invalidsystem.info/sct Type system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'", "expression": ["type.coding[0].system"] } """ Scenario: Invalid Document Reference Type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | invalid | | type_display | Mental health crisis plan | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid type code: invalid Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)", "expression": [ "type.coding[0].code" ] } """ Scenario Outline: Invalid display value for type or category (imaging) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | https://nicip.nhs.uk | MAULR | | https://nicip.nhs.uk | MAXIB | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type_system | | | type_display | | | type | | | category | | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "type code '' must have a display value of ''", "expression": [ "type.coding[0].display" ] } """ Examples: | type-system | type-code | category-code | type-display | correct-display | | https://nicip.nhs.uk | MAULR | 721981007 | "Nonsense display" | MRA Upper Limb Rt | | https://nicip.nhs.uk | MAXIB | 103693007 | "Nonsense display" | MRI Axilla Both | Scenario: Invalid practice setting (not in value set) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'X26' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | X26 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 12345 | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid practice setting code: 12345 Practice Setting coding must be a member of value set https://fhir.nhs.uk/England/ValueSet/England-PracticeSetting", "expression": ["context.practiceSetting.coding[0].code"] } """ Scenario: Invalid practice setting (valid code but wrong display value) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'context' is: """ "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Ophthalmology service" } ] } } """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue Scenario: Missing content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)", "expression": [ "DocumentReference" ] } """ Scenario: contentType empty string Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)", "expression": [ "DocumentReference" ] } """ Scenario: Invalid contentType Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | contentType | application/invalid | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid contentType: application/invalid. Must be 'application/pdf', 'text/html' or 'application/fhir+json'", "expression": [ "content[0].attachment.contentType" ] } """ Scenario: Mismatched format code and display Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "text/html", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid display for format code 'urn:nhs-ic:record-contact'. Expected 'Contact details (HTTP Unsecured)'", "expression": [ "content[0].format.display" ] } """ Scenario: Invalid content has extra field Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "someContact.co.uk" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extra_field": "hello", "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (content[0].extra_field: Extra inputs are not permitted)", "expression": [ "content[0].extra_field" ] } """ Scenario: codings with empty string or leading whitespace Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'context' is: """ "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "" } ] }, "facilityType": { "coding": [ { "system": " system", "code": "1234" } ] } } """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: context.practiceSetting.coding[0].display)", "expression": [ "DocumentReference" ] } """ Scenario: Reject DocumentReference with empty non-mandatory field (author) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'author' is: """ "author": [] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: author)", "expression": ["DocumentReference"] } """ Scenario: NRLRetrievalMechanism extension is empty Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].extension)", "expression": [ "DocumentReference" ] } """ Scenario: Multiple NRLRetrievalMechanism extensions in content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid content retrieval extension: Extension must have one content retrieval extension, see: ('https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism')", "expression": ["content[0].extension"] } """ Scenario: NRLRetrievalMechanism extension with mismatched code and display Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Spine Secure Proxy" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid content extension display: Spine Secure Proxy Expected display is 'Direct'", "expression": ["content[0].extension[0].valueCodeableConcept.coding[0].display"] } """ Scenario: NRLRetrievalMechanism extension with invalid URL case Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/england/structuredefinition/extension-england-nrlretrievalmechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request" } ] }, "diagnostics": "Invalid content retrieval extension (content[0].extension[0].url: Input should be 'https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism', see: https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism)", "expression": ["content[0].extension[0].url"] } """ Scenario: NRLRetrievalMechanism extension with invalid code Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "INVALID_CODE", "display": "Direct" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request" } ] }, "diagnostics": "Invalid content retrieval extension (content[0].extension[0].valueCodeableConcept.coding[0].code: Input should be 'SSP', 'Direct', 'LDR' or 'InContext', see: https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism)", "expression": ["content[0].extension[0].valueCodeableConcept.coding[0].code"] } """ Scenario: NRLRetrievalMechanism extension with missing display Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request" } ] }, "diagnostics": "Invalid content retrieval extension (content[0].extension[0].valueCodeableConcept.coding[0].display: Input should be 'Spine Secure Proxy', 'Direct', 'Large Document Retrieval' or 'Direct using In-Context', see: https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism)", "expression": ["content[0].extension[0].valueCodeableConcept.coding[0].display"] } """ Scenario: NRLRetrievalMechanism extension with missing valueCodeableConcept Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism" }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "BAD_REQUEST", "display": "Bad request" } ] }, "diagnostics": "Invalid content retrieval extension (content[0].extension[0].valueCodeableConcept: Input should be a valid dictionary or instance of NRLRetrievalMechanismExtensionValueCodeableConcept, see: https://fhir.nhs.uk/England/ValueSet/England-NRLRetrievalMechanism)", "expression": ["content[0].extension[0].valueCodeableConcept"] } """ NRLF-3.0.31/tests/features/producer/createDocumentReference-success.feature000066400000000000000000000625121511201605300267460ustar00rootroot00000000000000Feature: Producer - createDocumentReference - Success Scenarios Scenario: Successfully create a Document Pointer (care plan) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 788002001 | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/ANGY1-' And the resource in the Location header exists with values: | property | value | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 788002001 | # # NRL-766 Resolve custodian suffix issues # Scenario: Successfully create a Document Pointer (care plan) with custodian suffix # Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API # And the organisation 'ANGY1.suffix001a' is authorised to access pointer types: # | system | value | # | http://snomed.info/sct | 736253002 | # When producer 'ANGY1.suffix001a' creates a DocumentReference with values: # | property | value | # | subject | 9278693472 | # | status | current | # | type | 736253002 | # | category | 734163000 | # | custodian | ANGY1.suffix001a | # | author | HAR1 | # | url | https://example.org/my-doc.pdf | # Then the response status code is 201 # And the response is an OperationOutcome with 1 issue # And the OperationOutcome contains the issue: # """ # { # "severity": "information", # "code": "informational", # "details": { # "coding": [ # { # "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", # "code": "RESOURCE_CREATED", # "display": "Resource created" # } # ] # }, # "diagnostics": "The document has been created" # } # """ # And the response has a Location header # And the Location header starts with '/DocumentReference/ANGY1' # And the resource in the Location header exists with values: # | property | value | # | subject | 9278693472 | # | status | current | # | type | 736253002 | # | category | 734163000 | # | custodian | ANGY1 | # | author | HAR1 | # | url | https://example.org/my-doc.pdf | # Create superseding document reference Scenario: Successfully create a Document Pointer that supercedes another Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | ANGY1-111-SupercedeDocRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | ANGY1 | | author | HAR1 | | practiceSetting | 788002001 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/newdoc.pdf | | supercedes | ANGY1-111-SupercedeDocRefTest1 | | practiceSetting | 788002001 | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_SUPERSEDED", "display": "Resource created and resource(s) deleted" } ] }, "diagnostics": "The document has been superseded by a new version" } """ And the response has a Location header And the Location header starts with '/DocumentReference/ANGY1-' And the resource in the Location header exists with values: | property | value | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/newdoc.pdf | | practiceSetting | 788002001 | And the resource with id 'ANGY1-111-SupercedeDocRefTest1' does not exist # Create document reference with relatesTo - not code='replaces' # Create document reference with relatesTo - multiple Scenario Outline: Successfully create a document pointer of type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | | | category | | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 788002001 | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/ANGY1-' And the resource in the Location header exists with values: | property | value | | subject | 9278693472 | | status | current | | type | | | category | | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Examples: Care Plans | pointer-type | pointer-category | type-name | | 736253002 | 734163000 | MENTAL_HEALTH_PLAN | | 887701000000100 | 734163000 | EMERGENCY_HEALTHCARE_PLAN | | 861421000000109 | 734163000 | EOL_COORDINATION_SUMMARY | | 1382601000000107 | 734163000 | RESPECT_FORM | | 325691000000100 | 734163000 | CONTINGENCY_PLAN | | 736373009 | 734163000 | EOL_CARE_PLAN | | 16521000000101 | 734163000 | LLOYD_GEORGE_FOLDER | | 736366004 | 734163000 | ADVANCE_CARE_PLAN | | 735324008 | 734163000 | TREATMENT_ESCALATION_PLAN | | 2181441000000107 | 734163000 | PERSONALISED_CARE_AND_SUPPORT_PLAN | Examples: Observations | pointer-type | pointer-category | type-name | | 1363501000000100 | 1102421000000108 | NEWS2_CHART | Examples: Clinical Notes | pointer-type | pointer-category | type-name | | 824321000000109 | 823651000000106 | SUMMARY_RECORD | Examples: Record Artifacts and Headings | pointer-type | pointer-category | type-name | | 749001000000101 | 419891008 | APPOINTMENT | | 887181000000106 | 716931000000107 | SHARED_CARE_RECORD | # Create with content and contact details # Create with contact details only # Create with multiple attachments # Successfully create a Document Pointer with overridden created on date when producer has permission to set audit date # SSP URL?? Scenario: Successfully create a Document Pointer (imaging) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | https://nicip.nhs.uk | MAULR | | https://nicip.nhs.uk | MAXIB | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | MAULR | | type_system | https://nicip.nhs.uk | | category | 721981007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 788002001 | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/ANGY1-' And the resource in the Location header exists with values: | property | value | | subject | 9278693472 | | status | current | | type | MAULR | | type_system | https://nicip.nhs.uk | | category | 721981007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 788002001 | When producer 'ANGY1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | MAXIB | | type_system | https://nicip.nhs.uk | | category | 103693007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | practiceSetting | 788002001 | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/ANGY1-' And the resource in the Location header exists with values: | property | value | | subject | 9278693472 | | status | current | | type | MAXIB | | type_system | https://nicip.nhs.uk | | category | 103693007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Scenario Outline: Successfully create a BaRS Appointment pointer Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'BARS1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 749001000000101 | When producer 'BARS1' creates a DocumentReference with values: | property | value | | subject | 9278693472 | | status | current | | type | 749001000000101 | | category | 419891008 | | custodian | BARS1 | | author | HAR0 | | url | https://example.org/appt-link | | practiceSetting | 394802001 | | contentType | application/json+fhir | | formatCode | urn:nhs-ic:structured | | formatDisplay | Structured Document | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/ANGY1-' And the resource in the Location header exists with values: | property | value | | subject | 9278693472 | | status | current | | type | 749001000000101 | | category | 419891008 | | custodian | BARS1 | | author | HAR0 | | url | https://example.org/appt-link | | practiceSetting | 394802001 | | contentType | application/json+fhir | | formatCode | urn:nhs-ic:structured | | formatDisplay | Structured Document | Scenario: Successfully create a DocumentReference with two contents and different retrieval mechanisms Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/doc1.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } } ] }, { "attachment": { "contentType": "application/pdf", "url": "https://example.org/doc2.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "SSP", "display": "Spine Secure Proxy" } ] } } ] } ] """ Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/TSTCUS-' And the resource in the Location header exists with values: | property | value | | content[0].attachment.url | https://example.org/doc1.pdf | | content[0].extension[1].valueCodeableConcept.coding[0].code | Direct | | content[0].extension[1].valueCodeableConcept.coding[0].display | Direct | | content[1].attachment.url | https://example.org/doc2.pdf | | content[1].extension[1].valueCodeableConcept.coding[0].code | SSP | | content[1].extension[1].valueCodeableConcept.coding[0].display | Spine Secure Proxy | Scenario: Successfully create a Document Pointer with InContext retrieval mechanism and structured format Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "text/html", "url": "https://example.org/incontext-launch.html" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:structured", "display": "Structured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "dynamic", "display": "Dynamic" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "InContext", "display": "Direct using In-Context" } ] } } ] } ] """ Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the response has a Location header And the Location header starts with '/DocumentReference/TSTCUS-' And the resource in the Location header exists with values: | property | value | | content[0].attachment.url | https://example.org/incontext-launch.html | | content[0].attachment.contentType | text/html | | content[0].format.code | urn:nhs-ic:structured | | content[0].format.display | Structured Document | | content[0].extension[1].valueCodeableConcept.coding[0].code | InContext | | content[0].extension[1].valueCodeableConcept.coding[0].display | Direct using In-Context | NRLF-3.0.31/tests/features/producer/deleteDocumentReference-failure.feature000066400000000000000000000037051511201605300267230ustar00rootroot00000000000000# ID not in path # Invalid producer ID in ID Feature: Producer - deleteDocumentReference - Failure Scenarios Scenario: Cannot delete another organisation's Document Pointer Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'DK94' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 861421000000109 | And a DocumentReference resource exists with values: | property | value | | id | OC84-111-DeleteTest-NotYourPointer | | subject | 9278693472 | | status | current | | type | 861421000000109 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | OC84 | | author | N64 | When producer 'DK94' requests to delete DocumentReference with id 'OC84-111-DeleteTest-NotYourPointer' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error" } ] }, "diagnostics": "The requested DocumentReference cannot be deleted because it belongs to another organisation" } """ # Credentials - none provided # Credentials - missing pointer type # Invalid ID format (X26|something-) NRLF-3.0.31/tests/features/producer/deleteDocumentReference-success.feature000066400000000000000000000056341511201605300267470ustar00rootroot00000000000000# Delete by pointer ID Feature: Producer - deleteDocumentReference - Success Scenarios Scenario: Successfully delete a Document Pointer by logical ID Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'DK94' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 861421000000109 | And a DocumentReference resource exists with values: | property | value | | id | DK94-111-DeleteDocRefTest1 | | subject | 9278693472 | | status | current | | type | 861421000000109 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | DK94 | | author | N64 | When producer 'DK94' requests to delete DocumentReference with id 'DK94-111-DeleteDocRefTest1' Then the response status code is 200 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_DELETED", "display": "Resource deleted" } ] }, "diagnostics": "The requested DocumentReference has been deleted" } """ And the resource with id 'DK94-111-DeleteDocRefTest1' does not exist # Delete by pointer ID - URL encoded # Delete by pointer ID - not found Scenario: Document Pointer specified in delete request does not exist Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'DK94' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'DK94' requests to delete DocumentReference with id 'DK94-000-NoPointerHere' Then the response status code is 200 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_DELETED", "display": "Resource deleted" } ] }, "diagnostics": "The requested DocumentReference could not be found" } """ And the resource with id 'DK94-000-NoPointerHere' does not exist NRLF-3.0.31/tests/features/producer/headOnGetEndpoint.feature000066400000000000000000000052141511201605300240520ustar00rootroot00000000000000Feature: Producer - HEAD Requests Scenario Outline: DocumentReference with HEAD fails (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When producer 'RX898' sends HEAD request to 'DocumentReference' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 405 And the response has an empty body And the Allow header is 'GET,POST' Examples: | content_type | | application/json | | application/json+fhir | | application/fhir+json | Scenario Outline: DocumentReference/{id} with HEAD fails (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When producer 'RX898' sends HEAD request to 'DocumentReference/random-id' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 405 And the response has an empty body And the Allow header is 'GET,PUT,DELETE' Examples: | content_type | | application/json | | application/json+fhir | | application/fhir+json | Scenario Outline: DocumentReference with HEAD fails with 415 with unsupported (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When producer 'RX898' sends HEAD request to 'DocumentReference' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 415 And the Content-Type header is 'application/json' And the response has an empty body And the Allow header is not present Examples: | content_type | | application/notsupported | | application/helloworld | | application/harold | Scenario Outline: DocumentReference/{id} with HEAD fails with 415 with unsupported (Content-Type: ) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When producer 'RX898' sends HEAD request to 'DocumentReference/random-id' endpoint with headers: | header | value | | Content-Type | | Then the response status code is 415 And the Content-Type header is 'application/json' And the response has an empty body And the Allow header is not present Examples: | content_type | | application/notsupported | | application/helloworld | | application/harold | NRLF-3.0.31/tests/features/producer/readDocumentReference-failure.feature000066400000000000000000000136251511201605300263760ustar00rootroot00000000000000Feature: Producer - readDocumentReference - Failure Scenarios Scenario: Pointer not found Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'RX898' reads a DocumentReference with ID 'RX898-000000000-000000000' Then the response status code is 404 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "not-found", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "NO_RECORD_FOUND", "display": "No record found" } ] }, "diagnostics": "The requested DocumentReference could not be found" } """ Scenario: No pointer types registered for organisation Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | When producer 'RX898' reads a DocumentReference with ID 'RX898-000000000-000000000' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: No permission file exists for organisation Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API When producer 'RX898' reads a DocumentReference with ID 'RX898-000000000-000000000' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "ACCESS DENIED", "display": "Access has been denied to process this request" } ] }, "diagnostics": "Your organisation 'RX898' does not have permission to access this resource. Contact the onboarding team." } """ Scenario: Organisation attempts to access another organisation's pointer Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'RX898' reads a DocumentReference with ID 'X26-000000000-000000000' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error" } ] }, "diagnostics": "The requested DocumentReference cannot be read because it belongs to another organisation" } """ Scenario: Read document reference by ID - custodian suffix mismatch Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898.001' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And the organisation 'RX898.002' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898.001-1234567890-CustSuffixMismatch | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898.001 | | author | X26 | When producer 'RX898.001' reads a DocumentReference with ID 'RX898.001-1234567890-CustSuffixMismatch' Then the response status code is 200 When producer 'RX898.002' reads a DocumentReference with ID 'RX898.001-1234567890-CustSuffixMismatch' Then the response status code is 403 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "forbidden", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "AUTHOR_CREDENTIALS_ERROR", "display": "Author credentials error" } ] }, "diagnostics": "The requested DocumentReference cannot be read because it belongs to another organisation" } """ NRLF-3.0.31/tests/features/producer/readDocumentReference-success.feature000066400000000000000000000126421511201605300264150ustar00rootroot00000000000000# Read document reference by ID # Read document reference by ID - urlencoded Feature: Producer - readDocumentReference - Success Scenarios Scenario: Read document reference by ID Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898-9999999999-ReadDocRefSameCust | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | HAR1 | When producer 'RX898' reads a DocumentReference with ID 'RX898-9999999999-ReadDocRefSameCust' Then the response status code is 200 And the response is a DocumentReference with JSON value: """ { "resourceType": "DocumentReference", "id": "RX898-9999999999-ReadDocRefSameCust", "status": "current", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "736253002", "display": "Mental health crisis plan" } ] }, "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "734163000", "display": "Care plan" } ] } ], "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RX898" } }, "author": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "HAR1" } } ], "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } }, { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-NRLRetrievalMechanism", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLRetrievalMechanism", "code": "Direct", "display": "Direct" } ] } } ] } ], "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788007007", "display": "General practice service" } ] } } } """ Scenario: Read document reference by ID - custodian suffix Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898.001' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And the organisation 'RX898.002' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898.001-1234567890-ReadDocRefCustSuffix | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898.001 | | author | HAR1 | When producer 'RX898.001' reads a DocumentReference with ID 'RX898.001-1234567890-ReadDocRefCustSuffix' Then the response status code is 200 NRLF-3.0.31/tests/features/producer/searchDocumentReference-failure.feature000066400000000000000000000000001511201605300267070ustar00rootroot00000000000000NRLF-3.0.31/tests/features/producer/searchDocumentReference-success.feature000066400000000000000000000144661511201605300267550ustar00rootroot00000000000000Feature: Producer - searchDocumentReference - Success Scenarios Scenario: Search for DocumentReferences by NHS number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | RX898-1111111111-SearchNHSDocRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | RX898-1111111111-SearchNHSDocRefTest2 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | When producer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | subject | 9278693472 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | RX898-1111111111-SearchNHSDocRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | And the Bundle does not contain a DocumentReference with ID 'RX898-1111111111-SearchNHSDocRefTest2' Scenario: Search for DocumentReferences by pointer type and NHS number Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'RX898' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | | http://snomed.info/sct | 1363501000000100 | And a DocumentReference resource exists with values: | property | value | | id | RX898-1111111111-SearchNHSDocRefTest1 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | RX898-1111111111-SearchNHSDocRefTest2 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | And a DocumentReference resource exists with values: | property | value | | id | RX898-1111111111-SearchNHSDocRefTest3 | | subject | 9999999999 | | status | current | | type | 1363501000000100 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | When producer 'RX898' searches for DocumentReferences with parameters: | parameter | value | | pointer_type | 736253002 | | subject | 9999999999 | Then the response status code is 200 And the response is a searchset Bundle And the Bundle has a total of 1 And the Bundle has 1 entry And the Bundle contains an DocumentReference with values | property | value | | id | RX898-1111111111-SearchNHSDocRefTest2 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | RX898 | | author | X26 | And the Bundle does not contain a DocumentReference with ID 'RX898-1111111111-SearchNHSDocRefTest1' And the Bundle does not contain a DocumentReference with ID 'RX898-1111111111-SearchNHSDocRefTest3' NRLF-3.0.31/tests/features/producer/searchPostDocumentReference-failure.feature000066400000000000000000000000001511201605300275550ustar00rootroot00000000000000NRLF-3.0.31/tests/features/producer/searchPostDocumentReference-success.feature000066400000000000000000000000001511201605300275760ustar00rootroot00000000000000NRLF-3.0.31/tests/features/producer/updateDocumentReference-duplicateField.feature000066400000000000000000000134301511201605300302260ustar00rootroot00000000000000Feature: Producer - updateDocumentReference - Duplicate Field Scenarios Scenario: Duplicate url field in attachment Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | TSTCUS-updateDuplicateTest-1234 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | TSTCUS | | author | TSTCUS | When producer 'TSTCUS' requests update of a DocumentReference with pointerId 'TSTCUS-updateDuplicateTest-1234' but replacing 'content': """ [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf", "url": "https://example.org/duplicate-url.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['url']", "expression": [ "DocumentReference.content[0].attachment.url" ] } """ Scenario: Duplicate format and attachment field in content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | TSTCUS-updateDuplicateTest-1235 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | TSTCUS | | author | TSTCUS | When producer 'TSTCUS' requests update of a DocumentReference with pointerId 'TSTCUS-updateDuplicateTest-1235' but replacing 'content': """ [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "attachment": { "contentType": "text/html", "url": "https://example.org/contact-details.html" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['attachment', 'format']", "expression": [ "DocumentReference.content[0].attachment", "DocumentReference.content[0].format" ] } """ NRLF-3.0.31/tests/features/producer/updateDocumentReference-failure.feature000066400000000000000000000300501511201605300267340ustar00rootroot00000000000000# No pointer ID in headers # Pointer in URL and body mismatch # Invalid document reference - same as createDocumentReference # Invalid document reference - changing immutable fields # Provider ID mismatch # No existing document reference Feature: Producer - updateDocumentReference - Failure Scenarios Scenario: Invalid status Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | X26-1114567890-updateDocTest | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | X26 | | author | X26 | When producer 'X26' updates a DocumentReference 'X26-1114567890-updateDocTest' with values: | property | value | | status | invalid | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (status: String should match pattern '^current$')", "expression": [ "status" ] } """ Scenario: Missing content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | TSTCUS-1114567890-updateDocTest | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | TSTCUS | | author | TSTCUS | When producer 'TSTCUS' requests update of a DocumentReference with pointerId 'TSTCUS-1114567890-updateDocTest' and only changing: """ { "content": [] } """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)", "expression": [ "DocumentReference" ] } """ Scenario: contentType empty string Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | TSTCUS-1114567891-updateDocTest | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | TSTCUS | | author | TSTCUS | When producer 'TSTCUS' requests update of a DocumentReference with pointerId 'TSTCUS-1114567891-updateDocTest' and only changing: """ { "content": [ { "attachment": { "contentType": "", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] } """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)", "expression": [ "DocumentReference" ] } """ Scenario: Invalid contentType Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | TSTCUS-1114567892-updateDocTest | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | TSTCUS | | author | TSTCUS | When producer 'TSTCUS' requests update of a DocumentReference with pointerId 'TSTCUS-1114567892-updateDocTest' and only changing: """ { "content": [ { "attachment": { "contentType": "application/invalid", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] } """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid contentType: application/invalid. Must be 'application/pdf', 'text/html' or 'application/fhir+json'", "expression": [ "content[0].attachment.contentType" ] } """ Scenario: Mismatched format code and display Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | TSTCUS-1114567893-updateDocTest | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | TSTCUS | | author | TSTCUS | When producer 'TSTCUS' requests update of a DocumentReference with pointerId 'TSTCUS-1114567893-updateDocTest' and only changing: """ { "content": [ { "attachment": { "contentType": "text/html", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] } """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid display for format code 'urn:nhs-ic:record-contact'. Expected 'Contact details (HTTP Unsecured)'", "expression": [ "content[0].format.display" ] } """ NRLF-3.0.31/tests/features/producer/updateDocumentReference-success.feature000066400000000000000000000035221511201605300267610ustar00rootroot00000000000000# Update Document Reference # Update Document Reference urlencoded # Update Document Reference - multiple changes Feature: Producer - updateDocumentReference - Success Scenarios Scenario: Successfully Update a DocumentReference Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | And a DocumentReference resource exists with values: | property | value | | id | X26-1114567892-updateDocTest | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | contentType | application/pdf | | url | https://example.org/my-doc.pdf | | custodian | X26 | | author | X26 | When producer 'X26' updates a DocumentReference 'X26-1114567892-updateDocTest' with values: | property | value | | docStatus | entered-in-error | Then the response status code is 200 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_UPDATED", "display": "Resource updated" } ] }, "diagnostics": "The DocumentReference has been updated" } """ NRLF-3.0.31/tests/features/producer/upsertDocumentReference-duplicateField.feature000066400000000000000000000112221511201605300302630ustar00rootroot00000000000000Feature: Producer - upsertDocumentReference - Duplicate Field Scenarios Scenario: Duplicate url field in attachment Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests upsert of a DocumentReference with pointerId 'TSTCUS-testduplicates-upsert-0001-0001' and default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf", "url": "https://example.org/duplicate-url.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['url']", "expression": [ "DocumentReference.content[0].attachment.url" ] } """ Scenario: Duplicate format and attachment field in content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests upsert of a DocumentReference with pointerId 'TSTCUS-testduplicates-upsert-0001-0002' and default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "application/pdf", "url": "https://example.org/my-doc.pdf" }, "attachment": { "contentType": "text/html", "url": "https://example.org/contact-details.html" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Contact details (HTTP Unsecured)" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Duplicate keys found in FHIR document: ['attachment', 'format']", "expression": [ "DocumentReference.content[0].attachment", "DocumentReference.content[0].format" ] } """ NRLF-3.0.31/tests/features/producer/upsertDocumentReference-failure.feature000066400000000000000000000422131511201605300270000ustar00rootroot00000000000000Feature: Producer - upsertDocumentReference - Failure Scenarios Scenario: Invalid category for type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'X26' upserts a DocumentReference with values: | property | value | | id | X26-testid-upsert-0001-0001 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 1102421000000108 | | custodian | X26 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "The Category code of the provided document 'http://snomed.info/sct|1102421000000108' must match the allowed category for pointer type 'http://snomed.info/sct|736253002' with a category value of 'http://snomed.info/sct|734163000'", "expression": [ "category.coding[0].code" ] } """ Scenario: Invalid status Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'X26' upserts a DocumentReference with values: | property | value | | subject | 9999999999 | | type | 736253002 | | category | 734163000 | | custodian | X26 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | status | invalid | Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (status: String should match pattern '^current$')", "expression": [ "status" ] } """ Scenario: System not supported in NRL 3.0 Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | X26-testid-upsert-0001-0001 | | subject | 9278693472 | | status | current | | type_system | http://invalidsystem.info/sct | | type_display | Mental health crisis plan | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid type system: http://invalidsystem.info/sct Type system must be either 'http://snomed.info/sct' or 'https://nicip.nhs.uk'", "expression": ["type.coding[0].system"] } """ Scenario: Invalid Document Reference Type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | X26-testid-upsert-0001-0001 | | subject | 9999999999 | | status | current | | type | invalid | | type_system | http://snomed.info/sct | | type_display | Mental health crisis plan | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid type code: invalid Type must be a member of the England-NRLRecordType value set (https://fhir.nhs.uk/England/CodeSystem/England-NRLRecordType)", "expression": [ "type.coding[0].code" ] } """ Scenario: Mismatched Category Code for Document Reference Type Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'X26' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 1363501000000100 | | http://snomed.info/sct | 736253002 | When producer 'X26' upserts a DocumentReference with values: | property | value | | id | X26-testid-upsert-0001-0001 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 1102421000000108 | | custodian | X26 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "The Category code of the provided document 'http://snomed.info/sct|1102421000000108' must match the allowed category for pointer type 'http://snomed.info/sct|736253002' with a category value of 'http://snomed.info/sct|734163000'", "expression": [ "category.coding[0].code" ] } """ Scenario Outline: Invalid display value for type or category (imaging) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | https://nicip.nhs.uk | MAULR | | https://nicip.nhs.uk | MAXIB | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | ANGY1-testid-upsert-0001-0001 | | subject | 9999999999 | | status | current | | type_system | | | type_display | | | type | | | category | | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "type code '' must have a display value of ''", "expression": [ "type.coding[0].display" ] } """ Examples: | type-system | type-code | category-code | type-display | correct-display | | https://nicip.nhs.uk | MAULR | 721981007 | "Nonsense display" | MRA Upper Limb Rt | | https://nicip.nhs.uk | MAXIB | 103693007 | "Nonsense display" | MRI Axilla Both | Scenario: Missing content Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests upsert of a DocumentReference with pointerId 'TSTCUS-sample-id-00001' and default test values except 'content' is: """ "content": [] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)", "expression": [ "DocumentReference" ] } """ Scenario: contentType empty string Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests upsert of a DocumentReference with pointerId 'TSTCUS-sample-id-00002' and default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 400 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "invalid", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "MESSAGE_NOT_WELL_FORMED", "display": "Message not well formed" } ] }, "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)", "expression": [ "DocumentReference" ] } """ Scenario: Invalid contentType Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | TSTCUS-sample-id-00003 | | subject | 9999999999 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | | contentType | application/invalid | Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid contentType: application/invalid. Must be 'application/pdf', 'text/html' or 'application/fhir+json'", "expression": [ "content[0].attachment.contentType" ] } """ Scenario: Mismatched format code and display Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'TSTCUS' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'TSTCUS' requests upsert of a DocumentReference with pointerId 'TSTCUS-testid-upsert-0001-0001' and default test values except 'content' is: """ "content": [ { "attachment": { "contentType": "text/html", "url": "https://example.org/my-doc.pdf" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:record-contact", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ Then the response status code is 422 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "error", "code": "business-rule", "details": { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/Spine-ErrorOrWarningCode", "code": "UNPROCESSABLE_ENTITY", "display": "Unprocessable Entity" } ] }, "diagnostics": "Invalid display for format code 'urn:nhs-ic:record-contact'. Expected 'Contact details (HTTP Unsecured)'", "expression": [ "content[0].format.display" ] } """ NRLF-3.0.31/tests/features/producer/upsertDocumentReference-success.feature000066400000000000000000000140721511201605300270230ustar00rootroot00000000000000# Invalid target logical ID (wrong org prefix) # Invalid target logical ID (owned by this org, but pointer already exists) # Other edge cases will be same as create(POST) Feature: Producer - upsertDocumentReference - Success Scenarios Scenario: Successfully create a Document Pointer with a chosen logical ID (care plan) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | http://snomed.info/sct | 736253002 | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | ANGY1-testid-upsert-0001-0001 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the Document Reference 'ANGY1-testid-upsert-0001-0001' exists with values: | property | value | | id | ANGY1-testid-upsert-0001-0001 | | subject | 9278693472 | | status | current | | type | 736253002 | | category | 734163000 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Scenario: Successfully create a Document Pointer (imaging) Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API And the organisation 'ANGY1' is authorised to access pointer types: | system | value | | https://nicip.nhs.uk | MAULR | | https://nicip.nhs.uk | MAXIB | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | ANGY1-testid-upsert-0001-0001 | | subject | 9278693472 | | status | current | | type | MAULR | | type_system | https://nicip.nhs.uk | | category | 721981007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the Document Reference 'ANGY1-testid-upsert-0001-0001' exists with values: | property | value | | id | ANGY1-testid-upsert-0001-0001 | | subject | 9278693472 | | status | current | | type | MAULR | | type_system | https://nicip.nhs.uk | | category | 721981007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | When producer 'ANGY1' upserts a DocumentReference with values: | property | value | | id | ANGY1-testid-upsert-0001-0002 | | subject | 9278693472 | | status | current | | type | MAXIB | | type_system | https://nicip.nhs.uk | | category | 103693007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | Then the response status code is 201 And the response is an OperationOutcome with 1 issue And the OperationOutcome contains the issue: """ { "severity": "information", "code": "informational", "details": { "coding": [ { "system": "https://fhir.nhs.uk/ValueSet/NRL-ResponseCode", "code": "RESOURCE_CREATED", "display": "Resource created" } ] }, "diagnostics": "The document has been created" } """ And the Document Reference 'ANGY1-testid-upsert-0001-0002' exists with values: | property | value | | id | ANGY1-testid-upsert-0001-0002 | | subject | 9278693472 | | status | current | | type | MAXIB | | type_system | https://nicip.nhs.uk | | category | 103693007 | | custodian | ANGY1 | | author | HAR1 | | url | https://example.org/my-doc.pdf | NRLF-3.0.31/tests/features/steps/000077500000000000000000000000001511201605300164475ustar00rootroot00000000000000NRLF-3.0.31/tests/features/steps/1_setup.py000066400000000000000000000042761511201605300204120ustar00rootroot00000000000000import json from behave import * # noqa from behave.runner import Context from pydantic import BaseModel from nrlf.core.boto import get_s3_client from nrlf.core.dynamodb.model import DocumentPointer from tests.features.utils.data import create_test_document_reference class Application(BaseModel): app_id: str = "UNSET" app_name: str = "UNSET" def add_pointer_types(self, ods_code: str, context: Context): if not context.table: raise ValueError("No permissions table provided") pointer_types = [f"{system}|{value}" for system, value in context.table] bucket = f"nhsd-nrlf--{context.stack_name}-authorization-store" key = f"{self.app_id}/{ods_code}.json" s3_client = get_s3_client() s3_client.put_object(Bucket=bucket, Key=key, Body=json.dumps(pointer_types)) context.add_cleanup(lambda: s3_client.delete_object(Bucket=bucket, Key=key)) @given("the application '{app_name}' (ID '{app_id}') is registered to access the API") def register_application_step(context: Context, app_name: str, app_id: str): context.application = Application(app_id=app_id, app_name=app_name) @given("the organisation '{ods_code}' is authorised to access pointer types") def register_org_permissions_step(context: Context, ods_code: str): if not context.table: raise ValueError("No permissions table provided") context.application.add_pointer_types(ods_code, context) @given("a DocumentReference resource exists with values") def create_document_reference_step(context: Context): if not context.table: raise ValueError("No DocumentReference table provided") items = {row["property"]: row["value"] for row in context.table} base_doc_ref = create_test_document_reference(items) doc_pointer = DocumentPointer.from_document_reference(base_doc_ref) context.repository.create(doc_pointer) context.add_cleanup(clean_up_test_pointer, context, doc_pointer) def clean_up_test_pointer(context: Context, doc_pointer: DocumentPointer): """Remove a pointer during cleanup without failing if it has already been deleted""" if context.repository.get_by_id(doc_pointer.id): context.repository.delete(doc_pointer) NRLF-3.0.31/tests/features/steps/2_request.py000066400000000000000000000223531511201605300207370ustar00rootroot00000000000000import json from behave import * # noqa from behave.runner import Context from tests.features.utils.api_client import ( consumer_client_from_context, producer_client_from_context, ) from tests.features.utils.data import ( create_test_document_reference, create_test_document_reference_with_defaults, ) @when("consumer '{ods_code}' counts DocumentReferences with parameters") def consumer_count_document_references_step(context: Context, ods_code: str): client = consumer_client_from_context(context, ods_code) if not context.table: raise ValueError("No count query table provided") items = {row["parameter"]: row["value"] for row in context.table} context.response = client.count(items) @when("consumer '{ods_code}' searches for DocumentReferences with parameters") def consumer_search_document_reference_step(context: Context, ods_code: str): client = consumer_client_from_context(context, ods_code) if not context.table: raise ValueError("No search query table provided") items = {row["parameter"]: row["value"] for row in context.table} subject = items.pop("subject", None) custodian = items.pop("custodian", None) pointer_type = items.pop("pointer_type", None) context.response = client.search( nhs_number=subject, custodian=custodian, pointer_type=pointer_type, extra_params=items, ) @when( "consumer '{ods_code}' searches for DocumentReferences using POST with request body" ) def consumer_search_post_document_reference_step(context: Context, ods_code: str): client = consumer_client_from_context(context, ods_code) if not context.table: raise ValueError("No search query table provided") items = {row["key"]: row["value"] for row in context.table} subject = items.pop("subject", None) custodian = items.pop("custodian", None) pointer_type = items.pop("pointer_type", None) context.response = client.search_post( nhs_number=subject, custodian=custodian, pointer_type=pointer_type, extra_fields=items, ) @when("consumer '{ods_code}' reads a DocumentReference with ID '{doc_ref_id}'") def consumer_read_document_reference_step( context: Context, ods_code: str, doc_ref_id: str ): client = consumer_client_from_context(context, ods_code) context.response = client.read(doc_ref_id) @when("producer '{ods_code}' creates a DocumentReference with values") def create_post_document_reference_step(context: Context, ods_code: str): client = producer_client_from_context(context, ods_code) if not context.table: raise ValueError("No document reference data table provided") items = {row["property"]: row["value"] for row in context.table} doc_ref = create_test_document_reference(items) context.response = client.create(doc_ref.model_dump(exclude_none=True)) if context.response.status_code == 201: doc_ref_id = context.response.headers["Location"].split("/")[-1] doc_ref_id.replace( "|", "." ) # NRL-766 define and resolve custodian suffix behaviour context.add_cleanup(lambda: context.repository.delete_by_id(doc_ref_id)) def _create_or_upsert_body_step( context: Context, method: str, section: str, pointer_id: str = "TSTCUS-sample-id-00000", ): client = producer_client_from_context(context, "TSTCUS") if not context.text: raise ValueError("No document reference text snippet provided") doc_ref = create_test_document_reference_with_defaults( section, context.text, pointer_id ) context.response = getattr(client, method)(doc_ref) if context.response.status_code == 201: doc_ref_id = context.response.headers["Location"].split("/")[-1] doc_ref_id.replace( "|", "." ) # NRL-766 define and resolve custodian suffix behaviour context.add_cleanup(lambda: context.repository.delete_by_id(doc_ref_id)) @when( "producer 'TSTCUS' requests creation of a DocumentReference with default test values except '{section}' is" ) def create_post_body_step(context: Context, section: str): _create_or_upsert_body_step(context, "create_text", section) @when( "producer 'TSTCUS' requests upsert of a DocumentReference with pointerId '{pointer_id}' and default test values except '{section}' is" ) def upsert_post_body_step(context: Context, section: str, pointer_id: str): _create_or_upsert_body_step(context, "upsert_text", section, pointer_id) @when( "producer 'TSTCUS' requests update of a DocumentReference with pointerId '{pointer_id}' but replacing '{section}'" ) def update_post_body_step(context: Context, section: str, pointer_id: str): """This can only update top level fields""" consumer_client = consumer_client_from_context(context, "TSTCUS") context.response = consumer_client.read(pointer_id) if context.response.status_code != 200: raise ValueError(f"Failed to read existing pointer: {context.response.text}") doc_ref = context.response.json() doc_ref[section] = "placeholder" doc_ref_text = json.dumps(doc_ref) doc_ref_text = doc_ref_text.replace('"placeholder"', context.text) producer_client = producer_client_from_context(context, "TSTCUS") context.response = producer_client.update_text(doc_ref_text, pointer_id) @when( "producer 'TSTCUS' requests update of a DocumentReference with pointerId '{pointer_id}' and only changing" ) def update_post_body_step(context: Context, pointer_id: str): """ Updates an existing DocumentReference with new values for a specific section """ consumer_client = consumer_client_from_context(context, "TSTCUS") context.response = consumer_client.read(pointer_id) if context.response.status_code != 200: raise ValueError(f"Failed to read existing pointer: {context.response.text}") doc_ref = context.response.json() custom_data = json.loads(context.text) for key in custom_data: doc_ref[key] = custom_data[key] producer_client = producer_client_from_context(context, "TSTCUS") context.response = producer_client.update(doc_ref, pointer_id) @when("producer '{ods_code}' upserts a DocumentReference with values") def create_put_document_reference_step(context: Context, ods_code: str): client = producer_client_from_context(context, ods_code) if not context.table: raise ValueError("No document reference data table provided") items = {row["property"]: row["value"] for row in context.table} doc_ref = create_test_document_reference(items) doc_ref_id = items.get("id") context.response = client.upsert(doc_ref.model_dump(exclude_none=True)) if context.response.status_code == 201: context.add_cleanup(lambda: context.repository.delete_by_id(doc_ref_id)) @when("producer '{ods_code}' updates a DocumentReference '{doc_ref_id}' with values") def update_put_document_reference_step( context: Context, ods_code: str, doc_ref_id: str ): client = producer_client_from_context(context, ods_code) if not context.table: raise ValueError("No document reference data table provided") items = {row["property"]: row["value"] for row in context.table} doc_ref = client.read(doc_ref_id).json() for key, value in items.items(): doc_ref.update({key: value}) context.response = client.update(doc_ref, doc_ref_id) if context.response.status_code == 200: context.add_cleanup(lambda: context.repository.delete_by_id(doc_ref_id)) @when( "producer '{ods_code}' requests to delete DocumentReference with id '{doc_ref_id}'" ) def delete_document_reference_step(context: Context, ods_code: str, doc_ref_id: str): client = producer_client_from_context(context, ods_code) context.response = client.delete(doc_ref_id) @when("producer '{ods_code}' reads a DocumentReference with ID '{doc_ref_id}'") def producer_read_document_reference_step( context: Context, ods_code: str, doc_ref_id: str ): client = producer_client_from_context(context, ods_code) context.response = client.read(doc_ref_id) @when("producer '{ods_code}' searches for DocumentReferences with parameters") def producer_search_document_reference_step(context: Context, ods_code: str): client = producer_client_from_context(context, ods_code) if not context.table: raise ValueError("No search query table provided") items = {row["parameter"]: row["value"] for row in context.table} subject = items.pop("subject", None) pointer_type = items.pop("pointer_type", None) context.response = client.search( nhs_number=subject, pointer_type=pointer_type, extra_params=items, ) @when( "{consumer_or_producer} '{ods_code}' sends HEAD request to '{endpoint}' endpoint with headers" ) def consumer_head_request_step( context: Context, consumer_or_producer: str, ods_code: str, endpoint: str ): if not context.table: raise ValueError("No headers table provided") headers = {row["header"]: row["value"] for row in context.table} if consumer_or_producer == "producer": client = producer_client_from_context(context, ods_code) elif consumer_or_producer == "consumer": client = consumer_client_from_context(context, ods_code) context.response = client.head(endpoint, headers=headers) NRLF-3.0.31/tests/features/steps/3_assert.py000066400000000000000000000343231511201605300205510ustar00rootroot00000000000000import json from behave import * # noqa from behave.runner import Context from nrlf.producer.fhir.r4.model import Bundle, DocumentReference, OperationOutcome def format_error( message: str, expected: str | None, actual: str | None, response: str | None ): message = f"{message}\n\nExpected: {expected}\nActual: {actual}" if response: message += f"\n\nResponse body:\n{response}" return message @then("the response status code is {status_code}") def assert_response_status_code_step(context: Context, status_code: str): assert context.response.status_code == int(status_code), format_error( "Status code does not match", status_code, str(context.response.status_code), context.response.text, ) @then("the response does not contain the key '{key}'") def assert_response_no_key_in_response_step(context: Context, key: str): assert key not in context.response.json(), f"Key {key} found in response" @then("the response is a {bundle_type} Bundle") def assert_bundle_step(context: Context, bundle_type: str): body = context.response.json() assert body["resourceType"] == "Bundle", format_error( "Unexpected resourceType", "Bundle", body["resourceType"], context.response.text, ) assert body["type"] == bundle_type, format_error( "Unexpected type", bundle_type, body["type"], context.response.text, ) context.bundle = Bundle.model_validate(body) @then("the response has an empty body") def assert_empty_body_step(context: Context): """ Asserts that the response body is empty. """ assert context.response.text == "", format_error( "Response body is not empty", "empty", context.response.text, context.response.text, ) context.bundle = None @then("the Bundle has a total of {total}") def assert_bundle_total_step(context: Context, total: str): assert ( context.bundle is not None ), "The Bundle has not been yet parsed from the response" assert context.bundle.total == int(total), format_error( "Unexpected Bundle total", total, str(context.bundle.total), context.response.text, ) @then("the Bundle has a self link matching '{rel_url}'") def assert_bundle_self(context: Context, rel_url: str): assert ( context.bundle is not None ), "The Bundle has not yet been parsed from the response" assert context.bundle.link is not None, format_error( "No links present in the Bundle", f"{context.base_url}{rel_url}", "None", context.response.text, ) assert len(context.bundle.link) == 1, format_error( "The Bundle's link array should contain a single item if no pagination is used", "1 entry", f"{len(context.bundle.link)} entries", context.response.text, ) link_entry = context.bundle.link[0].model_dump(exclude_none=True) assert link_entry.get("relation") == "self", format_error( "Link should specify a 'self' type relation", "self", link_entry.get("relation"), context.response.text, ) actual_url_params = link_entry.get("url").split("consumer/FHIR/R4/")[-1] assert actual_url_params == rel_url, format_error( "Link url does not specify the search parameters expected", rel_url, actual_url_params, context.response.text, ) @then("the Bundle has {num_entries} entry") @then("the Bundle has {num_entries} entries") def assert_bundle_entries_step(context: Context, num_entries: str): assert ( context.bundle is not None ), "The Bundle has not been yet parsed from the response" assert len(context.bundle.entry) == int(num_entries), format_error( "Unexpected number of Bundle entries", num_entries, str(len(context.bundle.entry)), context.response.text, ) def assert_document_reference_matches_value( context: Context, doc_ref: dict | DocumentReference, items: dict ): """ Asserts that the given document reference matches the expected values. Args: context (Context): The context object. doc_ref (dict): The actual document reference. items (dict): The expected values for the document reference. Raises: AssertionError: If any of the document reference values do not match the expected values. """ if isinstance(doc_ref, dict): doc_ref = DocumentReference.model_validate(doc_ref) assert doc_ref.id == items["id"], format_error( "DocumentReference ID does not match", items["id"], doc_ref.id, context.response.json(), ) if status := items.get("status"): assert doc_ref.status == status, format_error( "DocumentReference status does not match", status, doc_ref.status, context.response.json(), ) if type_code := items.get("type"): assert doc_ref.type.coding[0].code == type_code, format_error( "DocumentReference type does not match", type_code, doc_ref.type.coding[0].code, context.response.json(), ) if type_system := items.get("type_system"): assert doc_ref.type.coding[0].system == type_system, format_error( "DocumentReference type does not match", type_system, doc_ref.type.coding[0].system, context.response.json(), ) if type_display := items.get("type_display"): assert doc_ref.type.coding[0].display == type_display, format_error( "DocumentReference type does not match", type_display, doc_ref.type.coding[0].display, context.response.json(), ) if category := items.get("category"): assert doc_ref.category[0].coding[0].code == category, format_error( "DocumentReference custodian does not match", category, doc_ref.category[0].coding[0].code, context.response.json(), ) if subject := items.get("subject"): assert doc_ref.subject.identifier.value == subject, format_error( "DocumentReference subject does not match", subject, doc_ref.subject.identifier.value, context.response.json(), ) if custodian := items.get("custodian"): assert doc_ref.custodian.identifier.value == custodian, format_error( "DocumentReference custodian does not match", custodian, doc_ref.custodian.identifier.value, context.response.json(), ) if author := items.get("author"): assert doc_ref.author[0].identifier.value == author, format_error( "DocumentReference author does not match", author, doc_ref.author[0].identifier.value, context.response.json(), ) if content_type := items.get("contentType"): assert doc_ref.content[0].attachment.contentType == content_type, format_error( "DocumentReference content type does not match", content_type, doc_ref.content[0].attachment.contentType, context.response.json(), ) if url := items.get("url"): assert doc_ref.content[0].attachment.url == url, format_error( "DocumentReference URL does not match", url, doc_ref.content[0].attachment.url, context.response.json(), ) if identifier := items.get("identifier"): assert doc_ref.identifier[0].value == identifier, format_error( "DocumentReference Identifier does not match", identifier, doc_ref.identifier[0].value, context.response.json(), ) @then("the Bundle contains an DocumentReference with values") def assert_bundle_contains_documentreference_values_step(context: Context): if not context.table: raise ValueError("No DocumentReference table provided") items = {row["property"]: row["value"] for row in context.table} if not items.get("id"): raise ValueError("No id provided in the table") for entry in context.bundle.entry: if entry.resource.id != items["id"]: continue return assert_document_reference_matches_value(context, entry.resource, items) raise AssertionError( f"DocumentReference with id {items['id']} not found in the response\n\nFull response:\n{json.dumps(context.response.json(), indent=2)}" ) @then("the Bundle does not contain a DocumentReference with ID '{doc_ref_id}'") def assert_bundle_does_not_contain_doc_ref_step(context: Context, doc_ref_id: str): for entry in context.bundle.entry: assert ( entry.resource.id != doc_ref_id ), f"DocumentReference with ID {doc_ref_id} found in the response" @then("the response is an OperationOutcome with {num_issues} issue") @then("the response is an OperationOutcome with {num_issues} issues") def assert_response_operation_outcome_step(context: Context, num_issues: str): body = context.response.json() assert body["resourceType"] == "OperationOutcome" assert len(body["issue"]) == int(num_issues) context.operation_outcome = OperationOutcome.model_validate(body) @then("the OperationOutcome contains the issue") def assert_response_operation_outcome_issue(context: Context): if not context.text: raise ValueError("No issue JSON provided") try: content = json.loads(context.text) except: raise ValueError("Invalid JSON provided") for issue in context.operation_outcome.issue: if issue.model_dump(exclude_none=True) == content: return raise ValueError( f"Could not find issue in response:\n\nFull Response:\n{json.dumps(context.response.json(), indent=2)}\n\nExpected Issue:\n{json.dumps(content, indent=2)}" ) @then("the response is a DocumentReference with JSON value") def assert_response_document_reference_step(context: Context): if not context.text: raise ValueError("No DocumentReference JSON provided") try: content = json.loads(context.text) except: raise ValueError("Invalid JSON provided") assert context.response.json()["resourceType"] == "DocumentReference", format_error( "Response is not a DocumentReference", "DocumentReference", context.response.json()["resourceType"], context.response.text, ) assert context.response.json() == content, format_error( "DocumentReference does not match", json.dumps(content, indent=2), json.dumps(context.response.json(), indent=2), context.response.text, ) @then("the {header_name} header is '{header_value}'") def assert_header(context: Context, header_name: str, header_value: str): assert context.response.headers.get(header_name) == header_value, format_error( f"Header {header_name} does not match", header_value, context.response.headers.get(header_name), context.response.text, ) @then("the response has a {header_name} header") def assert_location_header(context: Context, header_name: str): generated_id = context.response.headers.get(header_name) # check there is a location header assert generated_id is not None, format_error( f"Missing {header_name} header", None, None, context.response.text, ) context.pointer_id = generated_id @then("the {header_name} header is not present") def assert_header_not_present(context: Context, header_name: str): header_value = context.response.headers.get(header_name) assert header_value is None, format_error( f"Header {header_name} should not be present", "not present", header_value, context.response.text, ) @then("the {header_name} header starts with '{starts_with}'") def assert_header_starts_with(context: Context, header_name: str, starts_with: str): header_value = context.response.headers.get(header_name) assert header_value.startswith(starts_with), format_error( f"Header {header_name} does not start with expected value", starts_with, header_value, context.response.text, ) @then("the resource in the Location header exists with values") def assert_resource_in_location_header_exists_with_values(context: Context): location = context.response.headers.get("Location") assert location.startswith("/DocumentReference/"), format_error( "Unexpected Location header", "/DocumentReference/", location, context.response.text, ) resource_id = location.split("/")[-1] resource_id.replace("|", ".") # NRL-766 define and verify custodian suffix formats resource = context.repository.get_by_id(resource_id) assert resource is not None, format_error( "Resource does not exist", resource_id, None, context.response.text, ) if not context.table: raise ValueError("No DocumentReference table provided") items = {row["property"]: row["value"] for row in context.table} items["id"] = resource_id assert_document_reference_matches_value( context, DocumentReference.model_validate_json(resource.document), items ) @then("the Document Reference '{doc_ref_id}' exists with values") def assert_resource_exists_with_values(context: Context, doc_ref_id: str): resource = context.repository.get_by_id(doc_ref_id) assert resource is not None, format_error( "Resource does not exist", doc_ref_id, None, context.response.text, ) if not context.table: raise ValueError("No DocumentReference table provided") items = {row["property"]: row["value"] for row in context.table} assert_document_reference_matches_value( context, DocumentReference.model_validate_json(resource.document), items ) @then("the resource with id '{doc_ref_id}' does not exist") def assert_resource_absent(context: Context, doc_ref_id: str): resource = context.repository.get_by_id(doc_ref_id) assert resource is None, format_error( "Resource that should be absent is found in database by id", None, doc_ref_id, DocumentReference.model_validate_json(resource.document), ) NRLF-3.0.31/tests/features/utils/000077500000000000000000000000001511201605300164515ustar00rootroot00000000000000NRLF-3.0.31/tests/features/utils/api_client.py000066400000000000000000000024761511201605300211430ustar00rootroot00000000000000from behave.runner import Context from nrlf.core.model import ConnectionMetadata from tests.utilities.api_clients import ( ClientConfig, ConsumerTestClient, ProducerTestClient, ) def _config_from_context(context: Context, ods_code: str): feature_test_headers = { "X-Request-Id": context.request_id, "NHSD-Correlation-Id": context.correlation_id, } return ClientConfig( base_url=context.base_url, custom_headers=feature_test_headers, client_cert=context.client_cert, connection_metadata=ConnectionMetadata.model_validate( { "nrl.ods-code": ods_code, "nrl.permissions": [], "nrl.app-id": context.application.app_id, "client_rp_details": { "developer.app.name": context.application.app_name, "developer.app.id": context.application.app_id, }, } ), ) def consumer_client_from_context(context: Context, ods_code: str): client_config = _config_from_context(context, ods_code) return ConsumerTestClient(config=client_config) def producer_client_from_context(context: Context, ods_code: str): client_config = _config_from_context(context, ods_code) return ProducerTestClient(config=client_config) NRLF-3.0.31/tests/features/utils/certificates.py000066400000000000000000000017551511201605300215000ustar00rootroot00000000000000from pathlib import Path from typing import Optional, Tuple TRUSTSTORE_PATH = Path(__file__).parent / "../../../truststore/" CLIENT_CERT_PATH = TRUSTSTORE_PATH / "client" def get_cert_path_for_environment(environment: Optional[str]) -> Tuple[str, str]: """ This function returns the certificate for the given environment """ if not environment: raise ValueError("Environment (env) not provided") cert_path: Optional[Path] = None key_path: Optional[Path] = None match environment: case "dev": cert_path = CLIENT_CERT_PATH / "dev.crt" key_path = CLIENT_CERT_PATH / "dev.key" case _: cert_path = CLIENT_CERT_PATH / "dev.crt" key_path = CLIENT_CERT_PATH / "dev.key" if not cert_path.exists() or not key_path.exists(): raise FileNotFoundError( f"Client certificate not found at {cert_path} or {key_path}" ) return (str(cert_path.resolve()), str(key_path.resolve())) NRLF-3.0.31/tests/features/utils/constants.py000066400000000000000000000053571511201605300210510ustar00rootroot00000000000000DEFAULT_TEST_SUBJECT = """ "subject": { "identifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } } """ DEFAULT_TEST_AUTHOR = """ "author": [{ "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "TSTAUT" } }] """ DEFAULT_TEST_CUSTODIAN = """ "custodian": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "TSTCUS" } } """ DEFAULT_TEST_TYPE = """ "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "1363501000000100", "display": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart" } ] } """ DEFAULT_TEST_CATEGORY = """ "category": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "1102421000000108", "display": "Observations" } ] } ] """ DEFAULT_TEST_MASTER_ID = """ "masterIdentifier": { "system": "test-master-id-default-system", "value": "test-master-id-default-value" } """ DEFAULT_TEST_CONTEXT = """ "context": { "practiceSetting": { "coding": [ { "system": "http://snomed.info/sct", "code": "788002001", "display": "Adult mental health service" } ] }, "related": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", "value": "230811201350" } } ] } """ DEFAULT_TEST_DESCRIPTION = """ "description": "This is the default description for a test pointer." """ DEFAULT_TEST_SECURITY_LABEL = """ "securityLabel": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality", "code": "V", "display": "very restricted" } ] } ] """ DEFAULT_TEST_CONTENT = """ "content": [ { "attachment": { "contentType": "application/pdf", "language": "en-UK", "url": "https://spine-proxy.national.ncrs.nhs.uk/https%3A%2F%2Fp1.nhs.uk%2FMentalhealthCrisisPlanReport.pdf", "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=", "title": "Mental health crisis plan report", "creation": "2022-12-21T10:45:41+11:00" }, "format": { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLFormatCode", "code": "urn:nhs-ic:unstructured", "display": "Unstructured Document" }, "extension": [ { "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability", "valueCodeableConcept": { "coding": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability", "code": "static", "display": "Static" } ] } } ] } ] """ NRLF-3.0.31/tests/features/utils/data.py000066400000000000000000000170761511201605300177470ustar00rootroot00000000000000from layer.nrlf.core.constants import ( CATEGORY_ATTRIBUTES, CONTENT_FORMAT_CODE_URL, CONTENT_RETRIEVAL_EXTENSION_URL, CONTENT_RETRIEVAL_SYSTEM_URL, CONTENT_STABILITY_EXTENSION_URL, CONTENT_STABILITY_SYSTEM_URL, SNOMED_PRACTICE_SETTINGS, SNOMED_SYSTEM_URL, TYPE_ATTRIBUTES, ) from nrlf.producer.fhir.r4.model import ( Attachment, CodeableConcept, ContentStabilityExtension, ContentStabilityExtensionCoding, ContentStabilityExtensionValueCodeableConcept, DocumentReference, DocumentReferenceContent, DocumentReferenceContext, DocumentReferenceRelatesTo, Identifier, NRLCodeableConcept, NRLCoding, NRLFormatCode, NRLRetrievalMechanismExtension, NRLRetrievalMechanismExtensionCoding, NRLRetrievalMechanismExtensionValueCodeableConcept, Reference, ) from tests.features.utils.constants import ( DEFAULT_TEST_AUTHOR, DEFAULT_TEST_CATEGORY, DEFAULT_TEST_CONTENT, DEFAULT_TEST_CONTEXT, DEFAULT_TEST_CUSTODIAN, DEFAULT_TEST_DESCRIPTION, DEFAULT_TEST_MASTER_ID, DEFAULT_TEST_SECURITY_LABEL, DEFAULT_TEST_SUBJECT, DEFAULT_TEST_TYPE, ) def create_test_document_reference(items: dict) -> DocumentReference: practice_setting_code = items.get("practiceSetting", "788007007") practice_setting_display = SNOMED_PRACTICE_SETTINGS.get( str(practice_setting_code), "General practice service" ) base_doc_ref = DocumentReference.model_construct( resourceType="DocumentReference", status=items.get("status", "current"), content=items.get( "content", [ DocumentReferenceContent( attachment=Attachment( contentType=items.get("contentType", "application/pdf"), url=items["url"], ), format=NRLFormatCode( system=items.get( "formatSystem", CONTENT_FORMAT_CODE_URL, ), code=items.get("formatCode", "urn:nhs-ic:unstructured"), display=items.get("formatDisplay", "Unstructured Document"), ), extension=[ ContentStabilityExtension( url=CONTENT_STABILITY_EXTENSION_URL, valueCodeableConcept=ContentStabilityExtensionValueCodeableConcept( coding=[ ContentStabilityExtensionCoding( system=CONTENT_STABILITY_SYSTEM_URL, code="static", display="Static", ) ] ), ), NRLRetrievalMechanismExtension( url=CONTENT_RETRIEVAL_EXTENSION_URL, valueCodeableConcept=NRLRetrievalMechanismExtensionValueCodeableConcept( coding=[ NRLRetrievalMechanismExtensionCoding( system=CONTENT_RETRIEVAL_SYSTEM_URL, code="Direct", display="Direct", ) ] ), ), ], ) ], ), context=DocumentReferenceContext( practiceSetting=NRLCodeableConcept( coding=[ NRLCoding( system=SNOMED_SYSTEM_URL, code=str(practice_setting_code), display=practice_setting_display, ) ] ) ), ) if items.get("id"): base_doc_ref.id = items["id"] if type_code := items.get("type"): type_system = items.get("type_system", SNOMED_SYSTEM_URL) type_str = f"{type_system}|{type_code}" type_display = items.get( "type_display", TYPE_ATTRIBUTES.get(type_str, {}).get("display") ) base_doc_ref.type = NRLCodeableConcept( coding=[NRLCoding(system=type_system, code=type_code, display=type_display)] ) if items.get("subject"): base_doc_ref.subject = Reference( identifier=Identifier( system="https://fhir.nhs.uk/Id/nhs-number", value=items["subject"] ) ) if items.get("custodian"): base_doc_ref.custodian = Reference( identifier=Identifier( system="https://fhir.nhs.uk/Id/ods-organization-code", value=items["custodian"], ) ) if items.get("author"): base_doc_ref.author = [ Reference( identifier=Identifier( system="https://fhir.nhs.uk/Id/ods-organization-code", value=items["author"], ) ) ] if items.get("category"): category_display = CATEGORY_ATTRIBUTES.get( f"{SNOMED_SYSTEM_URL}|{items['category']}", {} ).get("display") base_doc_ref.category = [ NRLCodeableConcept( coding=[ NRLCoding( system=SNOMED_SYSTEM_URL, code=items["category"], display=category_display, ) ] ) ] if items.get("supercedes"): base_doc_ref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference( type="DocumentReference", identifier=Identifier( system="https://fhir.nhs.uk/Id/ods-organization-code", value=items["supercedes"], ), ), ) ] if items.get("identifier"): base_doc_ref.identifier = [ Identifier( type=CodeableConcept(text="Accession-Number"), value=items["identifier"] ) ] return base_doc_ref def create_test_document_reference_with_defaults( section: str, custom_data: str, pointer_id: str = "TSTCUS-sample-id-00000" ) -> str: """ Builds a DocumentReference request body for testing purposes, using a valid example DocumentReference body as a default, but with one top-level section of the resource overwritten by a json string """ doc_ref_text = f"""{{ "resourceType": "DocumentReference", "id": "{pointer_id}", "status": "current", "docStatus": "final", {custom_data if section=="masterIdentifier" else DEFAULT_TEST_MASTER_ID}, {custom_data if section=="subject" else DEFAULT_TEST_SUBJECT}, {custom_data if section=="custodian" else DEFAULT_TEST_CUSTODIAN}, {custom_data if section=="author" else DEFAULT_TEST_AUTHOR}, {custom_data if section=="type" else DEFAULT_TEST_TYPE}, {custom_data if section=="category" else DEFAULT_TEST_CATEGORY}, {custom_data if section=="description" else DEFAULT_TEST_DESCRIPTION}, {custom_data if section=="security" else DEFAULT_TEST_SECURITY_LABEL}, {custom_data if section=="content" else DEFAULT_TEST_CONTENT}, {custom_data if section=="context" else DEFAULT_TEST_CONTEXT} }}""" return doc_ref_text NRLF-3.0.31/tests/performance/000077500000000000000000000000001511201605300157745ustar00rootroot00000000000000NRLF-3.0.31/tests/performance/constants.js000066400000000000000000000017401511201605300203500ustar00rootroot00000000000000export const DEFAULT_TEST_RECORD = open( "../data/DocumentReference/Y05868-736253002-Valid.json" ); export const ODS_CODE = "Y05868"; export const REFERENCE_DATA = JSON.parse(open("./reference-data.json")); export const POINTER_DOCUMENTS = "documents" in REFERENCE_DATA ? REFERENCE_DATA["documents"] : {}; export const ALL_POINTER_IDS = "pointer_ids" in REFERENCE_DATA ? REFERENCE_DATA["pointer_ids"] : Object.keys(POINTER_DOCUMENTS); export const POINTERS_TO_DELETE = ALL_POINTER_IDS.slice(0, 3500); export const POINTER_IDS = ALL_POINTER_IDS.slice(3500); export const NHS_NUMBERS = REFERENCE_DATA["nhs_numbers"]; export const POINTER_TYPES = [ "736253002", "1363501000000100", "1382601000000107", "325691000000100", "736373009", "861421000000109", "887701000000100", "736366004", "735324008", "824321000000109", "2181441000000107", ]; export const CATEGORIES = [ "734163000", "1102421000000108", "823651000000106", "721981007", "103693007", ]; NRLF-3.0.31/tests/performance/consumer/000077500000000000000000000000001511201605300176275ustar00rootroot00000000000000NRLF-3.0.31/tests/performance/consumer/baseline.js000066400000000000000000000044271511201605300217560ustar00rootroot00000000000000export * from "./client.js"; export const options = { tlsAuth: [ { cert: open(`../../../truststore/client/${__ENV.ENV_TYPE}.crt`), key: open(`../../../truststore/client/${__ENV.ENV_TYPE}.key`), }, ], scenarios: { countDocumentReference: { exec: "countDocumentReference", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, countPostDocumentReference: { exec: "countPostDocumentReference", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, readDocumentReference: { exec: "readDocumentReference", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, searchDocumentReference: { exec: "searchDocumentReference", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, searchDocumentReferenceByCategory: { exec: "searchDocumentReferenceByCategory", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, searchPostDocumentReference: { exec: "searchPostDocumentReference", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, searchPostDocumentReferenceByCategory: { exec: "searchPostDocumentReferenceByCategory", executor: "ramping-arrival-rate", startRate: 1, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 5, duration: "30s" }, { target: 5, duration: "1m" }, ], }, }, }; NRLF-3.0.31/tests/performance/consumer/client.js000066400000000000000000000105271511201605300214500ustar00rootroot00000000000000import { NHS_NUMBERS, POINTER_IDS, POINTER_TYPES, ODS_CODE, CATEGORIES, } from "../constants.js"; import http from "k6/http"; import { check } from "k6"; function getHeaders(odsCode = ODS_CODE) { return { "Content-Type": "application/fhir+json", "X-Request-Id": "K6PerformanceTest", "NHSD-Correlation-Id": "K6PerformanceTest", "NHSD-Connection-Metadata": JSON.stringify({ "nrl.ods-code": odsCode, "nrl.pointer-types": POINTER_TYPES.map( (type) => `http://snomed.info/sct|${type}` ), "nrl.app-id": "K6PerformanceTest", }), "NHSD-Client-RP-Details": JSON.stringify({ "developer.app.name": "K6PerformanceTest", "developer.app.id": "K6PerformanceTest", }), }; } function checkResponse(res) { const is_success = check(res, { "status is 200": (r) => r.status === 200 }); if (!is_success) { console.warn(res.json()); } } export function countDocumentReference() { const choice = Math.floor(Math.random() * NHS_NUMBERS.length); const nhsNumber = NHS_NUMBERS[choice]; const identifier = encodeURIComponent( `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}` ); const res = http.get( `https://${__ENV.HOST}/consumer/DocumentReference?_summary=count&subject:identifier=${identifier}`, { headers: getHeaders(), } ); checkResponse(res); } export function readDocumentReference() { const choice = Math.floor(Math.random() * POINTER_IDS.length); const id = POINTER_IDS[choice]; const res = http.get( `https://${__ENV.HOST}/consumer/DocumentReference/${id}`, { headers: getHeaders(), } ); checkResponse(res); } export function searchDocumentReference() { const nhsNumber = NHS_NUMBERS[Math.floor(Math.random() * NHS_NUMBERS.length)]; const pointer_type = POINTER_TYPES[Math.floor(Math.random() * POINTER_TYPES.length)]; const identifier = encodeURIComponent( `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}` ); const type = encodeURIComponent(`http://snomed.info/sct|${pointer_type}`); const res = http.get( `https://${__ENV.HOST}/consumer/DocumentReference?subject:identifier=${identifier}&type=${type}`, { headers: getHeaders(), } ); checkResponse(res); } export function searchDocumentReferenceByCategory() { const nhsNumber = NHS_NUMBERS[Math.floor(Math.random() * NHS_NUMBERS.length)]; const randomCategory = CATEGORIES[Math.floor(Math.random() * CATEGORIES.length)]; const identifier = encodeURIComponent( `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}` ); const category = encodeURIComponent( `http://snomed.info/sct|${randomCategory}` ); const res = http.get( `https://${__ENV.HOST}/consumer/DocumentReference?subject:identifier=${identifier}&category=${category}`, { headers: getHeaders(), } ); checkResponse(res); } export function searchPostDocumentReference() { const nhsNumber = NHS_NUMBERS[Math.floor(Math.random() * NHS_NUMBERS.length)]; const pointer_type = POINTER_TYPES[Math.floor(Math.random() * POINTER_TYPES.length)]; const body = JSON.stringify({ "subject:identifier": `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}`, type: `http://snomed.info/sct|${pointer_type}`, }); const res = http.post( `https://${__ENV.HOST}/consumer/DocumentReference/_search`, body, { headers: getHeaders(), } ); checkResponse(res); } export function searchPostDocumentReferenceByCategory() { const nhsNumber = NHS_NUMBERS[Math.floor(Math.random() * NHS_NUMBERS.length)]; const category = CATEGORIES[Math.floor(Math.random() * CATEGORIES.length)]; const body = JSON.stringify({ "subject:identifier": `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}`, category: `http://snomed.info/sct|${category}`, }); const res = http.post( `https://${__ENV.HOST}/consumer/DocumentReference/_search`, body, { headers: getHeaders(), } ); checkResponse(res); } export function countPostDocumentReference() { const choice = Math.floor(Math.random() * NHS_NUMBERS.length); const nhsNumber = NHS_NUMBERS[choice]; const body = JSON.stringify({ "subject:identifier": `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}`, }); const res = http.post( `https://${__ENV.HOST}/consumer/DocumentReference/_search?_summary=count`, body, { headers: getHeaders(), } ); checkResponse(res); } NRLF-3.0.31/tests/performance/consumer/soak.js000066400000000000000000000050661511201605300211310ustar00rootroot00000000000000export * from "./client.js"; export const options = { tlsAuth: [ { cert: open(`../../../truststore/client/${__ENV.ENV_TYPE}.crt`), key: open(`../../../truststore/client/${__ENV.ENV_TYPE}.key`), }, ], scenarios: { countDocumentReference: { exec: "countDocumentReference", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, countPostDocumentReference: { exec: "countPostDocumentReference", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, readDocumentReference: { exec: "readDocumentReference", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, searchDocumentReference: { exec: "searchDocumentReference", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, searchDocumentReferenceByCategory: { exec: "searchDocumentReferenceByCategory", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, searchPostDocumentReference: { exec: "searchPostDocumentReference", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, searchPostDocumentReferenceByCategory: { exec: "searchPostDocumentReferenceByCategory", executor: "ramping-arrival-rate", startRate: 0, timeUnit: "1s", preAllocatedVUs: 5, stages: [ { target: 10, duration: "5m" }, { target: 10, duration: "30m" }, { target: 0, duration: "1m" }, ], }, }, }; NRLF-3.0.31/tests/performance/consumer/stress.js000066400000000000000000000036171511201605300215170ustar00rootroot00000000000000export * from "./client.js"; export const options = { tlsAuth: [ { cert: open(`../../../truststore/client/${__ENV.ENV_TYPE}.crt`), key: open(`../../../truststore/client/${__ENV.ENV_TYPE}.key`), }, ], scenarios: { countDocumentReference: { exec: "countDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, countPostDocumentReference: { exec: "countPostDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, readDocumentReference: { exec: "readDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, searchDocumentReference: { exec: "searchDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, searchDocumentReferenceByCategory: { exec: "searchDocumentReferenceByCategory", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, searchPostDocumentReference: { exec: "searchPostDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, searchPostDocumentReferenceByCategory: { exec: "searchPostDocumentReferenceByCategory", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, }, }; NRLF-3.0.31/tests/performance/environment.py000066400000000000000000000106431511201605300207160ustar00rootroot00000000000000# flake8: noqa import json import pathlib from uuid import uuid4 import boto3 import fire from nhs_number import generate from nrlf.core.dynamodb.repository import DocumentPointer from nrlf.core.logger import logger from nrlf.tests.data import load_document_reference from scripts.are_resources_shared_for_stack import uses_shared_resources logger.setLevel("ERROR") DYNAMODB = boto3.resource("dynamodb", region_name="eu-west-2") class LogReference: pass POINTER_TYPES = { "736253002": "Mental Health Crisis Plan", "1363501000000100": "Royal College of Physicians NEWS2 (National Early Warning Score 2) chart", "1382601000000107": "ReSPECT (Recommended Summary Plan for Emergency Care and Treatment) form", "325691000000100": "Contingency plan", "736373009": "End of life care plan", "861421000000109": "End of life care coordination summary", "887701000000100": "Emergency Health Care Plans", "736366004": "Advance Care Plan", "735324008": "Treatment Escalation Plan", "824321000000109": "Summary Record", "2181441000000107": "Personalised Care and Support Plan", "887181000000106": "Clinical summary", } def _generate_record(nhs_number: str, pointer_type: str, ods_code: str): doc_ref = load_document_reference("Y05868-736253002-Valid") pointer_type_description = POINTER_TYPES[pointer_type] doc_ref.id = f"{ods_code}-{uuid4()}" doc_ref.subject.identifier.value = nhs_number # type: ignore doc_ref.type.coding[0].code = pointer_type # type: ignore doc_ref.type.coding[0].display = pointer_type_description # type: ignore return doc_ref def _generate_records(patient_count: int, documents_per_type: int, ods_code: str): for _ in range(patient_count): (nhs_number,) = generate() for pointer_type in POINTER_TYPES.keys(): for _ in range(documents_per_type): yield _generate_record(nhs_number, pointer_type, ods_code) def _get_pointers_table_name(stack_name: str): if uses_shared_resources(stack_name): env = stack_name.split("-")[0] pointers_table_name = f"nhsd-nrlf--{env}-pointers-table" else: pointers_table_name = f"nhsd-nrlf--{stack_name}-pointers-table" return pointers_table_name def setup( stack_name: str, patient_count: int = 100, documents_per_type: int = 10, ods_code: str = "Y05868", out: str = "tests/performance/reference-data.json", output_full_pointers: bool = False, ): pointers_table_name = _get_pointers_table_name(stack_name) print(f"Creating Test Data for stack '{stack_name}' in '{pointers_table_name}'") print(f"Patient Count: {patient_count}") print(f"Documents Per Type: {documents_per_type}") table = DYNAMODB.Table(pointers_table_name) documents = {} nhs_numbers = set() with table.batch_writer() as batch: for record in _generate_records(patient_count, documents_per_type, ods_code): pointer = DocumentPointer.from_document_reference(record) batch.put_item(Item=pointer.model_dump()) documents[pointer.id] = record.model_dump(exclude_none=True) nhs_numbers.add(pointer.nhs_number) print(f"Created {len(documents)} documents for {len(nhs_numbers)} patients") if output_full_pointers: output = json.dumps({"documents": documents, "nhs_numbers": list(nhs_numbers)}) else: output = json.dumps( {"pointer_ids": list(documents.keys()), "nhs_numbers": list(nhs_numbers)} ) output_path = pathlib.Path(out) output_path.write_text(output) print(f"Output written to {output_path}") def cleanup(stack_name: str, input: str = "tests/performance/reference-data.json"): input_path = pathlib.Path(input) data = json.loads(input_path.read_text()) if "documents" in data: pointer_ids = data["documents"].keys() else: pointer_ids = data["pointer_ids"] pointers_table_name = _get_pointers_table_name(stack_name) print( f"Cleaning up {len(pointer_ids)} document pointers for stack '{stack_name}' in '{pointers_table_name}'" ) table = DYNAMODB.Table(pointers_table_name) with table.batch_writer() as batch: for id in pointer_ids: ods_code, document_id = id.split("-", maxsplit=1) pk = f"D#{ods_code}#{document_id}" batch.delete_item(Key={"pk": pk, "sk": pk}) print("Cleanup complete") if __name__ == "__main__": fire.Fire() NRLF-3.0.31/tests/performance/process_results.py000066400000000000000000000265231511201605300216150ustar00rootroot00000000000000# flake8: noqa from csv import DictReader from statistics import mean import fire import matplotlib.pyplot as plt import numpy as np from pydantic import BaseModel class K6OutputRow(BaseModel): metric_name: str timestamp: int metric_value: float scenario: str error: str | None error_code: str | None status: str | None expected_response: str def _load_rows(file_path): with open(file_path, "r") as file: csv_reader = DictReader(file) for row in csv_reader: yield K6OutputRow.model_validate(row) def _load_k6_output(file_path: str): data = {} vus = [] metrics_to_capture = [ "http_reqs", "iterations", "http_req_duration", "http_req_blocked", "http_req_connecting", "http_req_tls_handshaking", "http_req_sending", "http_req_waiting", "http_req_receiving", "checks", ] for row in _load_rows(file_path): if row.metric_name == "vus": vus.append(row) continue if row.metric_name not in metrics_to_capture: continue if row.scenario not in data: data[row.scenario] = {} if row.timestamp not in data[row.scenario]: data[row.scenario][row.timestamp] = {} if row.metric_name not in data[row.scenario][row.timestamp]: data[row.scenario][row.timestamp][row.metric_name] = [] data[row.scenario][row.timestamp][row.metric_name].append(row) return {"scenarios": data, "vus": vus} def _create_response_count_figure(data: dict, title: str): fig = plt.figure(figsize=(15, 10)) fig.suptitle(title) fig_labels = set(["Successful Requests"]) for scenario in data.values(): for metrics in scenario.values(): failures = [ row for row in metrics["http_req_duration"] if row.expected_response == "false" ] for failure in failures: fig_labels.add(f"Failure - Status Code {failure.status}") for index, scenario in enumerate(data.keys()): axes = fig.add_subplot(3, 3, index + 1) scenario_data = data[scenario] timestamps = [] successful_requests = [] failed_requests = [] failure_plots = [] for timestamp, metrics in scenario_data.items(): timestamps.append(timestamp) successes = [ row for row in metrics["http_req_duration"] if row.expected_response == "true" ] failures = [ row for row in metrics["http_req_duration"] if row.expected_response == "false" ] successful_requests.append(len(successes)) if not failures: failed_requests.append(None) continue failure_dict = {} for failure in failures: failure_name = f"Failure - Status Code {failure.status}" if failure_name not in failed_requests: failure_dict[failure_name] = 0 failure_dict[failure_name] += 1 failed_requests.append(failure_dict) first_timestamp = min(timestamps) x = np.array([timestamp - first_timestamp for timestamp in timestamps]) failure_labels = set() for failed_request in filter(lambda x: x is not None, failed_requests): failure_labels.update(failed_request.keys()) failure_plots = [ np.array( [failure.get(label) if failure else 0 for failure in failed_requests] ) for label in failure_labels ] axes.stackplot( x, np.array(successful_requests), *failure_plots, labels=list(fig_labels) ) axes.grid() axes.set_title(scenario) axes.set_xlabel("Time (s)") axes.set_ylabel("Requests per Second") axes.axis("tight") fig.legend(list(fig_labels), loc="upper left") return fig, failure_plots def _create_response_time_figure(data: dict, title: str): fig = plt.figure(figsize=(15, 10)) fig.suptitle(title) for index, scenario in enumerate(data.keys()): axes = fig.add_subplot(3, 3, index + 1) scenario_data = data[scenario] timestamps = [] http_req_blocked = [] http_req_connecting = [] http_req_tls_handshaking = [] http_req_sending = [] http_req_waiting = [] http_req_receiving = [] for timestamp, metrics in scenario_data.items(): timestamps.append(timestamp) http_req_blocked.append( mean([row.metric_value for row in metrics["http_req_blocked"]]) ) http_req_connecting.append( mean([row.metric_value for row in metrics["http_req_connecting"]]) ) http_req_tls_handshaking.append( mean([row.metric_value for row in metrics["http_req_tls_handshaking"]]) ) http_req_sending.append( mean([row.metric_value for row in metrics["http_req_sending"]]) ) http_req_waiting.append( mean([row.metric_value for row in metrics["http_req_waiting"]]) ) http_req_receiving.append( mean([row.metric_value for row in metrics["http_req_receiving"]]) ) first_timestamp = min(timestamps) x = np.array([timestamp - first_timestamp for timestamp in timestamps]) axes.stackplot( x, np.array(http_req_blocked), np.array(http_req_connecting), np.array(http_req_tls_handshaking), np.array(http_req_sending), np.array(http_req_waiting), np.array(http_req_receiving), labels=[ "http_req_blocked", "http_req_connecting", "http_req_tls_handshaking", "http_req_sending", "http_req_waiting", "http_req_receiving", ], ) axes.grid() axes.set_title(scenario) axes.set_xlabel("Time (s)") axes.set_ylabel("Duration (ms)") axes.axis("tight") fig.legend( [ "http_req_blocked", "http_req_connecting", "http_req_tls_handshaking", "http_req_sending", "http_req_waiting", "http_req_receiving", ], loc="upper left", ) return fig def _split_ramp_up_data_by_rps(data, target_rps): # Split into ramp-up and baseline ramp_up_data = {} baseline_data = {} for scenario, scenario_data in data.items(): sorted_timestamps = sorted(scenario_data.keys()) ramp_up_data[scenario] = {} baseline_data[scenario] = {} ramp_up = True for index, timestamp in enumerate(sorted_timestamps): data = scenario_data[timestamp] iterations = data["iterations"] previous_iterations = None if ramp_up is False: baseline_data[scenario][timestamp] = data continue if index > 0: previous_iterations = scenario_data[sorted_timestamps[index - 1]][ "iterations" ] if ( len(iterations) >= target_rps and previous_iterations and len(previous_iterations) >= target_rps ): ramp_up = False baseline_data[scenario][timestamp] = data continue ramp_up_data[scenario][timestamp] = data return ramp_up_data, baseline_data def _split_ramp_up_data_by_vus(data, vus, target_vus): # Split into ramp-up and baseline ramp_up_data = {} baseline_data = {} scenario_count = len(data.keys()) for scenario, scenario_data in data.items(): sorted_timestamps = sorted(scenario_data.keys()) ramp_up_data[scenario] = {} baseline_data[scenario] = {} ramp_end_timestamp = None for vu in vus: if vu.metric_value >= target_vus * scenario_count: ramp_end_timestamp = vu.timestamp break for timestamp in sorted_timestamps: if timestamp >= ramp_end_timestamp: baseline_data[scenario][timestamp] = scenario_data[timestamp] continue ramp_up_data[scenario][timestamp] = scenario_data[timestamp] return ramp_up_data, baseline_data def baseline( file_path: str, target_rps: int = 5, ): output = _load_k6_output(file_path) scenarios = output["scenarios"] ramp_up_data, baseline_data = _split_ramp_up_data_by_rps(scenarios, target_rps) fig = _create_response_time_figure( baseline_data, f"NRL v3.0 Consumer API - Baseline Performance ({target_rps} RPS - Warm Start) - HTTP Response Times (ms)", ) fig.savefig("dist/baseline_performance.png") fig = _create_response_time_figure( ramp_up_data, f"NRL v3.0 Consumer API - Ramp-Up Performance (Up to {target_rps} RPS - Cold Start) - HTTP Response Times (ms)", ) fig.savefig("dist/ramp_up_performance.png") fig, baseline_failures = _create_response_count_figure( baseline_data, f"NRL v3.0 Consumer API - Baseline Performance ({target_rps} RPS - Warm Start) - Response Count", ) fig.savefig("dist/baseline_count.png") fig, ramp_up_failures = _create_response_count_figure( ramp_up_data, f"NRL v3.0 Consumer API - Ramp-Up Performance (Up to {target_rps} RPS - Cold Start) - Response Count", ) fig.savefig("dist/ramp_up_count.png") if len(baseline_failures) > 0 or len(ramp_up_failures) > 0: print( f"Number of Failure Responses: {len(baseline_failures) + len(ramp_up_failures)}" ) exit(1) def stress( file_path: str, target_vus: int = 10, ): data_per_endpoint = _load_k6_output(file_path) scenarios = data_per_endpoint["scenarios"] vus = data_per_endpoint["vus"] ramp_up_data, baseline_data = _split_ramp_up_data_by_vus(scenarios, vus, target_vus) fig = _create_response_time_figure( baseline_data, f"NRL v3.0 Consumer API - Stress Performance ({target_vus} VUs - Warm Start) - HTTP Response Times (ms)", ) fig.savefig("dist/stress_baseline_performance.png") fig = _create_response_time_figure( ramp_up_data, f"NRL v3.0 Consumer API - Stress Performance (Up to {target_vus} VUs - Cold Start) - HTTP Response Times (ms)", ) fig.savefig("dist/stress_ramp_up_performance.png") fig, baseline_failures = _create_response_count_figure( baseline_data, f"NRL v3.0 Consumer API - Stress Performance ({target_vus} VUs - Warm Start) - Response Count", ) fig.savefig("dist/stress_baseline_count.png") fig, ramp_up_failures = _create_response_count_figure( ramp_up_data, f"NRL v3.0 Consumer API - Stress Performance (Up to {target_vus} VUs - Cold Start) - Response Count", ) fig.savefig("dist/stress_ramp_up_count.png") if len(baseline_failures) > 0 or len(ramp_up_failures) > 0: print( f"Number of Failure Responses: {len(baseline_failures) + len(ramp_up_failures)}" ) exit(1) if __name__ == "__main__": fire.Fire() NRLF-3.0.31/tests/performance/producer/000077500000000000000000000000001511201605300176175ustar00rootroot00000000000000NRLF-3.0.31/tests/performance/producer/client.js000066400000000000000000000102631511201605300214350ustar00rootroot00000000000000import http from "k6/http"; import { POINTER_TYPES, ODS_CODE, NHS_NUMBERS, POINTER_IDS, POINTER_DOCUMENTS, POINTERS_TO_DELETE, } from "../constants.js"; import { check } from "k6"; import { randomItem } from "https://jslib.k6.io/k6-utils/1.2.0/index.js"; import { crypto } from "k6/experimental/webcrypto"; import { createRecord } from "../setup.js"; function getBaseURL() { return `https://${__ENV.HOST}/producer/DocumentReference`; } function getHeaders(odsCode = ODS_CODE) { return { "Content-Type": "application/fhir+json", "X-Request-Id": "K6PerformanceTest", "NHSD-Correlation-Id": "K6PerformanceTest", "NHSD-Connection-Metadata": JSON.stringify({ "nrl.ods-code": odsCode, "nrl.pointer-types": POINTER_TYPES.map( (type) => `http://snomed.info/sct|${type}` ), "nrl.app-id": "K6PerformanceTest", }), "NHSD-Client-RP-Details": JSON.stringify({ "developer.app.name": "K6PerformanceTest", "developer.app.id": "K6PerformanceTest", }), }; } function checkResponse(res) { const is_success = check(res, { "status is 200": (r) => r.status === 200 }); if (!is_success) { console.warn(res.json()); } } export function createDocumentReference() { const nhsNumber = randomItem(NHS_NUMBERS); const pointerType = randomItem(POINTER_TYPES); const record = createRecord(nhsNumber, pointerType); const res = http.post(getBaseURL(), JSON.stringify(record), { headers: getHeaders(), }); check(res, { "create status is 201": (r) => r.status === 201 }); if (res.status !== 201) { console.warn( `Failed to create record: ${res.status}: ${ JSON.parse(res.body).issue[0].diagnostics }` ); } } export function readDocumentReference() { const id = randomItem(POINTER_IDS); const res = http.get(`${getBaseURL()}/${id}`, { headers: getHeaders() }); checkResponse(res); } export function updateDocumentReference() { const id = randomItem(POINTER_IDS); const document = POINTER_DOCUMENTS[id]; document.content[0].attachment.url = "https://example.com/k6-updated-url.pdf"; const res = http.put(`${getBaseURL()}/${id}`, JSON.stringify(document), { headers: getHeaders(), }); checkResponse(res); } export function deleteDocumentReference() { const id = randomItem(POINTERS_TO_DELETE); const res = http.del(`${getBaseURL()}/${id}`, null, { headers: getHeaders(), }); checkResponse(res); } export function upsertDocumentReference() { const nhsNumber = randomItem(NHS_NUMBERS); const pointerType = randomItem(POINTER_TYPES); const record = createRecord(nhsNumber, pointerType); record.id = `k6perf-${crypto.randomUUID()}`; const res = http.post(getBaseURL(), JSON.stringify(record), { headers: getHeaders(), }); check(res, { "create status is 201": (r) => r.status === 201 }); if (res.status !== 201) { console.warn( `Failed to create record: ${res.status}: ${ JSON.parse(res.body).issue[0].diagnostics }` ); } } export function searchDocumentReference() { const nhsNumber = randomItem(NHS_NUMBERS); const pointerType = randomItem(POINTER_TYPES); const identifier = encodeURIComponent( `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}` ); const type = encodeURIComponent(`http://snomed.info/sct|${pointerType}`); const url = `${getBaseURL()}?subject:identifier=${identifier}&type=${type}`; const res = http.get(url, { headers: getHeaders(), }); check(res, { "status is 200": (r) => r.status === 200 }); if (res.status !== 200) { console.log( `Search failed with ${res.status}: ${JSON.stringify(res.body)}` ); } } export function searchPostDocumentReference() { const nhsNumber = randomItem(NHS_NUMBERS); const pointerType = randomItem(POINTER_TYPES); const body = JSON.stringify({ "subject:identifier": `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}`, type: `http://snomed.info/sct|${pointerType}`, }); const res = http.post(`${getBaseURL()}/_search`, body, { headers: getHeaders(), }); check(res, { "status is 200": (r) => r.status === 200 }); if (res.status !== 200) { console.log( `Search failed with ${res.status}: ${JSON.stringify(res.body)}` ); } } NRLF-3.0.31/tests/performance/producer/stress.js000066400000000000000000000030501511201605300214760ustar00rootroot00000000000000export * from "./client.js"; /* * NOTE - To run the producer K6 tests, you need to prepare the data by setting * the output_full_pointers flag to true in the environment.py:setup() method. */ export const options = { tlsAuth: [ { cert: open(`../../../truststore/client/${__ENV.ENV_TYPE}.crt`), key: open(`../../../truststore/client/${__ENV.ENV_TYPE}.key`), }, ], scenarios: { createDocumentReference: { exec: "createDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, readDocumentReference: { exec: "readDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, updateDocumentReference: { exec: "updateDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, deleteDocumentReference: { exec: "deleteDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, upsertDocumentReference: { exec: "upsertDocumentReference", executor: "ramping-vus", startVUs: 1, stages: [ { target: 10, duration: "30s" }, { target: 10, duration: "1m" }, ], }, }, }; NRLF-3.0.31/tests/performance/setup.js000066400000000000000000000010201511201605300174630ustar00rootroot00000000000000import { POINTER_TYPES, DEFAULT_TEST_RECORD, ODS_CODE } from "./constants.js"; import { crypto } from "k6/experimental/webcrypto"; export function createRecord(nhsNumber, pointerType) { const record = JSON.parse(DEFAULT_TEST_RECORD); record.id = `${ODS_CODE}-${crypto.randomUUID()}`; record.type.coding[0].code = pointerType; record.type.coding[0].display = POINTER_TYPES[pointerType]; record.subject.identifier.value = nhsNumber; record.context.sourcePatientInfo.identifier.value = nhsNumber; return record; } NRLF-3.0.31/tests/performance/utilities.js000066400000000000000000000007731511201605300203540ustar00rootroot00000000000000export function generateNHSNumber() { const numberWithoutChecksum = Math.floor(Math.random() * 100000000000) .toString() .substring(0, 9); const remainder = numberWithoutChecksum .split("") .map((digit, index) => { return digit * (11 - (index + 1)); }) .reduce((acc, curr) => acc + curr, 0) % 11; const checkDigit = 11 - remainder; if (checkDigit === 11) { return `${numberWithoutChecksum}0`; } return `${numberWithoutChecksum}${checkDigit}`; } NRLF-3.0.31/tests/producer-test-cases.md000066400000000000000000000215051511201605300177140ustar00rootroot00000000000000# Producer guidance: The test cases in this section are **MANDATORY** and demonstrate core functionality of the system. While some implementations may not use some interactions, we do require producers to be able to create, update/supersede and delete pointers. --- ### **TC-P01 - Create happy path / success scenario** | **Step** | **Detailed instructions** | **Evidence required** |**Expected outcome** | |----------|---------------------------|-----------------------|---------------------| | 1 | Authenticate as a valid organisation with a valid access token. | | | | 2 | Construct a new DocumentReference for the request body.
  • Use test patient with NHS number 9876543210
  • Type should reflect whichever type you plan on using in live, as agreed in IAG.
  • All mandatory fields must be populated, and any other fields you plan to use in your live implementation should be populated as you intend to use them.
  • Do not include a relatesTo section.
| Please include a copy of the request body as it was sent in. | Request body is a valid FHIR R4 DocumentReference that adheres to the additional constraints detailed in the API specification, as well as any other constraints mentioned in the compliance checklist. | | 3 | Send as a POST request to the /DocumentReference endpoint, along with headers specified in the API spec.
Audit logs should contain details of the request. | Save an extract or screenshot of the audit logs for this request in the appropriate folder. | Audit logs show:
  • HTTP request body
  • HTTP request URL
  • HTTP verb
  • ODS code of sender
  • NHS number of patient
  • Request date-time
  • Request ID
  • Correlation ID?
| | 4 | Record the unique .id generated for your newly created pointer.
Audit logs should contain details of the response to the request in step 3.
Id: \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ | Save an extract or screenshot of the audit logs for this response in the appropriate folder. | Audit logs show:
  • HTTP response body (an OperationOutcome indicating RESOURCE_CREATED)
  • HTTP response code (201)
  • Response datetime
  • The pointer ID (found in the location header)
  • Correlation ID?
| --- ### **TC-P02 - Read happy path / success scenario** | **Step** | **Detailed instructions** | **Evidence required** |**Expected outcome** | |----------|---------------------------|-----------------------|---------------------| | 1 | Authenticate as a valid organisation with a valid access token. | | | | 2 | Send a GET request for the pointer created in TC-01 using the ID generated and recorded. | Save an extract or screenshot of the audit logs for this request in the appropriate folder. | Audit logs show:
  • HTTP request body
  • HTTP request URL
  • HTTP verb
  • ODS code of sender
  • NHS number of patient
  • Request date-time
  • Request ID
  • Correlation ID?
| | 3 | View the pointer received in the response. | Save an extract or screenshot of the audit logs for this response in the appropriate folder. | Audit logs show:
  • HTTP response body (a DocumentReference)
  • HTTP response code (200)
  • Response datetime
  • The pointer ID (found in the location header)
  • Correlation ID?
| --- ### **TC-P03 - Supersede happy path / success scenario** | **Step** | **Instructions/ Guidance** | **Evidence required** | **Expected outcome** | |----------|----------------------------|-----------------------|----------------------| | 1 | Authenticate as a valid organisation with a valid access token. | | | | 2 | Construct a DocumentReference for the request body that will supersede the pointer created in TC01.
  • Use the same request body as in TC01. NHS number, type and category must match.
  • Populate the relatesTo section with the pointer ID generated in TC01 (found in the location header of the response).
| Please include a copy of the request body as it was sent in. | Request body is a valid FHIR R4 DocumentReference that adheres to the additional constraints detailed in the API specification, as well as any other constraints mentioned in the compliance checklist. | | 3 | Send as a POST request to the /DocumentReference endpoint, along with headers specified in the API spec.
Audit logs should contain details of the request. | Save an extract or screenshot of the audit logs for this request in the appropriate folder. | Audit logs show:
  • HTTP request body
  • HTTP request URL
  • HTTP verb
  • ODS code of sender
  • NHS number of patient
  • Request date-time
  • Request ID
  • Correlation ID?
| | 4 | Record the unique .id generated for your newly created pointer.
Audit logs should contain details of the response to the request in step 3.
Id: \_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_ | Save an extract or screenshot of the audit logs for this response in the appropriate folder. | Audit logs show:
  • HTTP response body (an OperationOutcome indicating RESOURCE_CREATED)
  • HTTP response code (201)
  • Response datetime
  • The pointer ID (found in the location header)
  • Correlation ID?
| --- ### **TC-P04 - Search happy path / success scenario (multiple results)** | **Step** | **Detailed instructions** | **Evidence required** |**Expected outcome** | |----------|---------------------------|-----------------------|---------------------| | 1 | Authenticate as a valid organisation with a valid access token. | | | | 2a OR 2b |
  • Send a GET search request for all pointers using the NHS number.
  • Send a POST search request for all pointers using the NHS number.
| Save an extract or screenshot of the audit logs for this request in the appropriate folder. | Audit logs show:
  • HTTP request body
  • HTTP request URL
  • HTTP verb
  • ODS code of sender
  • NHS number of patient
  • Request date-time
  • Request ID
  • Correlation ID?
| | 3 | View the searchset bundle received in the response.
There should be at least TWO DocumentReferences; the one you created (and superseded) in the previous tests, and another one created by NRLF filled with example data. | Save an extract or screenshot of the audit logs for this response in the appropriate folder. | Audit logs show:
  • HTTP response body (a DocumentReference)
  • HTTP response code (200)
  • Response datetime
  • The pointer ID (found in the location header)
  • Correlation ID?
| --- ### **Unhappy paths** Choose one of the following negative scenarios for each interaction, and provide the evidence suggested. We recognise that if your application is designed to prevent misuse, these could be difficult to recreate using the UI; it may be necessary to make a small temporary change to configuration or send the request in another way. If you cannot complete one of these please reach out to the NRLF team via your organisation’s dedicated Slack channel. The purpose of these tests is to show that your audit logging system properly records even failed attempts and error responses, in accordance with SAR requirements. **“Create” / “Update” / “Supersede” example error scenarios:** - Message body is not FHIR-compliant (expected response: 400) - Message body does not meet the NRL business logic profile (expected response: 400 or 422), e.g. - A mandatory field such as ‘context.practiceSetting’, ‘author’, or ‘category’ is missing. - A mandatory field has an invalid value, e.g. an ’author’ with an invalid system identifier (i.e. not https://fhir.nhs.uk/Id/ods-organization-code) - The category does not match the type (e.g. a Mental Health Crisis Plan is submitted in the ‘Observations’ category instead of ‘Care plan’) or uses the wrong system (i.e. not SNOMED) - The display value on a mandatory codeable concept does not match the expected text in the ValueSet (e.g. SNOMED code 736253002, but display is ‘Radiology report’ instead of ‘Mental health crisis plan’) - Missing a mandatory header - Marking the ‘type’ of a pointer as one for which your organisation has not been granted permissions. **“Read” example error scenarios:** - Missing or incorrect mandatory header - The pointer is a type for which your organisation does not have access - The pointer was created by a different organisation **“Delete” example error scenarios:** - Missing or incorrect mandatory headers - The pointer is created by a different organisation Please indicate which case you have chosen and provide the following: - Request body - Audit logs - Response body NRLF-3.0.31/tests/smoke/000077500000000000000000000000001511201605300146115ustar00rootroot00000000000000NRLF-3.0.31/tests/smoke/conftest.py000066400000000000000000000033331511201605300170120ustar00rootroot00000000000000import json import boto3 import pytest from scripts.aws_session_assume import get_boto_session from tests.smoke.environment import EnvironmentConfig, SmokeTestParameters from tests.utilities.api_clients import ConsumerTestClient, ProducerTestClient @pytest.fixture(autouse=True, scope="session") def environment_config(): return EnvironmentConfig() @pytest.fixture(scope="session") def boto_session(environment_config: EnvironmentConfig) -> boto3.Session: return get_boto_session(environment_config.env_name) @pytest.fixture(autouse=True, scope="session") def smoke_test_parameters( environment_config: EnvironmentConfig, boto_session: boto3.Session ) -> SmokeTestParameters: parameters_name = environment_config.get_parameters_name() secretsmanager = boto_session.client("secretsmanager", region_name="eu-west-2") secret_value = secretsmanager.get_secret_value(SecretId=parameters_name) parameters = json.loads(secret_value["SecretString"]) return SmokeTestParameters(parameters) @pytest.fixture(autouse=True, scope="session") def producer_client( environment_config: EnvironmentConfig, smoke_test_parameters: SmokeTestParameters ) -> ProducerTestClient: return ProducerTestClient( config=environment_config.to_client_config(smoke_test_parameters) ) @pytest.fixture(autouse=True, scope="session") def consumer_client( environment_config: EnvironmentConfig, smoke_test_parameters: SmokeTestParameters ) -> ConsumerTestClient: return ConsumerTestClient( config=environment_config.to_client_config(smoke_test_parameters) ) @pytest.fixture def test_nhs_numbers(smoke_test_parameters: SmokeTestParameters) -> list[str]: return smoke_test_parameters.test_nhs_numbers NRLF-3.0.31/tests/smoke/environment.py000066400000000000000000000064701511201605300175360ustar00rootroot00000000000000import os import uuid from enum import Enum from scripts.aws_session_assume import get_account_name from tests.utilities.api_clients import ClientConfig, ConnectionMetadata from tests.utilities.get_access_token import get_bearer_token class SmokeTestParameters: def __init__(self, parameters: dict[str, str]): self.public_base_url = parameters.get("public_base_url") self.apigee_app_id = parameters.get("apigee_app_id") self.apigee_app_name = parameters.get("apigee_app_name") self.nrlf_app_id = parameters.get("nrlf_app_id") self.ods_code = parameters.get("ods_code") self.test_nhs_numbers = parameters.get("test_nhs_numbers").split(",") class ConnectMode(Enum): # INTERNAL connect mode is for connecting to NRLF via internal access methods INTERNAL = "internal" # Public connect mode is for connecting to NRLF via public access methods PUBLIC = "public" class EnvironmentConfig: def __init__(self): self.env_name = os.getenv("TEST_ENVIRONMENT_NAME") self.stack_name = os.getenv("TEST_STACK_NAME", None) self.connect_mode = os.getenv("TEST_CONNECT_MODE") domain_name = os.getenv("TEST_STACK_DOMAIN") self.internal_base_url = f"https://{domain_name}/" def get_parameters_name(self): return f"nhsd-nrlf--{self.env_name}--smoke-test-parameters" def to_client_config(self, parameters: SmokeTestParameters): connection_metadata = ConnectionMetadata.model_validate( { "nrl.ods-code": parameters.ods_code, "nrl.permissions": [], "nrl.app-id": parameters.nrlf_app_id, "client_rp_details": { "developer.app.name": parameters.apigee_app_name, "developer.app.id": parameters.apigee_app_id, }, } ) smoketest_id = str(uuid.uuid4()) env_resources_name = self.env_name.split("-")[0] if self.connect_mode == ConnectMode.INTERNAL.value: return ClientConfig( base_url=self.internal_base_url, custom_headers={ "X-Request-Id": smoketest_id, "NHSD-Correlation-Id": f"{smoketest_id}.smoketest.{self.stack_name}.{self.env_name}", }, connection_metadata=connection_metadata, client_cert=( f"./truststore/client/{env_resources_name}.crt", f"./truststore/client/{env_resources_name}.key", ), ) elif self.connect_mode == ConnectMode.PUBLIC.value: auth_token = "TestToken" if not self.env_name.endswith("-sandbox"): account_name = get_account_name(env_resources_name) auth_token = get_bearer_token( account_name, parameters.apigee_app_id, env_resources_name ) return ClientConfig( base_url=parameters.public_base_url, custom_headers={ "X-Request-Id": smoketest_id, "NHSD-End-User-Organisation-ODS": parameters.ods_code, }, auth_token=auth_token, api_path="/FHIR/R4", ) raise ValueError(f"Invalid connect mode: {self.connect_mode}") NRLF-3.0.31/tests/smoke/permissions/000077500000000000000000000000001511201605300171645ustar00rootroot00000000000000NRLF-3.0.31/tests/smoke/permissions/SMOKETEST.json000066400000000000000000000000451511201605300214340ustar00rootroot00000000000000["http://snomed.info/sct|736253002"] NRLF-3.0.31/tests/smoke/scenarios/000077500000000000000000000000001511201605300165775ustar00rootroot00000000000000NRLF-3.0.31/tests/smoke/scenarios/1dsync_upsert_delete.py000066400000000000000000000040561511201605300233030ustar00rootroot00000000000000import pytest from nrlf.core.constants import PERMISSION_ALLOW_ALL_POINTER_TYPES from tests.smoke.environment import ConnectMode, EnvironmentConfig, SmokeTestParameters from tests.smoke.setup import build_document_reference from tests.utilities.api_clients import ProducerTestClient @pytest.fixture def producer_client_1dsync( environment_config: EnvironmentConfig, smoke_test_parameters: SmokeTestParameters ) -> ProducerTestClient: client_config = environment_config.to_client_config(smoke_test_parameters) if environment_config.connect_mode == ConnectMode.INTERNAL: client_config.connection_metadata["nrl.permissions"] = [ PERMISSION_ALLOW_ALL_POINTER_TYPES ] client_config.connection_metadata["nrl.app-id"] = "SMOKETEST_1DSYNC" return ProducerTestClient(config=client_config) def test_1dsync_upsert_delete( producer_client_1dsync: ProducerTestClient, smoke_test_parameters: SmokeTestParameters, test_nhs_numbers: list[str], ): """ Smoke test scenario for 1dsync upsert and delete behaviour """ test_ods_code = smoke_test_parameters.ods_code test_docref = build_document_reference( nhs_number=test_nhs_numbers[0], custodian=test_ods_code ) for attempts in range(0, 5): try: test_docref.id = ( f"{test_ods_code}-smoketest_1dsync_upsert_delete_pointer_{attempts}" ) upsert_response = producer_client_1dsync.upsert( test_docref.model_dump(exclude_none=True) ) assert upsert_response.ok assert upsert_response.headers["Location"].split("/")[-1] == test_docref.id finally: delete_response = producer_client_1dsync.delete(test_docref.id) assert ( delete_response.ok ), f"Failed to delete document reference with ID: {test_docref.id}. It will need to be deleted manually if it still exists." read_response = producer_client_1dsync.read(test_docref.id) assert read_response.status_code == 404 NRLF-3.0.31/tests/smoke/scenarios/api_capability_statement_lookup.py000066400000000000000000000007251511201605300256040ustar00rootroot00000000000000from tests.utilities.api_clients import ConsumerTestClient, ProducerTestClient def test_read_api_capability_statements( consumer_client: ConsumerTestClient, producer_client: ProducerTestClient ): """ Smoke test scenario for reading the API capability statements """ read_response = consumer_client.read_capability_statement() assert read_response.ok read_response = producer_client.read_capability_statement() assert read_response.ok NRLF-3.0.31/tests/smoke/scenarios/consumer_search_read.py000066400000000000000000000036631511201605300233340ustar00rootroot00000000000000from typing import Any, Generator import pytest from tests.smoke.environment import SmokeTestParameters from tests.smoke.setup import build_document_reference, upsert_test_pointer from tests.utilities.api_clients import ConsumerTestClient, ProducerTestClient @pytest.fixture def test_data( test_nhs_numbers: list[str], producer_client: ProducerTestClient, smoke_test_parameters: SmokeTestParameters, ) -> Generator[str, Any, None]: test_ods_code = smoke_test_parameters.ods_code test_pointers = [ upsert_test_pointer( f"{test_ods_code}-smoketest_consumer_search_read_pointer_{n}", docref=build_document_reference( nhs_number=test_nhs_numbers[0], custodian=test_ods_code ), producer_client=producer_client, ) for n in range(0, 5) ] test_data = { "patient_nhs_number": test_nhs_numbers[0], "pointers": test_pointers, } yield test_data for test_pointer in test_pointers: producer_client.delete(test_pointer.id) def test_consumer_search_read(consumer_client: ConsumerTestClient, test_data: dict): """ Smoke test scenario for a consumer search and read behaviour """ patient_id = test_data["patient_nhs_number"] test_pointers = test_data["pointers"] # Search search_response = consumer_client.search(patient_id) assert search_response.ok assert search_response.json()["total"] >= len(test_pointers) # Search with POST search_response = consumer_client.search_post(patient_id) assert search_response.ok assert search_response.json()["total"] >= len(test_pointers) # Read read_response = consumer_client.read(test_pointers[0].id) assert read_response.ok assert read_response.json()["id"] == test_pointers[0].id assert read_response.json()["subject"]["identifier"]["value"] == patient_id assert read_response.json()["status"] == "current" NRLF-3.0.31/tests/smoke/scenarios/producer_crud.py000066400000000000000000000033771511201605300220230ustar00rootroot00000000000000from tests.smoke.environment import SmokeTestParameters from tests.smoke.setup import build_document_reference from tests.utilities.api_clients import ProducerTestClient def test_producer_crud( producer_client: ProducerTestClient, smoke_test_parameters: SmokeTestParameters, test_nhs_numbers: list[str], ): """ Smoke test scenario for producer CRUD behaviour """ test_ods_code = smoke_test_parameters.ods_code test_docref = build_document_reference( nhs_number=test_nhs_numbers[0], custodian=test_ods_code ) try: # Create create_response = producer_client.create( test_docref.model_dump(exclude_none=True) ) assert create_response.ok created_id = create_response.headers["Location"].split("/")[-1] # Read read_response = producer_client.read(created_id) assert read_response.ok assert read_response.json()["id"] == created_id # Update updated_docref = { **test_docref.model_dump(exclude_none=True), "id": created_id, } updated_docref["content"][0]["attachment"][ "url" ] = "https://testing.record-locator.national.nhs.uk/_smoke_test_pointer_content_updated" update_response = producer_client.update(updated_docref, created_id) assert update_response.ok finally: # Delete delete_response = producer_client.delete(created_id) assert ( delete_response.ok ), f"Failed to delete document reference with ID: {created_id}. It will need to be deleted manually if it still exists." # Read again, expect a 404 read_response = producer_client.read(created_id) assert read_response.status_code == 404 NRLF-3.0.31/tests/smoke/scenarios/producer_search_read.py000066400000000000000000000036451511201605300233240ustar00rootroot00000000000000from typing import Any, Generator import pytest from tests.smoke.environment import SmokeTestParameters from tests.smoke.setup import build_document_reference, upsert_test_pointer from tests.utilities.api_clients import ProducerTestClient @pytest.fixture def test_data( test_nhs_numbers: list[str], producer_client: ProducerTestClient, smoke_test_parameters: SmokeTestParameters, ) -> Generator[str, Any, None]: test_ods_code = smoke_test_parameters.ods_code test_pointers = [ upsert_test_pointer( f"{test_ods_code}-smoketest_producer_count_search_read_pointer_{n}", docref=build_document_reference( nhs_number=test_nhs_numbers[0], custodian=test_ods_code ), producer_client=producer_client, ) for n in range(0, 5) ] test_data = { "patient_nhs_number": test_nhs_numbers[0], "pointers": test_pointers, } yield test_data for test_pointer in test_pointers: producer_client.delete(test_pointer.id) def test_producer_search_read(producer_client: ProducerTestClient, test_data: dict): """ Smoke test scenario for a producer search and read behaviour """ patient_id = test_data["patient_nhs_number"] test_pointers = test_data["pointers"] # Search search_response = producer_client.search(patient_id) assert search_response.ok assert search_response.json()["total"] == len(test_pointers) # Search with POST search_response = producer_client.search_post(patient_id) assert search_response.ok assert search_response.json()["total"] == len(test_pointers) # Read read_response = producer_client.read(test_pointers[0].id) assert read_response.ok assert read_response.json()["id"] == test_pointers[0].id assert read_response.json()["subject"]["identifier"]["value"] == patient_id assert read_response.json()["status"] == "current" NRLF-3.0.31/tests/smoke/setup.py000066400000000000000000000112331511201605300163230ustar00rootroot00000000000000from nrlf.core.constants import ( CONTENT_FORMAT_CODE_URL, CONTENT_STABILITY_EXTENSION_URL, CONTENT_STABILITY_SYSTEM_URL, TYPE_ATTRIBUTES, Categories, PointerTypes, ) from nrlf.producer.fhir.r4.model import ( Attachment, ContentStabilityExtension, ContentStabilityExtensionCoding, ContentStabilityExtensionValueCodeableConcept, DocumentReference, DocumentReferenceContent, DocumentReferenceContext, DocumentReferenceRelatesTo, Identifier, NRLCodeableConcept, NRLCoding, NRLFormatCode, Reference, ) from tests.utilities.api_clients import ProducerTestClient def build_document_reference( nhs_number: str, custodian: str = "SMOKETEST", status: str = "current", category: str = Categories.CARE_PLAN.coding_value(), type: str = PointerTypes.MENTAL_HEALTH_PLAN.coding_value(), author: str = "SMOKETEST", content_type: str = "application/pdf", content_url: str = "https://testing.record-locator.national.nhs.uk/_smoke_test_pointer_content", replaces_id: str | None = None, ) -> DocumentReference: docref = DocumentReference( resourceType="DocumentReference", status=status, content=[ DocumentReferenceContent( attachment=Attachment( contentType=content_type, url=content_url, ), format=NRLFormatCode( system=CONTENT_FORMAT_CODE_URL, code="urn:nhs-ic:unstructured", display="Unstructured Document", ), extension=[ ContentStabilityExtension( url=CONTENT_STABILITY_EXTENSION_URL, valueCodeableConcept=ContentStabilityExtensionValueCodeableConcept( coding=[ ContentStabilityExtensionCoding( system=CONTENT_STABILITY_SYSTEM_URL, code="static", display="Static", ) ] ), ) ], ) ], type=NRLCodeableConcept( coding=[ NRLCoding( system="http://snomed.info/sct", code=type, display=TYPE_ATTRIBUTES.get(f"http://snomed.info/sct|{type}").get( "display" ), ) ] ), subject=Reference( identifier=Identifier( system="https://fhir.nhs.uk/Id/nhs-number", value=nhs_number ) ), custodian=Reference( identifier=Identifier( system="https://fhir.nhs.uk/Id/ods-organization-code", value=custodian ) ), author=[ Reference( identifier=Identifier( system="https://fhir.nhs.uk/Id/ods-organization-code", value=author ) ) ], category=[ NRLCodeableConcept( coding=[ NRLCoding( system="http://snomed.info/sct", code=category, display=( "Care plan" if category == "734163000" else "Observations" ), ) ] ) ], context=DocumentReferenceContext( practiceSetting=NRLCodeableConcept( coding=[ NRLCoding( system="http://snomed.info/sct", code="224891009", display="Healthcare services", ) ] ) ), ) if replaces_id: docref.relatesTo = [ DocumentReferenceRelatesTo( code="replaces", target=Reference( type="DocumentReference", identifier=Identifier( system="https://fhir.nhs.uk/Id/", value=replaces_id, ), ), ) ] return docref def upsert_test_pointer( id: str, docref: DocumentReference, producer_client: ProducerTestClient ) -> DocumentReference: docref.id = id create_response = producer_client.upsert(docref.model_dump(exclude_none=True)) if not create_response.ok: raise ValueError(f"Failed to create test pointer: {create_response.text}") return docref NRLF-3.0.31/tests/utilities/000077500000000000000000000000001511201605300155065ustar00rootroot00000000000000NRLF-3.0.31/tests/utilities/api_clients.py000066400000000000000000000274251511201605300203640ustar00rootroot00000000000000import json import logging from typing import Any, Callable import requests from pydantic import BaseModel from requests import Response from nrlf.core.constants import Categories, PointerTypes from nrlf.core.model import ConnectionMetadata logger = logging.getLogger(__name__) class ClientConfig(BaseModel): base_url: str auth_token: str = "TestToken" api_path: str = "" client_cert: tuple[str, str] | None = None connection_metadata: ConnectionMetadata | None = None custom_headers: dict[str, str] | None = {} class SearchQuery: nhs_number: str = "UNSET" custodian: str | None = None pointer_type: PointerTypes | None = None def add_nhs_number(self, nhs_number: str): self.nhs_number = nhs_number return self def add_custodian(self, custodian: str): self.custodian = custodian return self def add_pointer_type(self, pointer_type: PointerTypes): self.pointer_type = pointer_type return self def retry_if(status_codes: list[int]) -> Callable[..., Any]: """ Decorator to retry a function call if it returns certain errors """ def wrapped_func(func: Callable[..., Response]) -> Callable[..., Response]: def wrapper(*args: Any, **kwargs: Any) -> Any: attempt_responses: list[Response] = [] for attempt in range(3): response = func(*args, **kwargs) if not response.status_code or response.status_code not in status_codes: return response attempt_responses.append(response) logger.warning( f"Attempt {attempt + 1} failed with status code {response.status_code}" ) logger.error(f"All attempts failed with responses: {attempt_responses}") raise RuntimeError( f"Function failed after retries with responses: {attempt_responses}" ) return wrapper return wrapped_func class ConsumerTestClient: def __init__(self, config: ClientConfig): self.config = config self.api_url = f"{self.config.base_url}consumer{self.config.api_path}" self.request_headers = { "Authorization": f"Bearer {self.config.auth_token}", "X-Request-Id": "test-request-id", } if self.config.client_cert: connection_metadata = self.config.connection_metadata.model_dump( by_alias=True ) client_rp_details = connection_metadata.pop("client_rp_details") self.request_headers.update( { "NHSD-Connection-Metadata": json.dumps(connection_metadata), "NHSD-Client-RP-Details": json.dumps(client_rp_details), "NHSD-Correlation-Id": "test-correlation-id", } ) self.request_headers.update(self.config.custom_headers) @retry_if([502]) def read(self, doc_ref_id: str) -> Response: return requests.get( f"{self.api_url}/DocumentReference/{doc_ref_id}", headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def search( self, nhs_number: str | None = None, custodian: str | None = None, pointer_type: PointerTypes | None = None, category: Categories | None = None, extra_params: dict[str, str] | None = None, ) -> Response: params = {**(extra_params or {})} if nhs_number: params["subject:identifier"] = ( "https://fhir.nhs.uk/Id/nhs-number|" + nhs_number ) if custodian: params["custodian:identifier"] = ( "https://fhir.nhs.uk/Id/ods-organization-code|" + custodian ) if pointer_type: if "|" in pointer_type: params["type"] = pointer_type else: params["type"] = f"http://snomed.info/sct|{pointer_type}" if category: if "|" in category: params["category"] = category else: params["category"] = f"http://snomed.info/sct|{category}" return requests.get( f"{self.api_url}/DocumentReference", params=params, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def search_post( self, nhs_number: str | None = None, custodian: str | None = None, pointer_type: PointerTypes | None = None, category: Categories | None = None, extra_fields: dict[str, str] | None = None, ) -> Response: body = {**(extra_fields or {})} if nhs_number: body["subject:identifier"] = ( "https://fhir.nhs.uk/Id/nhs-number|" + nhs_number ) if custodian: body["custodian:identifier"] = ( "https://fhir.nhs.uk/Id/ods-organization-code|" + custodian ) if pointer_type: if "|" in pointer_type: body["type"] = pointer_type else: body["type"] = f"http://snomed.info/sct|{pointer_type}" if category: if "|" in category: body["category"] = category else: body["category"] = f"http://snomed.info/sct|{category}" return requests.post( f"{self.api_url}/DocumentReference/_search", json=body, headers={ "Content-Type": "application/json", **self.request_headers, }, cert=self.config.client_cert, ) @retry_if([502]) def head( self, endpoint: str, headers: dict[str, str] | None = None, extra_params: dict[str, str] | None = None, ) -> Response: headers = {**(headers or {}), **self.request_headers} params = {**(extra_params or {})} url = f"{self.api_url}/{endpoint}" return requests.head( url, params=params, headers=headers, cert=self.config.client_cert, ) @retry_if([502]) def read_capability_statement(self) -> Response: return requests.get( f"{self.api_url}/metadata", headers=self.request_headers, cert=self.config.client_cert, ) class ProducerTestClient: def __init__(self, config: ClientConfig): self.config = config self.api_url = f"{self.config.base_url}producer{self.config.api_path}" self.request_headers = { "Authorization": f"Bearer {self.config.auth_token}", "X-Request-Id": "test-request-id", } if self.config.client_cert: connection_metadata = self.config.connection_metadata.model_dump( by_alias=True ) client_rp_details = connection_metadata.pop("client_rp_details") self.request_headers.update( { "NHSD-Connection-Metadata": json.dumps(connection_metadata), "NHSD-Client-RP-Details": json.dumps(client_rp_details), "NHSD-Correlation-Id": "test-correlation-id", } ) self.request_headers.update(self.config.custom_headers) @retry_if([502]) def create(self, doc_ref) -> Response: return requests.post( f"{self.api_url}/DocumentReference", json=doc_ref, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def create_text(self, doc_ref) -> Response: return requests.post( f"{self.api_url}/DocumentReference", data=doc_ref, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def upsert(self, doc_ref) -> Response: return requests.put( f"{self.api_url}/DocumentReference", json=doc_ref, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def upsert_text(self, doc_ref) -> Response: return requests.put( f"{self.api_url}/DocumentReference", data=doc_ref, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def update(self, doc_ref, doc_ref_id: str) -> Response: return requests.put( f"{self.api_url}/DocumentReference/{doc_ref_id}", json=doc_ref, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def update_text(self, doc_ref, doc_ref_id: str) -> Response: return requests.put( f"{self.api_url}/DocumentReference/{doc_ref_id}", data=doc_ref, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def delete(self, doc_ref_id: str) -> Response: return requests.delete( f"{self.api_url}/DocumentReference/{doc_ref_id}", headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def read(self, doc_ref_id: str) -> Response: return requests.get( f"{self.api_url}/DocumentReference/{doc_ref_id}", headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def search( self, nhs_number: str | None = None, pointer_type: PointerTypes | None = None, extra_params: dict[str, str] | None = None, ) -> Response: params = {**(extra_params or {})} if nhs_number: params["subject:identifier"] = ( "https://fhir.nhs.uk/Id/nhs-number|" + nhs_number ) if pointer_type: if "|" in pointer_type: params["type"] = pointer_type else: params["type"] = f"http://snomed.info/sct|{pointer_type}" return requests.get( f"{self.api_url}/DocumentReference", params=params, headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def search_post( self, nhs_number: str | None = None, pointer_type: PointerTypes | None = None, extra_fields: dict[str, str] | None = None, ) -> Response: body = {**(extra_fields or {})} if nhs_number: body["subject:identifier"] = ( "https://fhir.nhs.uk/Id/nhs-number|" + nhs_number ) if pointer_type: if "|" in pointer_type: body["type"] = pointer_type else: body["type"] = f"http://snomed.info/sct|{pointer_type}" return requests.post( f"{self.api_url}/DocumentReference/_search", json=body, headers={ "Content-Type": "application/json", **self.request_headers, }, cert=self.config.client_cert, ) @retry_if([502]) def read_capability_statement(self) -> Response: return requests.get( f"{self.api_url}/metadata", headers=self.request_headers, cert=self.config.client_cert, ) @retry_if([502]) def head( self, endpoint: str, headers: dict[str, str] | None = None, extra_params: dict[str, str] | None = None, ) -> Response: headers = {**(headers or {}), **self.request_headers} params = {**(extra_params or {})} url = f"{self.api_url}/{endpoint}" return requests.head( url, params=params, headers=headers, cert=self.config.client_cert, ) NRLF-3.0.31/tests/utilities/get_access_token.py000066400000000000000000000112341511201605300213610ustar00rootroot00000000000000import base64 import json from time import time from typing import Literal from uuid import uuid4 import boto3 import fire import jwt import requests _DEFAULT_APP_DEV = "4e41d2d9-3ef6-48dc-8406-5faba77ffd83" _DEFAULT_APP_PROD = "7a4ad8c7-3927-4259-af7b-ac9d305a86ad" _DEFAULT_APP_FOR_APIGEE_ENV = { "internal-dev": _DEFAULT_APP_DEV, "internal-dev-sandbox": _DEFAULT_APP_DEV, "internal-qa": _DEFAULT_APP_DEV, "internal-qa-sandbox": _DEFAULT_APP_DEV, "ref": _DEFAULT_APP_DEV, "int": _DEFAULT_APP_PROD, "int-sandbox": _DEFAULT_APP_PROD, "prod": _DEFAULT_APP_PROD, } _NRL_SYNC_APP_DEV = "94492ef7-40a5-47bb-a18b-b9023bd4ec9a" _NRL_SYNC_APP_PROD = "f9822096-11ec-479f-8d95-fcc8dd22048d" _NRL_SYNC_APP_FOR_APIGEE_ENV = { "internal-dev": _NRL_SYNC_APP_DEV, "internal-qa": _NRL_SYNC_APP_DEV, "ref": _NRL_SYNC_APP_DEV, "int": _NRL_SYNC_APP_PROD, "prod": _NRL_SYNC_APP_PROD, } AWS_ACCOUNT_FOR_ENV = { "dev": "dev", "qa": "test", "ref": "test", "int": "test", "perftest": "test", "prod": "prod", } APIGEE_ENV_FOR_ENV = { "dev": "internal-dev", "dev-sandbox": "internal-dev-sandbox", "qa": "internal-qa", "qa-sandbox": "internal-qa-sandbox", "ref": "ref", "int": "int", "int-sandbox": "sandbox", "perftest": "internal-qa", # NRL-1802: Hijacking qa to not create a new APIGEE proxy environment. "prod": "prod", } APP_FOR_ALIAS = { "default": _DEFAULT_APP_FOR_APIGEE_ENV, "nrl_sync": _NRL_SYNC_APP_FOR_APIGEE_ENV, } def get_app_details(env: str, app_alias: str): if env not in AWS_ACCOUNT_FOR_ENV: raise ValueError(f"Invalid environment: {env}") account_name = AWS_ACCOUNT_FOR_ENV[env] apigee_env = APIGEE_ENV_FOR_ENV[env] app_id = APP_FOR_ALIAS[app_alias][apigee_env] return account_name, app_id def get_target_account_id(account: str): secretsmanager = boto3.client("secretsmanager", region_name="eu-west-2") secret_id = f"nhsd-nrlf--mgmt--{account}-account-id" result = secretsmanager.get_secret_value(SecretId=secret_id) return result["SecretString"] def get_boto_session_for_account(account_id: str): sts = boto3.client("sts", region_name="eu-west-2") result = sts.assume_role( RoleArn=f"arn:aws:iam::{account_id}:role/terraform", RoleSessionName="get-account-id", DurationSeconds=900, ) credentials = result["Credentials"] return boto3.Session( aws_access_key_id=credentials["AccessKeyId"], aws_secret_access_key=credentials["SecretAccessKey"], aws_session_token=credentials["SessionToken"], ) def get_app_secrets(account_name: str, env: str, app_id: str): account_id = get_target_account_id(account_name) session = get_boto_session_for_account(account_id) secretsmanager = session.client("secretsmanager", region_name="eu-west-2") secret_id = f"nhsd-nrlf--{account_name}--{env}--apigee-app-token-info--{app_id}" result = secretsmanager.get_secret_value(SecretId=secret_id) secret = json.loads(result["SecretString"]) secret["private_key"] = base64.b64decode(secret["private_key"]) return secret def generate_client_assertion(app_secrets: dict): return jwt.encode( { "iss": app_secrets["api_key"], "sub": app_secrets["api_key"], "aud": app_secrets["oauth_url"], "jti": str(uuid4()), "exp": time() + 300, }, app_secrets["private_key"], algorithm="RS512", headers={"kid": app_secrets["kid"]}, ) def make_token_request(app_secrets: dict, token: str): response = requests.post( url=app_secrets["oauth_url"], headers={ "Content-Type": "application/x-www-form-urlencoded", }, data={ "grant_type": "client_credentials", "client_assertion_type": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer", "client_assertion": token, }, ) return response.json() def get_bearer_token(account_name: str, app_id: str, env: str): app_secrets = get_app_secrets(account_name, env, app_id) jwt_token = generate_client_assertion(app_secrets) response = make_token_request(app_secrets, jwt_token) access_token = response["access_token"] return access_token def main(env: str, app_alias: Literal["default", "nrl_sync"] = "default"): account_name, app_id = get_app_details(env, app_alias) print( # noqa: T201 f"Requesting access token for {env} environment (App ID '{app_id}')" ) access_token = get_bearer_token(account_name, app_id, env) print(f"Access Token: {access_token}") # noqa: T201 if __name__ == "__main__": fire.Fire(main) NRLF-3.0.31/truststore/000077500000000000000000000000001511201605300145675ustar00rootroot00000000000000NRLF-3.0.31/truststore/ca/000077500000000000000000000000001511201605300151525ustar00rootroot00000000000000NRLF-3.0.31/truststore/ca/.gitkeep000066400000000000000000000000001511201605300165710ustar00rootroot00000000000000NRLF-3.0.31/truststore/client/000077500000000000000000000000001511201605300160455ustar00rootroot00000000000000NRLF-3.0.31/truststore/client/.gitkeep000066400000000000000000000000001511201605300174640ustar00rootroot00000000000000NRLF-3.0.31/truststore/config/000077500000000000000000000000001511201605300160345ustar00rootroot00000000000000NRLF-3.0.31/truststore/config/ca.conf000066400000000000000000000014421511201605300172670ustar00rootroot00000000000000FQDN = ${fqdn} [req] default_bits = 4096 distinguished_name = req_distinguished_name req_extensions = v3_req x509_extensions = v3_ca prompt = no [req_distinguished_name] C = GB ST = West Yorkshire L = Leeds O = NHS Digital OU = DDC CN = ${fqdn} # https://superuser.com/questions/738612/openssl-ca-keyusage-extension # https://access.redhat.com/solutions/28965 [ v3_ca ] basicConstraints = critical, CA:TRUE subjectKeyIdentifier = hash authorityKeyIdentifier = keyid:always, issuer:always keyUsage = critical, cRLSign, digitalSignature, keyCertSign [ crl_ext ] issuerAltName = issuer:copy authorityKeyIdentifier = keyid:always, issuer:always [ v3_req ] basicConstraints = critical, CA:FALSE subjectKeyIdentifier = hash NRLF-3.0.31/truststore/config/client.conf000066400000000000000000000013711511201605300201630ustar00rootroot00000000000000FQDN = ${fqdn} [req] default_bits = 4096 distinguished_name = req_distinguished_name req_extensions = v3_req x509_extensions = usr_cert prompt = no [req_distinguished_name] C = GB ST = West Yorkshire L = Leeds O = NHS Digital OU = DDC CN = ${fqdn} # https://superuser.com/questions/738612/openssl-ca-keyusage-extension # https://access.redhat.com/solutions/28965 [ v3_req ] keyUsage = critical, nonRepudiation, digitalSignature, keyEncipherment extendedKeyUsage = critical, clientAuth [ usr_cert ] basicConstraints = critical, CA:FALSE nsCertType = client keyUsage = critical, nonRepudiation, digitalSignature, keyEncipherment extendedKeyUsage = critical, clientAuth, codeSigning subjectKeyIdentifier = hash NRLF-3.0.31/truststore/server/000077500000000000000000000000001511201605300160755ustar00rootroot00000000000000NRLF-3.0.31/truststore/server/.gitkeep000066400000000000000000000000001511201605300175140ustar00rootroot00000000000000