HiMS API Documentation

The Provenance resource that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance

The Provenance resource returns data classes and elements defined for Provenance in United States Core Data for Interoperability (USCDI v2). Examples of API requests to retrieve device data are shown below:

Get Provenances related to a specific patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/Provenance?patient={patientId}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/Provenance?patient=29355
                    

Response schema

{
  "type": "object",
  "required": [],
  "properties": {
    "resourceType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "link": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "relation": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "fullUrl": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "required": [],
            "properties": {
              "resourceType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "meta": {
                "type": "object",
                "required": [],
                "properties": {
                  "versionId": {
                    "type": "string"
                  },
                  "lastUpdated": {
                    "type": "string"
                  },
                  "profile": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "target": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "reference": {
                      "type": "string"
                    }
                  }
                }
              },
              "recorded": {
                "type": "string"
              },
              "agent": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "type": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "coding": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "required": [],
                            "properties": {
                              "system": {
                                "type": "string"
                              },
                              "code": {
                                "type": "string"
                              },
                              "display": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "text": {
                          "type": "string"
                        }
                      }
                    },
                    "who": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "reference": {
                          "type": "string"
                        },
                        "display": {
                          "type": "string"
                        }
                      }
                    },
                    "onBehalfOf": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "reference": {
                          "type": "string"
                        },
                        "display": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}