Add memo to OperationOutcome

[pat-johnson-dev]

Add a memo or note field to the beginning of the OperationOutcome responses where the OperationOutcome is not valid.

The text should read as follows:

Having Issues?

Please review resources below which should lead you to help you need in different circumstances.

General Issues

• Tech by Design's Get Help page
• FAQ Section

Tech by Design Hub Issues

• Tech by Design's Hub page
• Tech by Design Hub Status
• Tech by Deisgn Hub Docs

FHIR Implementation Guide or Validation Rules Questions

• FHIR IG documentation
• If your issue cannot be resolved, you should create a ticket in the NYeC Data Lake Jira system for further assistance surrounding the Implementation Guide.

NYeC API Gateway and/or Data Lake Issues

• If you've utilized the Tech by Design Hub and recognize errors in forwarding to the data lake, please create a ticket in the NYeC Data Lake Jira system for further assistance with non-Implementation Guide related issues.

[pat-johnson-dev]

@shah curious if you think this is too long-winded for the OperationOutcome? It is the same info found in our Issue template, here.

[Shreeja-dev]

We spoke with @shah and he suggested the following:

{
  "OperationOutcome": {
    "help": "If you need help understanding how to decipher OperationOutcome please see https://github.com/tech-by-design/help-desk-non-phi/discussions/51.",
    "validationResults": [
      {

We have created a discussion item at https://github.com/tech-by-design/help-desk-non-phi/discussions/51 which will contain extensive documentation of the OperationOutcome including links for further debugging and investigation instructions.

If you concur @pat-johnson-dev we will implement this in the next release.

In addition to the above we can also use a FHIR suggested key such as:

{
  "resourceType": "OperationOutcome",
  "text": {
    "status": "If you need help understanding how to decipher OperationOutcome please see https://github.com/tech-by-design/help-desk-non-phi/discussions/51.",
    "div": "(... we can put in any HTML content here...)"
  },
  "issue": [ {
    "severity": "error",
    "code": "invalid",
    "diagnostics": "Dummy validation issue: Missing required field 'identifier'."
  } ]
}

Based on @shah opinion he is ok with whichever suggestion you would like to go with.

[pat-johnson-dev]

We should go with @shah's suggestion, using the link at https://github.com/tech-by-design/help-desk-non-phi/discussions/51 as the "source of truth" when this topic arises in the context of our processes.