FHIR R4 APIs for Oracle Health Millennium Platform

Issue health cards for an existing patient

post

/Patient/{ID}/$health-cards-issue

Issues health cards for an existing patient who meets the supplied request.

POST /Patient/:id/$health-cards-issue

Note:

The specification is considered stable; however, it has yet to undergo the HL7 FHIR balloting process that may introduce changes. Consider the possible impacts while implementing health cards in a production environment.
Only the body fields mentioned below are supported. Unsupported fields are ignored.

Authorization Types

This operation supports the following authorization types:

See the Supported Health Card Types and the Authorization Types sections of the associated FHIR Bundle Profile for scopes required for specific health card types.

Request

Path Parameters

ID(required): string

The logical resource ID.

Header Parameters

Accept(required): string

The media type to be requested. See what the resource's operation produces for what is supported.
Authorization: string

Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
Content-Type(required): string

Specifies the content type of the request entity body. See what the resource's operation produces for what is supported.

Root Schema : HealthCardsBody

Type: object

Show Source

_since:
The specific point of time after which resources should be included in the health cards.

Note:
- The value must be in the form of valueDateTime (see the FHIR dateTime datatype format).
- Only one value can be defined.
Example: [ { "name": "_since", "valueDateTime": "2020-04-01" } ]
credentialType(required):
The type of the health cards requested.
Note:
- The value must be in the form of valueUri.
- More than one value for the credentialType can be defined by repeating the element with a different valueUri.
- See the Supported Health Card Types section in the Health Cards resource overview for a list of valid credential types.
Example: [ { "name": "credentialType", "valueUri": "https://smarthealth.cards#covid19" }, { "name": "credentialType", "valueUri": "https://smarthealth.cards#immunization" } ]
parameter(required):

Parameters defined by the operation.

Example: { "parameter": [ { "name": "credentialType", "valueUri": "https://smarthealth.cards#health-card" } ] }
resourceType(required): string

Allowed Values: [ "Parameters" ]

The type of the FHIR resource.

{
    "type":"object",
    "required":[
        "resourceType",
        "parameter",
        "credentialType"
    ],
    "properties":{
        "resourceType":{
            "description":"The type of the FHIR resource.\n",
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "description":"Parameters defined by the operation.\n",
            "example":"{\n  \"parameter\": [\n    {\n      \"name\": \"credentialType\",\n      \"valueUri\": \"https://smarthealth.cards#health-card\"\n    }\n  ]\n}\n"
        },
        "credentialType":{
            "description":"<p>The type of the health cards requested.</p>\n\n<b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueUri</code>.</li>\n  <li>More than one value for the <code>credentialType</code> can be defined by repeating the element with a different <code>valueUri</code>.</li>\n  <ul>\n    <li>Multiple values in a request are interpreted as a request for the intersection of the requested types (logical AND).</li>\n    <li>Oracle recommends adding multiple credential types to the request to match the intended health card type most precisely. This action helps to avoid any integration issues as support for additional health card types is added.</li>\n  </ul>\n  <li>See the Supported Health Card Types section in the Health Cards resource overview for a list of valid credential types.</li>\n</ul>\n",
            "example":"[\n  {\n    \"name\": \"credentialType\",\n    \"valueUri\": \"https://smarthealth.cards#covid19\"\n  },\n  {\n    \"name\": \"credentialType\",\n    \"valueUri\": \"https://smarthealth.cards#immunization\"\n  }\n]\n"
        },
        "_since":{
            "description":"<p>The specific point of time after which resources should be included in the health cards.</p>\n\n<p><b>Note:</b>\n<ul>\n  <li>The value must be in the form of <code>valueDateTime</code> (see the <a href=\"http://hl7.org/fhir/datatypes.html#dateTime\">FHIR dateTime datatype format</a>).</li>\n  <li>Only one value can be defined.</li>\n</ul></p>\n",
            "example":"[\n  {\n    \"name\": \"_since\",\n    \"valueDateTime\": \"2020-04-01\"\n  }\n]\n"
        }
    }
}

Response

Supported Media Types

application/json+fhir

Default Response

Example Request:

POST https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12742542/$health-cards-issue

Example Request Body:

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "credentialType",
      "valueUri": "https://smarthealth.cards#health-card"
    },
    {
      "name": "credentialType",
      "valueUri": "https://smarthealth.cards#covid19"
    },
    {
      "name": "_since",
      "valueDateTime": "2020-04-01"
    }
  ]
}

Example Response:

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "verifiableCredential",
      "valueString": "eyJhbGciOiJFUzI1NiIsInppcCI6IkRFRiIsImtpZCI6Ik4ybWFHOHFPaElUZV96eVBxY3JDYTZMVF9tVzE4WnRGUHkwOWNHQUIyNHcifQ.3ZJPb9QwEMW_Chqu-edsdr3NjZYKKhWE6JYL2oPjTHaN7DiynRVLle_OOLtFINoeOCL54pnxz-89-wGU91DDPoTB13ne7ZVLzdGhtK7NJLoeXSatyV2Voyyr5borU4ZllVZMrtOGsyYtkBdMdHy5XrSQQN90ULNVueR8sVgtEjhIqB8gHAeE-uuvm7wRLuxR6LDPpHCtf33apHFDmOfnlDFjr36IoGz_4qC0B9WyC9gmIB222Acl9N3YfEMZoqRo9gs6Hzk1VFmRFcSL1cuxbzXGGYfejk7iZpYP50ZytgPSak20kxK6wB3JI5FHre-dpoHH83VEP26eAH8iO3Q-5icMniDCKE08eHdze3n9eUO9nTpgH1N8c3tzdU2FO9hOZK9RZP2tCJHELniRMpayFUxT8qQW9rKWmz8D9kGE0c9mzaAxYHyeg5BS9Xhl25kgbav63SzbH31Ac_5T9C57zTPrdvPXyr1qc3n4TgA5n4Sy4DBtpwSGcwCznA4d9lHb7_nRkJVydHMrmt0oc0KULC0WKVsTVtvwcTQNOmrwNV9VVBvQddaZWCN9Qgbr4jWt8oMWMeAPpEW_em_9oILQFNv2ueTK_zC58u_kqnK54uxfo6M1TT8B.ErkeyFvKawfR5UkTvPxF2MIUD058AG5yqRDE2oavtpUhYlLGUyN87gk72ljjat3cQaBNWfu9U8TWVk2T-oR9Hw"
    },
    {
      "name": "verifiableCredential",
      "valueString": "eyJhbGciOiJFUzI1NiIsInppcCI6IkRFRiIsImtpZCI6Ik4ybWFHOHFPaElUZV96eVBxY3JDYTZMVF9tVzE4WnRGUHkwOWNHQUIyNHcifQ.hZJda9swFIb_StFu_SHZTpz4bv1gFMo2mnQXK7mQ5eNEQ5aCJJuFkv--IztNC-syEAgdHT3nPe_RC5HOkYrsvN-7Kk3bnbRxd7AgjG0SAVaDTYTpUlukILJitmizmEFWxAUTi7guWR1TKCnjbTlb5A2JiK5bUrF5NivLPJ_nERkEqV6IP-yBVM_nSq7j1u-AK79LBLeN-zQd4nBAzL_zFK-N5d7Yw8U0YQbZsCXZRERYaEB7ydWqr3-B8EFQaPUHWCeNRgOKhCYUeSF63etGQcix4ExvBaxH8eR0EZ2aIcIohbRAiAgWQEXVM5J7pZ6swoTX91VAvx4-AH_nXuL74B7vYILwTirkkS_3D9d3j2u828oBdPDw88P9zR0GVmRzxPZqia3fch9IbFnSmLGYzcnxGH2ohV3W8q12YAd-6sp57vvwQ1qpucKAMM34Cnept6NUd3AeutMvwlkoI7VIjN2e08mymFEao6bNEZlvQ7DQggUdhLw3C5OgbYO1A4TG1jK4QjKa0ZgWcU7XdFGxWUVxaJT-xDoDVz3cYDFeK9yRuPf_kem06aBJpG5N6oR_E5vNaV7mlLJJ7lnjI9fbaTjT_C_SPdhOaqPM9pDsVBnsSIO-1ZiXnqE2QOMOuA6kswZtbDf63Ui3Vzx8hK9j6GpSEebu4bf_K_4u7K9uwaOJ0IRGwjoe_wA.hpRuDsGuiAAHjGGn5Obfow3TalP5sc7Z00KifXGdoQAtzo6dj0DEeBPqvRcjQTy93GaYhB0jPu4Tzou9QKWcLw"
    },
    {
      "name": "resourceLink",
      "part": [
        {
          "name": "vcIndex",
          "valueInteger": 0
        },
        {
          "name": "bundledResource",
          "valueUri": "resource:0"
        },
        {
          "name": "hostedResource",
          "valueUri": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12742542"
        }
      ]
    },
    {
      "name": "resourceLink",
      "part": [
        {
          "name": "vcIndex",
          "valueInteger": 0
        },
        {
          "name": "bundledResource",
          "valueUri": "resource:1"
        },
        {
          "name": "hostedResource",
          "valueUri": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197462828"
        }
      ]
    },
    {
      "name": "resourceLink",
      "part": [
        {
          "name": "vcIndex",
          "valueInteger": 0
        },
        {
          "name": "bundledResource",
          "valueUri": "resource:2"
        },
        {
          "name": "hostedResource",
          "valueUri": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Immunization/M197462824"
        }
      ]
    },
    {
      "name": "resourceLink",
      "part": [
        {
          "name": "vcIndex",
          "valueInteger": 1
        },
        {
          "name": "bundledResource",
          "valueUri": "resource:0"
        },
        {
          "name": "hostedResource",
          "valueUri": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Patient/12742542"
        }
      ]
    },
    {
      "name": "resourceLink",
      "part": [
        {
          "name": "vcIndex",
          "valueInteger": 1
        },
        {
          "name": "bundledResource",
          "valueUri": "resource:1"
        },
        {
          "name": "hostedResource",
          "valueUri": "https://fhir-myrecord.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Observation/M-197287549"
        }
      ]
    }
  ]
}

Headers

X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.