Test sandbox for onramp to TEFCA-CommonWell

The CommonWell sandbox within Redox is integrated with the CommonWell environment, which allows you a sneak peak into what querying TEFCA-CommonWell will be like. The sandbox is a data on demand repository where test data lives.

In order to query the sandbox, you first have to ingest our test patients. This replicates the behavior of the CommonWell EMPI, which only returns matches for patients that already exist within your organization’s repository. In other words, results won’t be returned from external participants unless a demographics match already exists in your own CommonWell dataset.

You can ingest these test patients with a PatientAdmin feed.

You’ll need both of these values in the metadata of your queries to the CommonWell sandbox.

1
"Extensions": {
2
  "purpose-of-use": {
3
     "url": "https://api.redoxengine.com/extensions/purpose-of-use",
4
     "coding": {
5
       "code": "TREATMENT"
6
     }
7
  },
8
  "sender-organization-id": {
9
     "url": "https://api.redoxengine.com/extensions/sender-organization-id",
10
     "string": "2.16.840.1.113883.3.6147.450.0.2.19301.0.1"
11
  },
12
  "assigning-authority": {
13
     "url": "https://api.redoxengine.com/extensions/assigning-authority",
14
     "string": "Redox"
15
  },
16
  "user-id": {
17
     "url": "https://api.redoxengine.com/extensions/user-id",
18
     "string": "redox-sandbox-tester"
19
  },
20
  "user-role": {
21
     "url": "https://api.redoxengine.com/extensions/user-role",
22
     "coding": {
23
       "code": "112247003",
24
       "display": "Medical Doctor"
25
     }
26
  }
27
},

1. Create an API source in your development environment to interface with the CommonWell network.
2. Talk to your Technical Account Manager to:
   1. Create a data on demand destination for you. The data on demand repository will house the test patient data for you. Add a unique ID type that will match your CommonWell PIAA. Learn about OIDs for CommonWell.
   2. Create a CommonWell DNPR for you.
   3. Create three subscriptions with the source you’ve created. The subscription should include your API source and these data models:
      1. PatientAdmin

         Ingesting patient data

         This data model enables you to ingest test patient data into your system. Keep in mind that you can re-ingest Redox test patients using your own patient identifier, ID type, and sender-organization-id.

      2. PatientSearch
      3. ClinicalSummary
      4. Organization
3. Create a TEFCA-CommonWell organization record for the sandbox.
   1. The organization ID should match the directory OID from the data on demand DNPR.
   2. The PIAA corresponds to the ID type for your patients.

      Example: Create a development organization record

      json

      Copy

      1
      {
      2
        "Meta": {
      3
          "DataModel": "Organization",
      4
          "EventType": "New",
      5
          "EventDateTime": null,
      6
          "Test": true,
      7
          "Source": {
      8
            "ID": "84fe7f6b-fe6a-48cf-a45b-ef2f195dbaaf",
      9
            "Name": "cw-sender-source"
      10
          },
      11
          "Destinations": [
      12
            {
      13
              "ID": "3122bfff-f1fb-4fdf-97de-294f24338229",
      14
              "Name": "CommonWell EMPI [Integration]"
      15
            }
      16
          ],
      17
          "Logs": [
      18
            {
      19
              "ID": "0196f43b-9f99-7111-b4c6-5d2850b767bc",
      20
              "AttemptID": "0196f43b-9f99-7b9b-bda6-bb3ec95dbaf4"
      21
            }
      22
          ],
      23
          "FacilityCode": null
      24
        },
      25
        "Directory": "CommonWell",
      26
        "Organizations": [
      27
          {
      28
            "Active": true,
      29
            "Name": "{{your-organization-name}}",
      30
            "Aliases": [],
      31
            "Identifiers": [
      32
              {
      33
                "ID": "{{assigning-authority}}",
      34
                "IDType": "PIAA"
      35
              },
      36
              {
      37
                "ID": "{{organization-OID}}",
      38
                "IDType": "OID"
      39
              }
      40
            ],
      41
            "Type": {
      42
              "System": "http://hl7.org/fhir/organization-type",
      43
              "Value": "HOSPITAL"
      44
            },
      45
            "PartOf": {
      46
              "Identifier": {
      47
                "Type": "HCID",
      48
                "System": "http://www.hl7.org/oid/",
      49
                "Value": "1.2.3.4"
      50
              }
      51
            },
      52
            "Contacts": [
      53
              {
      54
                "Purpose": null,
      55
                "Name": "Bixby, Barbara",
      56
                "EmailAddresses": [
      57
                  "barb.bixby@test.net"
      58
                ],
      59
                "PhoneNumber": {
      60
                  "Home": "+18088675303",
      61
                  "Work": null,
      62
                  "Mobile": "+19189368865"
      63
                }
      64
              }
      65
            ],
      66
            "Address": {
      67
              "StreetAddress": "123 Main St.",
      68
              "City": "ATown",
      69
              "State": "AL",
      70
              "ZIP": "86754",
      71
              "County": "Madison",
      72
              "Country": "USA"
      73
            },
      74
            "Endpoints": [
      75
              {
      76
                "Identifiers": [
      77
                  {
      78
                    "Type": "HCID",
      79
                    "System": "http://www.hl7.org/oid/",
      80
                    "Value": "2.8.1.2"
      81
                  }
      82
                ],
      83
                "ConnectionType": {
      84
                  "System": "http://hl7.org/fhir/subscription-channel-type",
      85
                  "Value": "ihe-xcpd"
      86
                },
      87
                "Name": "Patient Discovery",
      88
                "Address": "https://fake.fake.com/xcpd",
      89
                "MIMEType": "Text/XML",
      90
                "Attributes": {
      91
                  "Transaction": "XCPD ITI-55",
      92
                  "Actor": {
      93
                    "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Actor/1.0.0",
      94
                    "Value": "Responding Gateway"
      95
                  },
      96
                  "Version": {
      97
                    "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Version/1.0.0",
      98
                    "Value": "2.0"
      99
                  },
      100
                  "UseCases": [
      101
                    {
      102
                      "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/UseCases/1.0.0",
      103
                      "Value": "QueryBasedDocumentExchange"
      104
                    }
      105
                  ],
      106
                  "PurposeOfUse": [
      107
                    {
      108
                      "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/PurposesOfUse/1.0.0",
      109
                      "Value": "Treatment"
      110
                    }
      111
                  ],
      112
                  "Roles": [
      113
                    {
      114
                      "System": "https://sequoiaproject.org/StructureDefinition/Endpoint/Roles/1.0.0",
      115
                      "Value": "All"
      116
                    }
      117
                  ]
      118
                }
      119
              }
      120
            ],
      121
            "DestinationID": "3122bfff-f1fb-4fdf-97de-294f24338229"
      122
          }
      123
        ]
      124
      }