ESMD FHIR Implementation Guide
1.0.0 - esmd

ESMD FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: generate-presigned-url - JSON Representation

Active as of 2025-06-11

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "generate-presigned-url",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition generate-presigned-url</b></p><a name=\"generate-presigned-url\"> </a><a name=\"hcgenerate-presigned-url\"> </a><a name=\"generate-presigned-url-en-US\"> </a><p>URL: [base]/DocumentReference/$generate-presigned-url</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>organizationid</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The sender oid requested to upload a file</p>\n</div></td></tr><tr><td>IN</td><td>filenames</td><td/><td>1..*</td><td></td><td/><td><div><p>A list of filenames to generate pre-signed URLs for upload a file</p>\n</div></td></tr><tr><td>IN</td><td>filenames.filename</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>OUT</td><td>presignedUrls</td><td/><td>1..*</td><td></td><td/><td><div><p>A list of pre-signed URLs corresponding to the filenames</p>\n</div></td></tr><tr><td>OUT</td><td>presignedUrls.file</td><td/><td>1..1</td><td></td><td/><td/></tr><tr><td>OUT</td><td>presignedUrls.file.filename</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>OUT</td><td>presignedUrls.file.uploadUrl</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td/></tr><tr><td>OUT</td><td>expiresIn</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Duration\">Duration</a></td><td/><td><div><p>The expiration time of the pre-signed URL in seconds</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://terminology.esmduat.cms.gov:8099/fhir/OperationDefinition/generate-presigned-url",
  "version" : "1.0.0",
  "name" : "GeneratePreSignedUrl",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-06-11T16:31:29-04:00",
  "publisher" : "CMS FHIR esMD",
  "contact" : [
    {
      "name" : "CMS FHIR esMD",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.cms.gov/data-research/computer-data-systems/esmd"
        },
        {
          "system" : "email",
          "value" : "esmd_support@cms.hhs.gov"
        }
      ]
    }
  ],
  "description" : "Operation to generate a pre-signed S3 URL for file upload or download.",
  "code" : "generate-presigned-url",
  "resource" : [
    "DocumentReference"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "organizationid",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The sender oid requested to upload a file",
      "type" : "string"
    },
    {
      "name" : "filenames",
      "use" : "in",
      "min" : 1,
      "max" : "*",
      "documentation" : "A list of filenames to generate pre-signed URLs for upload a file",
      "part" : [
        {
          "name" : "filename",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "type" : "string"
        }
      ]
    },
    {
      "name" : "presignedUrls",
      "use" : "out",
      "min" : 1,
      "max" : "*",
      "documentation" : "A list of pre-signed URLs corresponding to the filenames",
      "part" : [
        {
          "name" : "file",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "part" : [
            {
              "name" : "filename",
              "use" : "out",
              "min" : 1,
              "max" : "1",
              "type" : "string"
            },
            {
              "name" : "uploadUrl",
              "use" : "out",
              "min" : 1,
              "max" : "1",
              "type" : "uri"
            }
          ]
        }
      ]
    },
    {
      "name" : "expiresIn",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The expiration time of the pre-signed URL in seconds",
      "type" : "Duration"
    }
  ]
}