Metriport · JSON-LD Context

Metriport Context

JSON-LD context defining the semantic vocabulary for Metriport from Metriport.

11 Classes 46 Properties 4 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

xsd: http://www.w3.org/2001/XMLSchema#

dcterms: http://purl.org/dc/terms/

metriport: https://metriport.com/schema#

Classes

ConsolidatedQuery DevicesData DocumentReference Progress DocumentQuery Address BaseFacility BasePatient Contact Settings DevicesUser

Properties

Property	Type	Container
requestId	string
status	string
conversionType	string
startedAt	dateTime
metadata
biometrics
activity
body
nutrition
sleep
id	string
fileName	string
description	string
contentType	string
size	integer
indexed	dateTime
total	integer
successful	integer
errors	integer
download	reference
convert	reference
addressLine1	string
addressLine2	string
city	string
state	string
zip	string
country	string
name	string
npi	string
tin	string
active	boolean
address	reference
firstName	string
lastName	string
dob	date
genderAtBirth	string
externalId	string
contact		list
phone	string
email	string
webhookUrl	reference
webhookKey	string
webhookEnabled	boolean
userId	string
appUserId	string
connectedProviders		list

JSON-LD Document

{
  "@context": {
    "@vocab": "https://metriport.com/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "metriport": "https://metriport.com/schema#",
    "ConsolidatedQuery": "metriport:ConsolidatedQuery",
    "requestId": {
      "@id": "metriport:requestId",
      "@type": "xsd:string"
    },
    "status": {
      "@id": "metriport:status",
      "@type": "xsd:string"
    },
    "conversionType": {
      "@id": "metriport:conversionType",
      "@type": "xsd:string"
    },
    "startedAt": {
      "@id": "metriport:startedAt",
      "@type": "xsd:dateTime"
    },
    "DevicesData": "metriport:DevicesData",
    "metadata": {
      "@id": "metriport:metadata"
    },
    "biometrics": {
      "@id": "metriport:biometrics"
    },
    "activity": {
      "@id": "metriport:activity"
    },
    "body": {
      "@id": "metriport:body"
    },
    "nutrition": {
      "@id": "metriport:nutrition"
    },
    "sleep": {
      "@id": "metriport:sleep"
    },
    "DocumentReference": "metriport:DocumentReference",
    "id": {
      "@id": "metriport:id",
      "@type": "xsd:string"
    },
    "fileName": {
      "@id": "metriport:fileName",
      "@type": "xsd:string"
    },
    "description": {
      "@id": "metriport:description",
      "@type": "xsd:string"
    },
    "contentType": {
      "@id": "metriport:contentType",
      "@type": "xsd:string"
    },
    "size": {
      "@id": "metriport:size",
      "@type": "xsd:integer"
    },
    "indexed": {
      "@id": "metriport:indexed",
      "@type": "xsd:dateTime"
    },
    "Progress": "metriport:Progress",
    "total": {
      "@id": "metriport:total",
      "@type": "xsd:integer"
    },
    "successful": {
      "@id": "metriport:successful",
      "@type": "xsd:integer"
    },
    "errors": {
      "@id": "metriport:errors",
      "@type": "xsd:integer"
    },
    "DocumentQuery": "metriport:DocumentQuery",
    "download": {
      "@id": "metriport:download",
      "@type": "@id"
    },
    "convert": {
      "@id": "metriport:convert",
      "@type": "@id"
    },
    "Address": "metriport:Address",
    "addressLine1": {
      "@id": "metriport:addressLine1",
      "@type": "xsd:string"
    },
    "addressLine2": {
      "@id": "metriport:addressLine2",
      "@type": "xsd:string"
    },
    "city": {
      "@id": "metriport:city",
      "@type": "xsd:string"
    },
    "state": {
      "@id": "metriport:state",
      "@type": "xsd:string"
    },
    "zip": {
      "@id": "metriport:zip",
      "@type": "xsd:string"
    },
    "country": {
      "@id": "metriport:country",
      "@type": "xsd:string"
    },
    "BaseFacility": "metriport:BaseFacility",
    "name": {
      "@id": "metriport:name",
      "@type": "xsd:string"
    },
    "npi": {
      "@id": "metriport:npi",
      "@type": "xsd:string"
    },
    "tin": {
      "@id": "metriport:tin",
      "@type": "xsd:string"
    },
    "active": {
      "@id": "metriport:active",
      "@type": "xsd:boolean"
    },
    "address": {
      "@id": "metriport:address",
      "@type": "@id"
    },
    "BasePatient": "metriport:BasePatient",
    "firstName": {
      "@id": "metriport:firstName",
      "@type": "xsd:string"
    },
    "lastName": {
      "@id": "metriport:lastName",
      "@type": "xsd:string"
    },
    "dob": {
      "@id": "metriport:dob",
      "@type": "xsd:date"
    },
    "genderAtBirth": {
      "@id": "metriport:genderAtBirth",
      "@type": "xsd:string"
    },
    "externalId": {
      "@id": "metriport:externalId",
      "@type": "xsd:string"
    },
    "contact": {
      "@id": "metriport:contact",
      "@container": "@list"
    },
    "Contact": "metriport:Contact",
    "phone": {
      "@id": "metriport:phone",
      "@type": "xsd:string"
    },
    "email": {
      "@id": "metriport:email",
      "@type": "xsd:string"
    },
    "Settings": "metriport:Settings",
    "webhookUrl": {
      "@id": "metriport:webhookUrl",
      "@type": "@id"
    },
    "webhookKey": {
      "@id": "metriport:webhookKey",
      "@type": "xsd:string"
    },
    "webhookEnabled": {
      "@id": "metriport:webhookEnabled",
      "@type": "xsd:boolean"
    },
    "DevicesUser": "metriport:DevicesUser",
    "userId": {
      "@id": "metriport:userId",
      "@type": "xsd:string"
    },
    "appUserId": {
      "@id": "metriport:appUserId",
      "@type": "xsd:string"
    },
    "connectedProviders": {
      "@id": "metriport:connectedProviders",
      "@container": "@list"
    }
  },
  "@type": "schema:Dataset",
  "schema:name": "Metriport API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Metriport's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-12) from openapi/metriport-consolidated-api-openapi.yml, openapi/metriport-devices-data-api-openapi.yml, openapi/metriport-document-api-openapi.yml.",
  "dcterms:created": "2026-10-12",
  "dcterms:source": [
    "openapi/metriport-consolidated-api-openapi.yml",
    "openapi/metriport-devices-data-api-openapi.yml",
    "openapi/metriport-document-api-openapi.yml",
    "openapi/metriport-facility-api-openapi.yml",
    "openapi/metriport-patient-api-openapi.yml"
  ]
}