MyndAuth API

API Input

This API accepts US Core based json bundle, based on HL7 FHIR V4 as an input.

FHIR® – Fast Healthcare Interoperability Resources (hl7.org/fhir) – is a next generation standards framework created by HL7. FHIR v4 combines the best features of HL7’s v2, HL7 v3 and CDA product lines while leveraging the latest web standards and applying a tight focus on implementability.

Input submitted to this API MUST be in the form of a well formatted FHIR Resource Bundle. The Resource Bundle MUST contain the resources outlined below to be considered for processing.

This API implements R4 of the FHIR specification and STU3 of the US Core Implementation Guide. Please use a FHIR validator to ensure submitted requests are valid FHIR Resource Bundle.

For more information about FHIR please see:

This API is made with using the HAPI FHIR library. We recommend you use HAPI FHIR when transmitting data for this API.

Input Format

This is only an overview of the accepted FHIR Resource Bundle and is not exhaustive. Please refer to the FHIR specification for the full format.

FHIR Resource Bundle

The FHIR Resource Bundle is a container object which holds an array of Bundle.entry objects.

{
  "resourceType" : "Bundle",
  "type": "collection",
  "entry" : [
    // Array of Bundle.entry objects
  ]
}

A FHIR Resource Bundle containing one Patient resource is included below.

This example is for reference only and does not meet the resource requirements of this API. 
{
  "resourceType": "Bundle",
  "id": "1843a47b-d2f5-4d47-8187-fe3b48f4a769",
  "type": "collection",
  "entry": [
    {
      "fullUrl": "http://myndauth.com/patient/p01",
      "resource": {
        "resourceType": "Patient",
        "id": "p01",
        "meta" : {
          "profile" : [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "identifier" : [
          {
            "use" : "usual",
            "type" : {
              "coding" : [
                {
                  "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code" : "MR",
                  "display" : "Medical Record Number"
                }
              ],
              "text" : "Medical Record Number"
            },
            "system" : "http://hospital.smarthealthit.org",
            "value" : "1032702"
          }
        ],
        "active": true,
        "name": [
          {
            "use": "official",
            "text": "Stacie",
            "family": "ONEIL",
            "given": [
              "STACIE"
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+31612345678",
            "use": "mobile"
          },
          {
            "system": "phone",
            "value": "+3363636537",
            "use": "home"
          }
        ],
        "gender": "male",
        "birthDate": "1998-06-28",
        "deceasedBoolean": false,
        "address": [
          {
            "use": "old",
            "line": [
              "321 Old Ave"
            ],
            "city": "Old",
            "state": "AZ",
            "country": "US",
            "postalCode": "85201"
          },
          {
            "use": "home",
            "line": [
              "123 Something Ave"
            ],
            "city": "Exampleville",
            "state": "AZ",
            "country": "US",
            "postalCode": "85201"
          }
        ],
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en-US",
                  "display": "English (Region=United States)"
                }
              ]
            },
            "preferred": false
          },
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "es",
                  "display": "Spanish"
                }
              ]
            },
            "preferred": true
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "36629006",
              "display": "Legally married"
            },
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
              "code": "M"
            }
          ]
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode": "F"
          }
        ]
      }
    }
  ]
}

Bundle Entry Objects

A FHIR Resource Bundle MAY contain one the following resources. Please note the resources that are REQUIRED by this API.

Resources that are required by this API are marked “ REQUIRED”

Claim

REQUIRED: The submitted FHIR Resource Bundle MUST contain this Resource as an entry.

Resource Definition: Claim

Myndshft Required Claim Elements:

Name Description
priority Please do not use this service for ‘stat’ or urgent requests!
use Must have value “preauthorization”
patient.reference Reference Patient resource; The recipient of service
provider.reference Reference Practitioner or Organization resource; Party responsible for the claim
insurance.coverage.reference Reference Coverage resource; patient insurance information
item.extension valueCodeableConcept specifying CertficiationType
item.serviceDate Date the service is being requested for
item.procductOrService valueCodeableConcept specifiying the CPT code for the service to adjudicate
item.locationCodeableConcept Place of Service 
{
  "fullUrl": "http://myndauth.com/example/Claim/c01",
  "resource": {
    "resourceType": "Claim",
    "id": "c01",
    "status": "active",
    "type": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/claim-type",
          "code": "professional",
          "display": "Professional"
        }
      ]
    },
    "use": "preauthorization",
    "patient": {
      "reference": "Patient/p01"
    },
    "created": "2010-01-04T05:10:13-06:00",
    "provider": {
      "reference": "Practitioner/p01"
    },
    "careTeam": [
      {
        "sequence": 1,
        "provider": {
          "reference": "Practitioner/p02"
        }
      }
    ],
    "facility": {
      "reference": "Location/l01"
    },
    "priority": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/processpriority",
          "code": "normal"
        }
      ]
    },
    "insurance": [
      {
        "sequence": 1,
        "focal": true,
        "coverage": {
          "reference": "Coverage/c01"
        }
      }
    ],
    "diagnosis": [
      {
        "sequence": 1,
        "diagnosisCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/icd-10-cm",
              "code": "G83.4",
              "display": "Cauda equina syndrome"
            }
          ]
        }
      }
    ],
    "item": [
      {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-certificationType",
            "valueCodeableConcept" : {
              "coding" : [
                {
                  "system" : "http://codesystem.x12.org/005010/1322",
                  "code" : "I",
                  "display" : "Initial"
                }
              ]
            }
          }
        ],
        "sequence": 1,
        "careTeamSequence": [
          1
        ],
        "productOrService": {
          "coding": [
            {
              "system": "http://www.ama-assn.org/go/cpt",
              "code": "63030"
            }
          ]
        },
        "servicedDate": "2020-12-31",
        "locationCodeableConcept": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/ex-serviceplace",
              "code": "11"
            }
          ]
        },
        "quantity": {
          "value": 1,
          "unit": "Unit"
        }
      }
    ]
  }
}

Patient

REQUIRED: The submitted FHIR Resource Bundle MUST contain this Resource as an entry.

Resource Definition: Patient

Myndshft Required Patient Elements:

Name Description
name.family Patient’s legal Last Name
name.given Patient’s legal First Name
name.use use = “official” for the prefered name to use
extension.birthsex Please do not use this service for ‘stat’ or urgent requests!
birthDate The date of birth for the Patient
address Patient’s current address use must = “home”
telecom.value The contact phone number for the Patient
telecom.system Must have value “phone”
telecom.use May be “mobile”, “home” or “work” 
 {
  "fullUrl": "http://myndauth.com/patient/p01",
  "resource": {
    "resourceType": "Patient",
    "id": "p01",
    "meta" : {
      "profile" : [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
      ]
    },
    "identifier" : [
      {
        "use" : "usual",
        "type" : {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
              "code" : "MR",
              "display" : "Medical Record Number"
            }
          ],
          "text" : "Medical Record Number"
        },
        "system" : "http://hospital.smarthealthit.org",
        "value" : "1032702"
      }
    ],
    "active": true,
    "name": [
      {
        "use": "official",
        "family": "ONEIL",
        "given": [
          "Steve",
          "C."
        ],
        "suffix": "Jr."
      }
    ],
    "telecom": [
      {
        "system": "phone",
        "value": "+31612345678",
        "use": "mobile"
      },
      {
        "system": "phone",
        "value": "+3363636537",
        "use": "home"
      },
      {
        "system": "email",
        "value": "steve@sendmesomething.com"
      }
    ],
    "gender": "male",
    "birthDate": "1998-06-28",
    "address": [
      {
        "use": "old",
        "line": [
          "321 Old Ave"
        ],
        "city": "Old",
        "state": "AZ",
        "country": "US",
        "postalCode": "85201"
      },
      {
        "use": "home",
        "line": [
          "123 Something Ave"
        ],
        "city": "Exampleville",
        "state": "AZ",
        "country": "US",
        "postalCode": "85201"
      }
    ],
    "communication": [
      {
        "language": {
          "coding": [
            {
              "system": "urn:ietf:bcp:47",
              "code": "en-US",
              "display": "English (Region=United States)"
            }
          ]
        },
        "preferred": false
      },
      {
        "language": {
          "coding": [
            {
              "system": "urn:ietf:bcp:47",
              "code": "es",
              "display": "Spanish"
            }
          ]
        },
        "preferred": true
      }
    ],
    "extension": [
      {
        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
        "valueCode": "M"
      },
      {
        "extension" : [
          {
            "url" : "text",
            "valueString" : "Hispanic or Latino"
          }
        ],
        "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
      }
    ]
  }
}

Organization

REQUIRED: The submitted FHIR Resource Bundle MUST contain this Resource as an entry.

Resource Definition: Organization

Myndshft Required Organization Elements:

Name Description
identifier Identifies this organization across multiple systems 
{
  "fullUrl": "http://mynauth.com/Organization/o01",
  "resource": {
    "resourceType": "Organization",
    "meta" : {
      "profile" : [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
      ]
    },
    "name": "Blue Shield of State",
    "identifier" : [
      {
        "system": "http://hl7.org/fhir/sid/us-npi",
        "value": "9876543215"
      }
    ],
    "id": "o01"
  }
}

Coverage

REQUIRED: The submitted FHIR Resource Bundle MUST contain this Resource as an entry.

Resource Definition: Coverage

Myndshft Required Coverage Elements:

Name Description
subscriberId ID assigned to the subscriber 
{
  "fullUrl": "http://myndauth.com/Coverage/c01",
  "resource": {
    "resourceType": "Coverage",
    "status": "active",
    "subscriberId": "1234567891",
    "id": "c01",
    "beneficiary": {
      "reference": "Patient/p01"
    },
    "payor": [
      {
        "reference": "Organization/o01"
      }
    ],
    "class": [
      {
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
              "code": "group"
            }
          ]
        },
        "value": "MS101",
        "name": "Myndshft Test Group"
      },
      {
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
              "code": "plan"
            }
          ]
        },
        "value": "B37FC",
        "name": "commercial insurance co"
      }
    ]
  }
}

Practitioner

REQUIRED: The submitted FHIR Resource Bundle MUST contain this Resource as an entry.

Resource Definition: Practitioner

Myndshft Required Practitioner Elements:

Name Description
subscriberId ID assigned to the subscriber
name.use use = “official” for the prefered name to use 
 {
  "fullUrl": "http://myndauth.com/Practitioner/p01",
  "resource": {
    "resourceType": "Practitioner",
    "meta" : {
      "profile" : [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
      ]
    },
    "identifier" : [
      {
        "system": "http://hl7.org/fhir/sid/us-npi",
        "value": "9854419295"
      }
    ],
    "telecom": [
      {
        "system": "phone",
        "value": "626-441-4888"
      },
      {
        "system": "email",
        "value": "ross@myndshft.com"
      }
    ],
    "name": [
      {
        "use": "official",
        "given": [
          "Ross"
        ],
        "family": "Geller"
      }
    ],
    "id": "p01"
  }
}

Condition

Resource Definition: Condition

Notes on Use: If a diagnosis code is provided on the Claim resource it does not need to be duplicated here.

Name Description
category.coding.code Specifies the category of the condition
code.coding.system Use SNOMED or ICD10 condition codes 
{
  "fullUrl": "http://myndauth.com/Condition/c01",
  "resource": {
    "resourceType": "Condition",
    "id": "c01",
    "clinicalStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
          "code": "active"
        }
      ]
    },
    "verificationStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
          "code": "confirmed"
        }
      ]
    },
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
            "code": "encounter-diagnosis"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/sid/icd-10-cm",
          "code": "G83.4",
          "display": "Cauda equina syndrome"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    }
  }
}

{
  "fullUrl": "http://myndauth.com/Condition/c01",
  "resource": {
    "resourceType": "Condition",
    "id": "c01",
    "clinicalStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
          "code": "active"
        }
      ]
    },
    "verificationStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
          "code": "confirmed"
        }
      ]
    },
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/condition-category",
            "code": "encounter-diagnosis"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/sid/icd-10-cm",
          "code": "G83.4",
          "display": "Cauda equina syndrome"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    }
  }
}

  {
  "fullUrl": "http://myndauth.com/Condition/c03",
  "resource":{
    "resourceType": "Condition",
    "id": "c03",
    "meta": {
      "profile": [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
      ]
    },
    "clinicalStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
          "code": "active"
        }
      ]
    },
    "verificationStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
          "code": "confirmed"
        }
      ]
    },
    "category": [
      {
        "coding": [
          {
            "system": "http://hl7.org/fhir/us/core/CodeSystem/condition-category",
            "code": "health-concern",
            "display": "Health Concern"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "165002",
          "display": "Accident-prone"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    }
  }
}

Observation

Resource Definition: Observation

Smoking Status

{
  "fullUrl": "http://myndauth.com/observation/smokingstatus",
  "resource": {
    "resourceType": "Observation",
    "id": "smoking-status",
    "meta" : {
      "profile" : [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
      ]
    },
    "status" : "final",
    "valueCodeableConcept": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "266919005"
        }
      ],
      "text": "Never smoker"
    },
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "72166-2"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    },
    "issued": "2016-03-18T05:27:04Z"
  }
}

If Laboratory resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
category.coding.code “laboratory”
subject.reference Patient the observation is about 
{
  "fullUrl": "http://myndauth.com/observation/lab01",
  "resource":
  {
    "resourceType": "Observation",
    "id": "lab01",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: bloodgroup</p><p><b>status</b>: final</p><p><b>category</b>: Laboratory <span>(Details : {http://terminology.hl7.org/CodeSystem/observation-category code 'laboratory' = 'Laboratory', given as 'Laboratory'})</span></p><p><b>code</b>: Blood Group <span>(Details : {LOINC code '883-9' = 'ABO group [Type] in Blood', given as 'ABO group [Type] in Blood'})</span></p><p><b>subject</b>: <a>Patient/infant</a></p><p><b>effective</b>: 11/03/2018 4:07:54 PM</p><p><b>value</b>: A <span>(Details : {SNOMED CT code '112144000' = 'Blood group A', given as 'Blood group A (finding)'})</span></p></div>"
    },
    "status": "final",
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/observation-category",
            "code": "laboratory",
            "display": "Laboratory"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "883-9",
          "display": "ABO group [Type] in Blood"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    },
    "effectiveDateTime": "2018-03-11T16:07:54+00:00",
    "valueCodeableConcept": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "112144000",
          "display": "Blood group A (finding)"
        }
      ]
    }
  }
}

If Image resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
category.coding.code “image”
subject.reference Patient the observation is about 
  {
  "fullUrl": "http://myndauth.com/observation/image01",
  "resource":
  {
    "resourceType": "Observation",
    "id": "bmd",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: bmd</p><p><b>status</b>: final</p><p><b>code</b>: BMD - Left Femur <span>(Details : {LOINC code '24701-5' = 'Femur DXA Bone density', given as 'Femur DXA Bone density'})</span></p><p><b>subject</b>: <a>Patient/pat2</a></p><p><b>performer</b>: <a>Acme Imaging Diagnostics</a></p><p><b>value</b>: 0.887 g/cm²<span> (Details: UCUM code g/cm-2 = 'g/cm-2')</span></p><p><b>bodySite</b>: Left Femur <span>(Details : {SNOMED CT code '71341001:272741003=7771000' = 'Femur where Laterality = Left)</span></p></div>"
    },
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/observation-category",
            "code": "imaging",
            "display": "Imaging"
          }
        ]
      }
    ],
    "status": "final",
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "24701-5",
          "display": "Femur DXA Bone density"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    },
    "performer": [
      {
        "reference": "Organization/o01"
      }
    ],
    "valueQuantity": {
      "value": 0.887,
      "unit": "g/cm²",
      "system": "http://unitsofmeasure.org",
      "code": "g/cm-2"
    },
    "bodySite": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "71341001:272741003=7771000"
        }
      ],
      "text": "Left Femur"
    }
  }
}

If Vital Sign resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
category.coding.code “vital-signs”
code.coding Code specifying what type of vital signs is provided 
{
  "fullUrl": "http://myndauth.com/observation/bmi",
  "resource": {
    "resourceType": "Observation",
    "id": "bmi",
    "status": "final",
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/observation-category",
            "code": "vital-signs",
            "display": "Vital Signs"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "39156-5",
          "display": "Body mass index (BMI) [Ratio]"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    },
    "valueQuantity": {
      "value": 29,
      "unit": "kg/m2",
      "system": "http://unitsofmeasure.org",
      "code": "kg/m2"
    }
  }
}

CareTeam

Resource Definition: CareTeam

  {
  "fullUrl": "http://myndauth.com/careteam/t01",
  "resource": {
    "resourceType": "CareTeam",
    "id": "t01",
    "status": "active",
    "subject": {
      "reference": "Patient/p01"
    },
    "participant": [
      {
        "role": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "446050000",
                "display": "Primary care physician"
              }
            ]
          }
        ],
        "member": {
          "reference": "Practitioner/p01"
        }
      },
      {
        "role": [
          {
            "text": "adviser"
          }
        ],
        "member": {
          "reference": "Practitioner/p02"
        }
      },
      {
        "role": [
          {
            "text": "responsiblePerson"
          }
        ],
        "member": {
          "reference": "Patient/p01"
        }
      }
    ],
    "managingOrganization": [
      {
        "reference": "Organization/o01"
      }
    ]
  }
}

CarePlan

Resource Definition: CarePlan

If CarePlan resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
text.status Narrative Status
text.status.display Narrative Summary 
     {
  "fullUrl": "http://myndauth.com/CarePlan/cp02",
  "resource":
  {
    "resourceType": "CarePlan",
    "id": "cp02",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: f001</p><p><b>contained</b>: , </p><p><b>identifier</b>: CP2903 (OFFICIAL)</p><p><b>status</b>: completed</p><p><b>intent</b>: plan</p><p><b>subject</b>: <a>P. van de Heuvel</a></p><p><b>period</b>: 26/06/2011 --&gt; 27/06/2011</p><p><b>careTeam</b>: id: careteam</p><p><b>addresses</b>: <a>?????</a></p><p><b>goal</b>: id: goal; lifecycleStatus: completed; Achieved <span>(Details : {http://terminology.hl7.org/CodeSystem/goal-achievement code 'achieved' = 'Achieved', given as 'Achieved'})</span>; recovery surgery on heart of patient <span>(Details )</span>; Annotation: goal accomplished without complications</p><blockquote><p><b>activity</b></p><h3>Details</h3><table><tr><td>-</td><td><b>Kind</b></td><td><b>Code</b></td><td><b>Status</b></td><td><b>DoNotPerform</b></td><td><b>Scheduled[x]</b></td><td><b>Performer</b></td></tr><tr><td>*</td><td>ServiceRequest</td><td>Operation on heart <span>(Details : {SNOMED CT code '64915003' = 'Operative procedure on heart', given as 'Operation on heart'})</span></td><td>completed</td><td>true</td><td>2011-06-27T09:30:10+01:00</td><td><a>P. Voigt</a></td></tr></table></blockquote></div>"
    },
    "status": "completed",
    "intent": "plan",
    "subject": {
      "reference": "Patient/p01"
    },
    "period": {
      "start": "2011-06-26",
      "end": "2011-06-27"
    },
    "careTeam": [
      {
        "reference": "CareTeam/t01"
      }
    ],
    "activity": [
      {
        "detail": {
          "code": {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "64915003",
                "display": "Operation on heart"
              }
            ]
          },
          "status": "completed",
          "doNotPerform": true,
          "scheduledString": "2011-06-27T09:30:10+01:00",
          "performer": [
            {
              "reference": "Practitioner/p01"
            }
          ]
        }
      }
    ]
  }
}

Goal

Resource Definition: Goal

   {
  "fullUrl": "http://mynauth.com/goals/g02",
  "resource":
  {
    "resourceType": "Goal",
    "id": "g02",
    "lifecycleStatus": "on-hold",
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/goal-category",
            "code": "dietary"
          }
        ]
      }
    ],
    "description": {
      "text": "Target weight is 160 to 180 lbs."
    },
    "subject": {
      "reference": "Patient/p01"
    },
    "target": [
      {
        "measure": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "3141-9",
              "display": "Weight Measured"
            }
          ]
        },
        "detailRange": {
          "low": {
            "value": 160,
            "unit": "lbs",
            "system": "http://unitsofmeasure.org",
            "code": "[lb_av]"
          },
          "high": {
            "value": 180,
            "unit": "lbs",
            "system": "http://unitsofmeasure.org",
            "code": "[lb_av]"
          }
        },
        "dueDate": "2016-04-05"
      }
    ]
  }
}

DocumentReference

Resource Definition: DocumentReference

If DocumentReference resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
masterIdentifier Master Version Specific Identifier
type Myndshft will only map the following LOINC Codes “11488-4” - Consultation Note; “18842-5” - Discharge Summary; “11506-3” - Progress Note;“68608-9” - Summary Note"
category Categorization of document using Document Class Value Set
subject.reference Patient the observation is about 
{
  "fullUrl": "http://mynauth.com/documentref/dr01",
  "resource":
  {
    "resourceType": "DocumentReference",
    "id": "dr01",
    "masterIdentifier": {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7"
    },
    "status": "current",
    "docStatus": "preliminary",
    "type": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "68608-9",
          "display": "Summary Note"
        }
      ]
    },
    "category": [
      {
        "coding": [
          {
            "system": "http://ihe.net/xds/connectathon/classCodes",
            "code": "History and Physical",
            "display": "History and Physical"
          }
        ]
      }
    ],
    "subject": {
      "reference": "Patient/p01"
    },
    "date": "2005-12-24T09:43:41+11:00",
    "author": [
      {
        "reference": "Practitioner/p01"
      }
    ],
    "authenticator": {
      "reference": "Organization/o01"
    },
    "custodian": {
      "reference": "Organization/o01"
    },
    "description": "Physical",
    "content": [
      {
        "attachment": {
          "contentType": "application/hl7-v3+xml",
          "language": "en-US",
          "url": "http://example.org/xds/mhd/Binary/07a6483f-732b-461e-86b6-edb665c45510",
          "size": 3654,
          "hash": "2jmj7l5rSw0yVb/vlWAYkK/YBwk=",
          "title": "Physical",
          "creation": "2005-12-24T09:35:00+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": {
      "encounter": [
        {
          "reference": "Encounter/e01"
        }
      ],
      "period": {
        "start": "2004-12-23T08:00:00+11:00",
        "end": "2004-12-23T08:01:00+11:00"
      }
    }
  }
}

DiagnosticReport

Resource Definition: DiagnosticReport

Myndshft will only map the following DiagnosticReport Report Codes

Code.code Description
34117-2 History and Physical
18748-4 Imaging Narrative
77202-0 Lab Report Narrative
LP7839-6 Pathology
11526-1 Procedure Note
11506-3 Progress Note

OR Category code

Category.code Description
‘OTH’ Other 
 {
  "fullUrl": "http://mynauth.com/dagnosticreport/d01",
  "resource":
  {
    "resourceType": "DiagnosticReport",
    "id": "d01",
    "status": "final",
    "category": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
            "code": "LAB"
          }
        ]
      }
    ],
    "code": {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": "77202-0"
        }
      ]
    },
    "subject": {
      "reference": "Patient/p01"
    },
    "effectiveDateTime": "2013-02-11T10:33:33+11:00",
    "issued": "2013-02-13T11:45:33+11:00",
    "performer": [
      {
        "reference": "Practitioner/p01"
      }
    ],
    "result": [
      {
        "reference": "Observation/o01"
      }
    ],
    "conclusion": "Blood culture tested positive on staphylococcus aureus",
    "conclusionCode": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "428763004",
            "display": "Bacteremia due to staphylococcus"
          }
        ]
      }
    ]
  }
}

AllergyIntolerance

Resource Definition: AllergyIntolerance

If AllergyIntolerance resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
verificationStatus AllergyIntolerance VerificationStatus
reaction.coding Code that identifies the allergy or intolerance 
  {
  "fullUrl": "http://myndauth.com/Allergy/a01",
  "resource": {
    "resourceType": "AllergyIntolerance",
    "id": "a01",
    "clinicalStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
          "code": "active",
          "display": "Active"
        }
      ]
    },
    "verificationStatus": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
          "code": "confirmed",
          "display": "Confirmed"
        }
      ]
    },
    "patient": {
      "reference": "Patient/p01"
    },
    "reaction": [
      {
        "substance": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "1160593",
              "display": "cashew nut allergenic extract Injectable Product"
            }
          ]
        },
        "manifestation": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "39579001",
                "display": "Anaphylactic reaction"
              }
            ]
          },
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "64305001",
                "display": "Urticaria"
              }
            ]
          }
        ],
        "description": "Challenge Protocol. Severe reaction to subcutaneous cashew extract. Epinephrine administered",
        "onset": "2012-06-12",
        "severity": "severe"
      }
    ]
  }
}

Immunization

Resource Definition: Immunization

If Immunization resource is specified in addition to the FHIR required elements, the following elements are required by Myndshft.

Name Description
primarySource Indicates context the data was recorded in 
{
  "fullUrl": "http://myndauth.com/immunization/i02",
  "resource": {
    "resourceType": "Immunization",
    "id": "i02",
    "status": "completed",
    "vaccineCode": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/sid/cvx",
          "code": "16"
        }
      ],
      "text": "Influenza"
    },
    "patient": {
      "reference": "Patient/p01"
    },
    "occurrenceString": "January 2012",
    "primarySource": true
  }
}

Medication

Resource Definition: Medication

{
  "fullUrl": "http://myndauth.com/medication/m01",
  "resource": {
    "resourceType": "Medication",
    "id": "m01",
    "meta": {
      "profile": [
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
      ]
    },
    "code": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "25773002"
        }
      ]
    }
  }
}

Provenance

Resource Definition: Provenance

 {
  "fullUrl": "http://myndshft.com/Provenance/p01",
  "resource":
  {
    "resourceType": "Provenance",
    "id": "p01",
    "target": [
      {
        "reference": "Procedure/p01"
      }
    ],
    "occurredPeriod": {
      "start": "2015-06-27",
      "end": "2015-06-28"
    },
    "recorded": "2015-06-27T08:39:24+10:00",
    "reason": [
      {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "3457005",
            "display": "Referral"
          }
        ]
      }
    ],
    "agent": [
      {
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "AUT"
            }
          ]
        },
        "who": {
          "reference": "Practitioner/p01"
        }
      },
      {
        "id": "a1",
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "DEV"
            }
          ]
        },
        "who": {
          "reference": "Device/software"
        }
      }
    ]
  }
}

FHIR Resource Bundle Sample

A sample FHIR Resource Bundle can be found below.

{
  "resourceType": "Bundle",
  "id": "bundle-references",
  "type": "collection",
  "entry": [
    {
      "fullUrl": "http://myndauth.com/patient/p01",
      "resource": {
        "resourceType": "Patient",
        "id": "p01",
        "meta" : {
          "profile" : [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
          ]
        },
        "identifier" : [
          {
            "use" : "usual",
            "type" : {
              "coding" : [
                {
                  "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code" : "MR",
                  "display" : "Medical Record Number"
                }
              ]
            },
            "system" : "http://hospital.smarthealthit.org",
            "value" : "1032702"
          }
        ],
        "active": true,
        "name": [
          {
            "use": "official",
            "family": "ONEIL",
            "given": [
              "Stacie",
              "C."
            ]
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+31612345678",
            "use": "mobile"
          },
          {
            "system": "phone",
            "value": "+3363636537",
            "use": "home"
          },
          {
            "system": "email",
            "value": "staci@sendmesomething.com"
          }
        ],
        "gender": "female",
        "birthDate": "1998-06-28",
        "address": [
          {
            "use": "old",
            "line": [
              "321 Old Ave"
            ],
            "city": "Old",
            "state": "AZ",
            "country": "US",
            "postalCode": "85201"
          },
          {
            "use": "home",
            "line": [
              "123 Something Ave"
            ],
            "city": "Exampleville",
            "state": "AZ",
            "country": "US",
            "postalCode": "85201"
          }
        ],
        "communication": [
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "en-US",
                  "display": "English (Region=United States)"
                }
              ]
            },
            "preferred": false
          },
          {
            "language": {
              "coding": [
                {
                  "system": "urn:ietf:bcp:47",
                  "code": "es",
                  "display": "Spanish"
                }
              ]
            },
            "preferred": true
          }
        ],
        "maritalStatus": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "36629006",
              "display": "Legally married"
            },
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
              "code": "M"
            }
          ]
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
            "valueCode": "F"
          },
          {
            "extension" : [
              {
                "url" : "text",
                "valueString" : "Hispanic or Latino"
              }
            ],
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
          }
        ]
      }
    },
    {
      "fullUrl": "http://myndauth.com/Practitioner/p01",
      "resource": {
        "resourceType": "Practitioner",
        "meta" : {
          "profile" : [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
          ]
        },
        "identifier" : [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI"
                }
              ]
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "9854419295"
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "626-441-4888"
          },
          {
            "system": "email",
            "value": "ross@myndshft.com"
          }
        ],
        "name": [
          {
            "use": "official",
            "given": [
              "Ross"
            ],
            "family": "Geller",
            "prefix" : [
              "Dr"
            ]
          }
        ],
        "id": "p01"
      }
    },
    {
      "fullUrl": "http://myndauth.com/Practitioner/p02",
      "resource": {
        "resourceType": "Practitioner",
        "meta" : {
          "profile" : [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
          ]
        },
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI"
                }
              ]
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "8854419295"
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "704-441-4888"
          },
          {
            "system": "email",
            "value": "rachel@myndshft.com"
          }
        ],
        "name": [
          {
            "given": [
              "Rachel"
            ],
            "family": "Greene",
            "use": "official"
          }
        ],
        "id": "p02"
      }
    },
    {
      "fullUrl": "http://mynauth.com/Organization/o01",
      "resource": {
        "resourceType": "Organization",
        "meta" : {
          "profile" : [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
          ]
        },
        "name": "Blue Shield of California",
        "identifier" : [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "9876543215"
          }
        ],
        "id": "o01"
      }
    },
    {
      "fullUrl": "http://mynauth.com/Organization/o02",
      "resource": {
        "resourceType": "Organization",
        "name": "Dr Joe Smith Corporation",
        "identifier" : [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "8189991234"
          }
        ],
        "id": "o02",
        "active": true
      }
    },
    {
      "fullUrl": "http://myndauth.com/Coverage/c01",
      "resource": {
        "resourceType": "Coverage",
        "status": "active",
        "subscriberId": "1234567891",
        "id": "c01",
        "beneficiary": {
          "reference": "Patient/p01"
        },
        "payor": [
          {
            "reference": "Organization/o01"
          }
        ],
        "class": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "group"
                }
              ]
            },
            "value": "MS101",
            "name": "Myndshft Test Group"
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/coverage-class",
                  "code": "plan"
                }
              ]
            },
            "value": "B37FC",
            "name": "commercial insurance co"
          }
        ]
      }
    },
    {
      "fullUrl": "http://myndauth.com/Location/L01",
      "resource": {
        "resourceType": "Location",
        "id": "l01",
        "identifier": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                  "code": "NPI"
                }
              ]
            },
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "989223432"
          }
        ],
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                "code": "CATH",
                "display": "Cardiac catheterization lab"
              }
            ]
          }
        ],
        "status": "active",
        "name": "Banner Health Mes",
        "telecom": [
          {
            "system": "phone",
            "value": "626-441-4888"
          }
        ],
        "address": {
          "line": [
            "1221 W. Higley Road"
          ],
          "city": "Mesa",
          "state": "AZ",
          "postalCode": "85201",
          "country": "US"
        },
        "managingOrganization": {
          "reference": "Organization/o01"
        }
      }
    },
    {
      "fullUrl": "http://myndauth.com/example/Claim/c01",
      "resource": {
        "resourceType": "Claim",
        "id": "c01",
        "status": "active",
        "type": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/claim-type",
              "code": "professional",
              "display": "Professional"
            }
          ]
        },
        "use": "preauthorization",
        "patient": {
          "reference": "Patient/p01"
        },
        "created": "2010-01-04T05:10:13-06:00",
        "provider": {
          "reference": "Practitioner/p01"
        },
        "careTeam": [
          {
            "sequence": 1,
            "provider": {
              "reference": "Practitioner/p02"
            }
          }
        ],
        "facility": {
          "reference": "Location/l01"
        },
        "priority": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/processpriority",
              "code": "normal"
            }
          ]
        },
        "insurance": [
          {
            "sequence": 1,
            "focal": true,
            "coverage": {
              "reference": "Coverage/c01"
            }
          }
        ],
        "diagnosis": [
          {
            "sequence": 1,
            "diagnosisCodeableConcept": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/sid/icd-10-cm",
                  "code": "G83.4",
                  "display": "Cauda equina syndrome"
                }
              ]
            }
          }
        ],
        "item": [
          {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/extension-certificationType",
                "valueCodeableConcept" : {
                  "coding" : [
                    {
                      "system" : "http://codesystem.x12.org/005010/1322",
                      "code" : "I",
                      "display" : "Initial"
                    }
                  ]
                }
              }
            ],
            "sequence": 1,
            "careTeamSequence": [
              1
            ],
            "productOrService": {
              "coding": [
                {
                  "system": "http://www.ama-assn.org/go/cpt",
                  "code": "63030"
                }
              ]
            },
            "servicedDate": "2020-12-31",
            "locationCodeableConcept": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/ex-serviceplace",
                  "code": "11"
                }
              ]
            },
            "quantity": {
              "value": 1,
              "unit": "Unit"
            }
          }
        ]
      }
    }
  ]
}