# UDS Plus Import Manifest - De-Identified, Anonymized FHIR Profiles Library v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **UDS Plus Import Manifest**

## Resource Profile: UDS Plus Import Manifest 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-import-manifest | *Version*:0.1.0 | |
| * Standards status: *[Trial-use](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 1 | *Computable Name*:UDSPlusImportManifest |

 
The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the Manifest for UDS+ import FHIR Operations. 

All canonical (Official) URLs will be changed in the future and are not available currently on the web.

### Introduction

This profile is used to represent the manifest file information that is submitted to the $import operation.

**Representing Health Center Information**

Health Centers have to provide the following information as part of the manifest.

* UEI Number: Unique Entity Identifier (UEI) is a unique number assigned by SAM (System for Awards Management) to all entities who register to do business with the federal government.
* Grant Number: This is comprised of the activity code and the serial number for the particular grant. This number, once assigned does not change for the life of the grant. The activity code which is used to form the static grant number is the activity code which the grant is currently tied to. When a new grant is created, the static Grant Number now gets populated from within the code. Examples of grant numbers include "H80CS##### and LALCS#####" where the [#####] is substituted with the actual value.
* Health Center Contact Person has to be provided with a First and Last Name.
* Health Center Address has to be provided.
* Health Center Contact phone number has to be provided.

**Providing Security Tokens**

A Health Center may wish to make sure that the HRSA Data Receiver provide a security token during the download of the UDS Plus data. In order to facilitate these tokens, the Data Submitter may echo a "security token" of type "bearer" in the manifest file for each UDS Plus file that needs to be downloaded. This bearer token will be echo'ed back by the Data Receiver in the HTTP header during the download process. This further enhances the security protocols between the Data Submitter and the Data Receiver systems.

**Usages:**

* Examples for this Profile: [Parameters/example](Parameters-example.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/hl7.fhir.us.dapl|current/StructureDefinition/uds-plus-import-manifest)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-uds-plus-import-manifest.csv), [Excel](StructureDefinition-uds-plus-import-manifest.xlsx), [Schematron](StructureDefinition-uds-plus-import-manifest.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "uds-plus-import-manifest",
  "meta" : {
    "versionId" : "12",
    "lastUpdated" : "2022-07-12T02:03:11.293+00:00",
    "source" : "#3LDMUQYYwafwTzqK"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "cgp"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/dapl/ImplementationGuide/dapl"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/dapl/ImplementationGuide/dapl"
      }]
    }
  }],
  "url" : "http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-import-manifest",
  "version" : "0.1.0",
  "name" : "UDSPlusImportManifest",
  "title" : "UDS Plus Import Manifest",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-03-16T10:54:28+00:00",
  "publisher" : "HL7 International / Cross Group Projects",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/cgp"
    }]
  }],
  "description" : "The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the Manifest for UDS+ import FHIR Operations.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Parameters",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Parameters",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Parameters",
      "path" : "Parameters",
      "short" : "UDS Plus Import Manifest",
      "definition" : "The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the Manifest for UDS+ import FHIR Operations."
    },
    {
      "id" : "Parameters.parameter",
      "path" : "Parameters.parameter",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "$this.name"
        }],
        "rules" : "open"
      },
      "min" : 2,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:inputFormat",
      "path" : "Parameters.parameter",
      "sliceName" : "inputFormat",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:inputFormat.name",
      "path" : "Parameters.parameter.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "inputFormat",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:inputFormat.value[x]",
      "path" : "Parameters.parameter.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "code"
      }],
      "fixedCode" : "fhir+ndjson",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:submissionId",
      "path" : "Parameters.parameter",
      "sliceName" : "submissionId",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:submissionId.name",
      "path" : "Parameters.parameter.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "submissionId",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:submissionId.value[x]",
      "path" : "Parameters.parameter.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation",
      "path" : "Parameters.parameter",
      "sliceName" : "hcInformation",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.name",
      "path" : "Parameters.parameter.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "hcInformation",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part",
      "path" : "Parameters.parameter.part",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "$this.name"
        }],
        "rules" : "open"
      },
      "min" : 7,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:ueiNumber",
      "path" : "Parameters.parameter.part",
      "sliceName" : "ueiNumber",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:ueiNumber.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "uei",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:ueiNumber.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:grantNumber",
      "path" : "Parameters.parameter.part",
      "sliceName" : "grantNumber",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:grantNumber.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "grantNumber",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:grantNumber.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcName",
      "path" : "Parameters.parameter.part",
      "sliceName" : "hcName",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcName.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "hcName",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcName.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress",
      "path" : "Parameters.parameter.part",
      "sliceName" : "hcAddress",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "hcAddress",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Address"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress.value[x].line",
      "path" : "Parameters.parameter.part.value[x].line",
      "min" : 1,
      "max" : "*",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress.value[x].city",
      "path" : "Parameters.parameter.part.value[x].city",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress.value[x].state",
      "path" : "Parameters.parameter.part.value[x].state",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcAddress.value[x].postalCode",
      "path" : "Parameters.parameter.part.value[x].postalCode",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPerson",
      "path" : "Parameters.parameter.part",
      "sliceName" : "hcContactPerson",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPerson.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "hcContactPerson",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPerson.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "HumanName"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPerson.value[x].family",
      "path" : "Parameters.parameter.part.value[x].family",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPerson.value[x].given",
      "path" : "Parameters.parameter.part.value[x].given",
      "min" : 1,
      "max" : "*",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPhone",
      "path" : "Parameters.parameter.part",
      "sliceName" : "hcContactPhone",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPhone.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "hcContactPhone",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPhone.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "ContactPoint"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system",
      "path" : "Parameters.parameter.part.value[x].system",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "code"
      }],
      "fixedCode" : "phone",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcContactPhone.value[x].value",
      "path" : "Parameters.parameter.part.value[x].value",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcPrenatalCareByReferralOnly",
      "path" : "Parameters.parameter.part",
      "sliceName" : "hcPrenatalCareByReferralOnly",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcPrenatalCareByReferralOnly.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "hcPrenatalCareByReferralOnly",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:hcInformation.part:hcPrenatalCareByReferralOnly.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "boolean"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:importProtocol",
      "path" : "Parameters.parameter",
      "sliceName" : "importProtocol",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:importProtocol.name",
      "path" : "Parameters.parameter.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "importProtocol",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:importProtocol.value[x]",
      "path" : "Parameters.parameter.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "code"
      }],
      "fixedCode" : "https",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData",
      "path" : "Parameters.parameter",
      "sliceName" : "udsData",
      "min" : 0,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.name",
      "path" : "Parameters.parameter.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "udsData",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part",
      "path" : "Parameters.parameter.part",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "$this.name"
        }],
        "rules" : "open"
      },
      "min" : 0,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceType",
      "path" : "Parameters.parameter.part",
      "sliceName" : "resourceType",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceType.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "type",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceType.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "code"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceUrl",
      "path" : "Parameters.parameter.part",
      "sliceName" : "resourceUrl",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceUrl.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "url",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceUrl.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "url"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceUrlExpirationTime",
      "path" : "Parameters.parameter.part",
      "sliceName" : "resourceUrlExpirationTime",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceUrlExpirationTime.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "expirationTime",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:resourceUrlExpirationTime.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "dateTime"
      }],
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:importAccessToken",
      "path" : "Parameters.parameter.part",
      "sliceName" : "importAccessToken",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:importAccessToken.name",
      "path" : "Parameters.parameter.part.name",
      "min" : 1,
      "max" : "1",
      "fixedString" : "bearer",
      "mustSupport" : true
    },
    {
      "id" : "Parameters.parameter:udsData.part:importAccessToken.value[x]",
      "path" : "Parameters.parameter.part.value[x]",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }],
      "mustSupport" : true
    }]
  }
}

```
