HRSA 2024 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
2.0.0 - STU2 Release 1 - Standard for Trial-Use

Publication Build: This will be filled in by the publication tooling

## Resource Profile: UDS Plus Import Manifest

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-import-manifest | Version: 2.0.0
Standards status: Trial-use | Maturity Level: 2 | 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.

### 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.

Submitting data for multiple sites and/or EHRs that are part of a Health Center

There are many instances where a Health Center may be using one or more EHR technology and would like to submit data individually from each EHR separately and let HRSA aggregate the data for the Health Center. In addition, some Health Centers report data by sites where services are rendered. The Manifest file submitted to the $import operation provides the following data elements to properly identify these scenarios during the submission.

partialSubmission attribute in Manifest

The partialSubmission attribute should be included in the Manifest file and set to a value of "true" for the following scenarios:

- Health Center will be submitting data from multiple EHRs independent of each other but HRSA has to aggregate the data across the submissions for the final counts.
- Health Center will be submitting data from multiple sites where services are rendered independent of each other but HRSA has to aggregate the data across the submissions for the final counts.

The partialSubmission flag of "true" indicates to HRSA that there will be multiple submissions using the same "grantNumber". After the submission period, HRSA will aggregate the multiple submissions and provide feedback on the submitted data. Health Centers do not have to include this attribute if there is only one submission from the Health Center.

Re-submissions of the data

If a Health Center wishes to resubmit data, then the replaceSubmissionId attribute has to be included and has to contain the previous submissionId which this submission is replacing.

Relationship between partialSubmission and Re-Submission

A submission can be tagged as a partial submission and also as a replacement to a previous submission.

IncrementalData Flag

Sometimes, a submission may have errors with a small set of records in which case, the entire submission need not be resubmitted.The DataSubmitters can submit only the corrected records and indicate to the Data Receiver to replace only the subset of the records. When the incrementalData flag is set, the replaceSubmissionId has to be populated.

The DataReceiver performs the following activities:

- Finds the original submission based on the replaceSubmissionId
- Finds the records using the FHIR Resource Ids.
- Replace the data for the records
- If the records are not found, then the records are added into the submission
- Perform validation of the modified submission and report the success or failures/errors.

NOTE: Incremental submissions will be accepted in the future. It is included in this version of the IG to collect feedback from the vendor community of the approach.

Usage:

- Examples for this Resource Profile: Parameters/example

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | UDS Plus Import Manifest
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for parameter | S Σ C | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:$this.name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:inputFormat | S Σ C | 1..1 | BackboneElement | Parameter used to define the Mime Type of the data contained within the submitted files ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The parameter name for the Mime Type ele-1: All FHIR elements must have a @value or children Fixed Value: inputFormat
value[x] | S Σ C | 1..1 | code | The Mime type of the data contained within the submitted files ele-1: All FHIR elements must have a @value or children Fixed Value: fhir+ndjson
parameter:submissionId | S Σ C | 1..1 | BackboneElement | Parameter to convey the unique submission identifier ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for submission identifier ele-1: All FHIR elements must have a @value or children Fixed Value: submissionId
value[x] | S Σ C | 1..1 | string | Submission Identifier value ele-1: All FHIR elements must have a @value or children
parameter:productInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the product acting as the UDS+ data source actor. ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for submitters to populate the data source name ele-1: All FHIR elements must have a @value or children Fixed Value: productName
value[x] | S Σ C | 1..1 | string | UDS+ Data Source Actor name ele-1: All FHIR elements must have a @value or children
parameter:developerInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the vendor who is providing the UDS+ Data Source system ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for vendor providing the UDS+ Data Source system ele-1: All FHIR elements must have a @value or children Fixed Value: developerName
value[x] | S Σ C | 1..1 | string | The vendor's name who is providing the UDS+ Data Source system ele-1: All FHIR elements must have a @value or children
parameter:submitterEntityInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the entity who is submitting the data on behalf of the health center ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for the entity who is submitting the data on behalf of the health center ele-1: All FHIR elements must have a @value or children Fixed Value: submitterEntityName
value[x] | S Σ C | 1..1 | string | The entity's name who is submitting the data on behalf of the health center ele-1: All FHIR elements must have a @value or children
parameter:submissionTime | S Σ C | 1..1 | BackboneElement | Parameter to convey the submission time of the manifest resource to '$import' operation ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name of the parameter to convey the submission time ele-1: All FHIR elements must have a @value or children Fixed Value: submissionTime
value[x] | S Σ C | 1..1 | dateTime | Submission Time value ele-1: All FHIR elements must have a @value or children
parameter:replaceSubmissionId | S Σ C | 0..1 | BackboneElement | Parameer to identify the previous submission data that needs to be replaced with this submission ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name of the parameter to convey the submission that needs to be replaced ele-1: All FHIR elements must have a @value or children Fixed Value: replaceSubmissionId
value[x] | S Σ C | 1..1 | string | Actual value of the previous submission that needs to be replaced ele-1: All FHIR elements must have a @value or children
parameter:partialSubmission | S Σ C | 0..1 | BackboneElement | Parameter to indicate if the submission has to be treated as a partial submission for the Health Center ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name to indicate that this ia a partial submission ele-1: All FHIR elements must have a @value or children Fixed Value: partialSubmission
value[x] | S Σ C | 1..1 | boolean | Actual value indicating if this is a partial submission ele-1: All FHIR elements must have a @value or children
parameter:partialSubmissionName | S Σ C | 0..1 | BackboneElement | Parameter that can be used by the Health Center to identify the partial submission, for e.g EHR product name or site name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name to convey the partial submission name ele-1: All FHIR elements must have a @value or children Fixed Value: partialSubmissionName
value[x] | S Σ C | 1..1 | string | Actual partial submission name ele-1: All FHIR elements must have a @value or children
parameter:hcInformation | S Σ C | 1..1 | BackboneElement | Parameters to convey the Health Center information ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Parameter that holds the Health Center information ele-1: All FHIR elements must have a @value or children Fixed Value: hcInformation
Slices for part | S Σ | 7..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name ele-1: All FHIR elements must have a @value or children
part:ueiNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the UEI number for the Health Center ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Parameter that indicates this is an UEI number ele-1: All FHIR elements must have a @value or children Fixed Value: uei
value[x] | S Σ C | 1..1 | string | Actual UEI value ele-1: All FHIR elements must have a @value or children
part:grantNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: grantNumber
value[x] | S Σ C | 1..1 | string | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:hcName | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcName
value[x] | S Σ C | 1..1 | string | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:hcAddress | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcAddress
value[x] | S Σ C | 1..1 | Address | If parameter is a data type ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line | S Σ | 1..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 1..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children
postalCode | S Σ | 1..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132
part:hcContactPerson | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcContactPerson
value[x] | S Σ C | 1..1 | HumanName | If parameter is a data type ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family | S Σ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given | S Σ | 1..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
part:hcContactPhone | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcContactPhone
value[x] | S Σ C | 1..1 | ContactPoint | If parameter is a data type ele-1: All FHIR elements must have a @value or children
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
part:hcPrenatalCareByReferralOnly | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcPrenatalCareByReferralOnly
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type ele-1: All FHIR elements must have a @value or children
parameter:importProtocol | S Σ C | 1..1 | BackboneElement | Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: importProtocol
value[x] | S Σ C | 1..1 | code | If parameter is a data type ele-1: All FHIR elements must have a @value or children Fixed Value: https
parameter:udsData | S Σ C | 1..* | BackboneElement | Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: udsData
Slices for part | S Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name ele-1: All FHIR elements must have a @value or children
part:resourceType | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: type
value[x] | S Σ C | 1..1 | code | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:resourceUrl | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: url
value[x] | S Σ C | 1..1 | url | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:resourceUrlExpirationTime | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: expirationTime
value[x] | S Σ C | 1..1 | dateTime | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:importAccessToken | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: bearer
value[x] | S Σ C | 1..1 | string | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:incrementalData | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: incrementalData
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-1 | error | Parameters.parameter, Parameters.parameter:inputFormat, Parameters.parameter:submissionId, Parameters.parameter:productInformation, Parameters.parameter:developerInformation, Parameters.parameter:submitterEntityInformation, Parameters.parameter:submissionTime, Parameters.parameter:replaceSubmissionId, Parameters.parameter:partialSubmission, Parameters.parameter:partialSubmissionName, Parameters.parameter:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsData | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | UDS Plus Import Manifest
Slices for parameter | S | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:$this.name
parameter:inputFormat | S | 1..1 | BackboneElement | Parameter used to define the Mime Type of the data contained within the submitted files
name | S | 1..1 | string | The parameter name for the Mime Type Fixed Value: inputFormat
value[x] | S | 1..1 | code | The Mime type of the data contained within the submitted files Fixed Value: fhir+ndjson
parameter:submissionId | S | 1..1 | BackboneElement | Parameter to convey the unique submission identifier
name | S | 1..1 | string | The Parameter name for submission identifier Fixed Value: submissionId
value[x] | S | 1..1 | string | Submission Identifier value
parameter:productInformation | S | 0..1 | BackboneElement | Parameter to convey the product acting as the UDS+ data source actor.
name | S | 1..1 | string | The Parameter name for submitters to populate the data source name Fixed Value: productName
value[x] | S | 1..1 | string | UDS+ Data Source Actor name
parameter:developerInformation | S | 0..1 | BackboneElement | Parameter to convey the vendor who is providing the UDS+ Data Source system
name | S | 1..1 | string | The Parameter name for vendor providing the UDS+ Data Source system Fixed Value: developerName
value[x] | S | 1..1 | string | The vendor's name who is providing the UDS+ Data Source system
parameter:submitterEntityInformation | S | 0..1 | BackboneElement | Parameter to convey the entity who is submitting the data on behalf of the health center
name | S | 1..1 | string | The Parameter name for the entity who is submitting the data on behalf of the health center Fixed Value: submitterEntityName
value[x] | S | 1..1 | string | The entity's name who is submitting the data on behalf of the health center
parameter:submissionTime | S | 1..1 | BackboneElement | Parameter to convey the submission time of the manifest resource to '$import' operation
name | S | 1..1 | string | Name of the parameter to convey the submission time Fixed Value: submissionTime
value[x] | S | 1..1 | dateTime | Submission Time value
parameter:replaceSubmissionId | S | 0..1 | BackboneElement | Parameer to identify the previous submission data that needs to be replaced with this submission
name | S | 1..1 | string | Name of the parameter to convey the submission that needs to be replaced Fixed Value: replaceSubmissionId
value[x] | S | 1..1 | string | Actual value of the previous submission that needs to be replaced
parameter:partialSubmission | S | 0..1 | BackboneElement | Parameter to indicate if the submission has to be treated as a partial submission for the Health Center
name | S | 1..1 | string | The Parameter name to indicate that this ia a partial submission Fixed Value: partialSubmission
value[x] | S | 1..1 | boolean | Actual value indicating if this is a partial submission
parameter:partialSubmissionName | S | 0..1 | BackboneElement | Parameter that can be used by the Health Center to identify the partial submission, for e.g EHR product name or site name
name | S | 1..1 | string | The Parameter name to convey the partial submission name Fixed Value: partialSubmissionName
value[x] | S | 1..1 | string | Actual partial submission name
parameter:hcInformation | S | 1..1 | BackboneElement | Parameters to convey the Health Center information
name | S | 1..1 | string | Parameter that holds the Health Center information Fixed Value: hcInformation
Slices for part | S | 7..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:ueiNumber | S | 1..1 | BackboneElement | Parameter to convey the UEI number for the Health Center
name | S | 1..1 | string | Parameter that indicates this is an UEI number Fixed Value: uei
value[x] | S | 1..1 | string | Actual UEI value
part:grantNumber | S | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center
name | S | 1..1 | string | Name from the definition Fixed Value: grantNumber
value[x] | S | 1..1 | string | If parameter is a data type
part:hcName | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcName
value[x] | S | 1..1 | string | If parameter is a data type
part:hcAddress | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcAddress
value[x] | S | 1..1 | Address | If parameter is a data type
line | S | 1..* | string | Street name, number, direction & P.O. Box etc.
city | S | 1..1 | string | Name of city, town etc.
state | S | 1..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S | 1..1 | string | Postal code for area
part:hcContactPerson | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcContactPerson
value[x] | S | 1..1 | HumanName | If parameter is a data type
family | S | 1..1 | string | Family name (often called 'Surname')
given | S | 1..* | string | Given names (not always 'first'). Includes middle names
part:hcContactPhone | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcContactPhone
value[x] | S | 1..1 | ContactPoint | If parameter is a data type
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone
value | S | 1..1 | string | The actual contact point details
part:hcPrenatalCareByReferralOnly | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcPrenatalCareByReferralOnly
value[x] | S | 1..1 | boolean | If parameter is a data type
parameter:importProtocol | S | 1..1 | BackboneElement | Operation Parameter
name | S | 1..1 | string | Name from the definition Fixed Value: importProtocol
value[x] | S | 1..1 | code | If parameter is a data type Fixed Value: https
parameter:udsData | S | 1..* | BackboneElement | Operation Parameter
name | S | 1..1 | string | Name from the definition Fixed Value: udsData
Slices for part | S | 0..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:resourceType | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: type
value[x] | S | 1..1 | code | If parameter is a data type
part:resourceUrl | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: url
value[x] | S | 1..1 | url | If parameter is a data type
part:resourceUrlExpirationTime | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: expirationTime
value[x] | S | 1..1 | dateTime | If parameter is a data type
part:importAccessToken | S | 0..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: bearer
value[x] | S | 1..1 | string | If parameter is a data type
part:incrementalData | S | 0..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: incrementalData
value[x] | S | 1..1 | boolean | If parameter is a data type
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | UDS Plus Import Manifest
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Slices for parameter | S Σ C | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:$this.name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Name from the definition
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:inputFormat | S Σ C | 1..1 | BackboneElement | Parameter used to define the Mime Type of the data contained within the submitted files inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The parameter name for the Mime Type Fixed Value: inputFormat
value[x] | S Σ C | 1..1 | code | The Mime type of the data contained within the submitted files Fixed Value: fhir+ndjson
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:submissionId | S Σ C | 1..1 | BackboneElement | Parameter to convey the unique submission identifier inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for submission identifier Fixed Value: submissionId
value[x] | S Σ C | 1..1 | string | Submission Identifier value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:productInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the product acting as the UDS+ data source actor. inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for submitters to populate the data source name Fixed Value: productName
value[x] | S Σ C | 1..1 | string | UDS+ Data Source Actor name
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:developerInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the vendor who is providing the UDS+ Data Source system inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for vendor providing the UDS+ Data Source system Fixed Value: developerName
value[x] | S Σ C | 1..1 | string | The vendor's name who is providing the UDS+ Data Source system
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:submitterEntityInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the entity who is submitting the data on behalf of the health center inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for the entity who is submitting the data on behalf of the health center Fixed Value: submitterEntityName
value[x] | S Σ C | 1..1 | string | The entity's name who is submitting the data on behalf of the health center
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:submissionTime | S Σ C | 1..1 | BackboneElement | Parameter to convey the submission time of the manifest resource to '$import' operation inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name of the parameter to convey the submission time Fixed Value: submissionTime
value[x] | S Σ C | 1..1 | dateTime | Submission Time value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:replaceSubmissionId | S Σ C | 0..1 | BackboneElement | Parameer to identify the previous submission data that needs to be replaced with this submission inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name of the parameter to convey the submission that needs to be replaced Fixed Value: replaceSubmissionId
value[x] | S Σ C | 1..1 | string | Actual value of the previous submission that needs to be replaced
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:partialSubmission | S Σ C | 0..1 | BackboneElement | Parameter to indicate if the submission has to be treated as a partial submission for the Health Center inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name to indicate that this ia a partial submission Fixed Value: partialSubmission
value[x] | S Σ C | 1..1 | boolean | Actual value indicating if this is a partial submission
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:partialSubmissionName | S Σ C | 0..1 | BackboneElement | Parameter that can be used by the Health Center to identify the partial submission, for e.g EHR product name or site name inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name to convey the partial submission name Fixed Value: partialSubmissionName
value[x] | S Σ C | 1..1 | string | Actual partial submission name
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:hcInformation | S Σ C | 1..1 | BackboneElement | Parameters to convey the Health Center information inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Parameter that holds the Health Center information Fixed Value: hcInformation
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | S Σ | 7..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:ueiNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the UEI number for the Health Center
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Parameter that indicates this is an UEI number Fixed Value: uei
value[x] | S Σ C | 1..1 | string | Actual UEI value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:grantNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: grantNumber
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcName | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcName
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcAddress | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcAddress
value[x] | S Σ C | 1..1 | Address | If parameter is a data type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Σ | 1..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcContactPerson | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcContactPerson
value[x] | S Σ C | 1..1 | HumanName | If parameter is a data type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcContactPhone | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcContactPhone
value[x] | S Σ C | 1..1 | ContactPoint | If parameter is a data type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcPrenatalCareByReferralOnly | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcPrenatalCareByReferralOnly
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:importProtocol | S Σ C | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: importProtocol
value[x] | S Σ C | 1..1 | code | If parameter is a data type Fixed Value: https
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:udsData | S Σ C | 1..* | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: udsData
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | S Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:resourceType | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: type
value[x] | S Σ C | 1..1 | code | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:resourceUrl | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: url
value[x] | S Σ C | 1..1 | url | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:resourceUrlExpirationTime | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: expirationTime
value[x] | S Σ C | 1..1 | dateTime | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:importAccessToken | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: bearer
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:incrementalData | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: incrementalData
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Parameters.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcAddress.value[x].type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-1 | error | Parameters.parameter, Parameters.parameter:inputFormat, Parameters.parameter:submissionId, Parameters.parameter:productInformation, Parameters.parameter:developerInformation, Parameters.parameter:submitterEntityInformation, Parameters.parameter:submissionTime, Parameters.parameter:replaceSubmissionId, Parameters.parameter:partialSubmission, Parameters.parameter:partialSubmissionName, Parameters.parameter:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsData | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |

This structure is derived from Parameters

Summary

Mandatory: 54 elements(16 nested mandatory elements)
Must-Support: 81 elements
Fixed: 27 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter
- The element 1 is sliced based on the value of Parameters.parameter.part

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | UDS Plus Import Manifest
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for parameter | S Σ C | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:$this.name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children
parameter:inputFormat | S Σ C | 1..1 | BackboneElement | Parameter used to define the Mime Type of the data contained within the submitted files ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The parameter name for the Mime Type ele-1: All FHIR elements must have a @value or children Fixed Value: inputFormat
value[x] | S Σ C | 1..1 | code | The Mime type of the data contained within the submitted files ele-1: All FHIR elements must have a @value or children Fixed Value: fhir+ndjson
parameter:submissionId | S Σ C | 1..1 | BackboneElement | Parameter to convey the unique submission identifier ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for submission identifier ele-1: All FHIR elements must have a @value or children Fixed Value: submissionId
value[x] | S Σ C | 1..1 | string | Submission Identifier value ele-1: All FHIR elements must have a @value or children
parameter:productInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the product acting as the UDS+ data source actor. ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for submitters to populate the data source name ele-1: All FHIR elements must have a @value or children Fixed Value: productName
value[x] | S Σ C | 1..1 | string | UDS+ Data Source Actor name ele-1: All FHIR elements must have a @value or children
parameter:developerInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the vendor who is providing the UDS+ Data Source system ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for vendor providing the UDS+ Data Source system ele-1: All FHIR elements must have a @value or children Fixed Value: developerName
value[x] | S Σ C | 1..1 | string | The vendor's name who is providing the UDS+ Data Source system ele-1: All FHIR elements must have a @value or children
parameter:submitterEntityInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the entity who is submitting the data on behalf of the health center ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name for the entity who is submitting the data on behalf of the health center ele-1: All FHIR elements must have a @value or children Fixed Value: submitterEntityName
value[x] | S Σ C | 1..1 | string | The entity's name who is submitting the data on behalf of the health center ele-1: All FHIR elements must have a @value or children
parameter:submissionTime | S Σ C | 1..1 | BackboneElement | Parameter to convey the submission time of the manifest resource to '$import' operation ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name of the parameter to convey the submission time ele-1: All FHIR elements must have a @value or children Fixed Value: submissionTime
value[x] | S Σ C | 1..1 | dateTime | Submission Time value ele-1: All FHIR elements must have a @value or children
parameter:replaceSubmissionId | S Σ C | 0..1 | BackboneElement | Parameer to identify the previous submission data that needs to be replaced with this submission ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name of the parameter to convey the submission that needs to be replaced ele-1: All FHIR elements must have a @value or children Fixed Value: replaceSubmissionId
value[x] | S Σ C | 1..1 | string | Actual value of the previous submission that needs to be replaced ele-1: All FHIR elements must have a @value or children
parameter:partialSubmission | S Σ C | 0..1 | BackboneElement | Parameter to indicate if the submission has to be treated as a partial submission for the Health Center ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name to indicate that this ia a partial submission ele-1: All FHIR elements must have a @value or children Fixed Value: partialSubmission
value[x] | S Σ C | 1..1 | boolean | Actual value indicating if this is a partial submission ele-1: All FHIR elements must have a @value or children
parameter:partialSubmissionName | S Σ C | 0..1 | BackboneElement | Parameter that can be used by the Health Center to identify the partial submission, for e.g EHR product name or site name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | The Parameter name to convey the partial submission name ele-1: All FHIR elements must have a @value or children Fixed Value: partialSubmissionName
value[x] | S Σ C | 1..1 | string | Actual partial submission name ele-1: All FHIR elements must have a @value or children
parameter:hcInformation | S Σ C | 1..1 | BackboneElement | Parameters to convey the Health Center information ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Parameter that holds the Health Center information ele-1: All FHIR elements must have a @value or children Fixed Value: hcInformation
Slices for part | S Σ | 7..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name ele-1: All FHIR elements must have a @value or children
part:ueiNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the UEI number for the Health Center ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Parameter that indicates this is an UEI number ele-1: All FHIR elements must have a @value or children Fixed Value: uei
value[x] | S Σ C | 1..1 | string | Actual UEI value ele-1: All FHIR elements must have a @value or children
part:grantNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: grantNumber
value[x] | S Σ C | 1..1 | string | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:hcName | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcName
value[x] | S Σ C | 1..1 | string | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:hcAddress | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcAddress
value[x] | S Σ C | 1..1 | Address | If parameter is a data type ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line | S Σ | 1..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 1..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children
postalCode | S Σ | 1..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example General: 9132
part:hcContactPerson | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcContactPerson
value[x] | S Σ C | 1..1 | HumanName | If parameter is a data type ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family | S Σ | 1..1 | string | Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given | S Σ | 1..* | string | Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
part:hcContactPhone | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcContactPhone
value[x] | S Σ C | 1..1 | ContactPoint | If parameter is a data type ele-1: All FHIR elements must have a @value or children
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
part:hcPrenatalCareByReferralOnly | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: hcPrenatalCareByReferralOnly
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type ele-1: All FHIR elements must have a @value or children
parameter:importProtocol | S Σ C | 1..1 | BackboneElement | Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: importProtocol
value[x] | S Σ C | 1..1 | code | If parameter is a data type ele-1: All FHIR elements must have a @value or children Fixed Value: https
parameter:udsData | S Σ C | 1..* | BackboneElement | Operation Parameter ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: udsData
Slices for part | S Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name ele-1: All FHIR elements must have a @value or children
part:resourceType | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: type
value[x] | S Σ C | 1..1 | code | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:resourceUrl | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: url
value[x] | S Σ C | 1..1 | url | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:resourceUrlExpirationTime | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: expirationTime
value[x] | S Σ C | 1..1 | dateTime | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:importAccessToken | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: bearer
value[x] | S Σ C | 1..1 | string | If parameter is a data type ele-1: All FHIR elements must have a @value or children
part:incrementalData | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name | S Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Fixed Value: incrementalData
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-1 | error | Parameters.parameter, Parameters.parameter:inputFormat, Parameters.parameter:submissionId, Parameters.parameter:productInformation, Parameters.parameter:developerInformation, Parameters.parameter:submitterEntityInformation, Parameters.parameter:submissionTime, Parameters.parameter:replaceSubmissionId, Parameters.parameter:partialSubmission, Parameters.parameter:partialSubmissionName, Parameters.parameter:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsData | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |

Differential View

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | UDS Plus Import Manifest
Slices for parameter | S | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:$this.name
parameter:inputFormat | S | 1..1 | BackboneElement | Parameter used to define the Mime Type of the data contained within the submitted files
name | S | 1..1 | string | The parameter name for the Mime Type Fixed Value: inputFormat
value[x] | S | 1..1 | code | The Mime type of the data contained within the submitted files Fixed Value: fhir+ndjson
parameter:submissionId | S | 1..1 | BackboneElement | Parameter to convey the unique submission identifier
name | S | 1..1 | string | The Parameter name for submission identifier Fixed Value: submissionId
value[x] | S | 1..1 | string | Submission Identifier value
parameter:productInformation | S | 0..1 | BackboneElement | Parameter to convey the product acting as the UDS+ data source actor.
name | S | 1..1 | string | The Parameter name for submitters to populate the data source name Fixed Value: productName
value[x] | S | 1..1 | string | UDS+ Data Source Actor name
parameter:developerInformation | S | 0..1 | BackboneElement | Parameter to convey the vendor who is providing the UDS+ Data Source system
name | S | 1..1 | string | The Parameter name for vendor providing the UDS+ Data Source system Fixed Value: developerName
value[x] | S | 1..1 | string | The vendor's name who is providing the UDS+ Data Source system
parameter:submitterEntityInformation | S | 0..1 | BackboneElement | Parameter to convey the entity who is submitting the data on behalf of the health center
name | S | 1..1 | string | The Parameter name for the entity who is submitting the data on behalf of the health center Fixed Value: submitterEntityName
value[x] | S | 1..1 | string | The entity's name who is submitting the data on behalf of the health center
parameter:submissionTime | S | 1..1 | BackboneElement | Parameter to convey the submission time of the manifest resource to '$import' operation
name | S | 1..1 | string | Name of the parameter to convey the submission time Fixed Value: submissionTime
value[x] | S | 1..1 | dateTime | Submission Time value
parameter:replaceSubmissionId | S | 0..1 | BackboneElement | Parameer to identify the previous submission data that needs to be replaced with this submission
name | S | 1..1 | string | Name of the parameter to convey the submission that needs to be replaced Fixed Value: replaceSubmissionId
value[x] | S | 1..1 | string | Actual value of the previous submission that needs to be replaced
parameter:partialSubmission | S | 0..1 | BackboneElement | Parameter to indicate if the submission has to be treated as a partial submission for the Health Center
name | S | 1..1 | string | The Parameter name to indicate that this ia a partial submission Fixed Value: partialSubmission
value[x] | S | 1..1 | boolean | Actual value indicating if this is a partial submission
parameter:partialSubmissionName | S | 0..1 | BackboneElement | Parameter that can be used by the Health Center to identify the partial submission, for e.g EHR product name or site name
name | S | 1..1 | string | The Parameter name to convey the partial submission name Fixed Value: partialSubmissionName
value[x] | S | 1..1 | string | Actual partial submission name
parameter:hcInformation | S | 1..1 | BackboneElement | Parameters to convey the Health Center information
name | S | 1..1 | string | Parameter that holds the Health Center information Fixed Value: hcInformation
Slices for part | S | 7..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:ueiNumber | S | 1..1 | BackboneElement | Parameter to convey the UEI number for the Health Center
name | S | 1..1 | string | Parameter that indicates this is an UEI number Fixed Value: uei
value[x] | S | 1..1 | string | Actual UEI value
part:grantNumber | S | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center
name | S | 1..1 | string | Name from the definition Fixed Value: grantNumber
value[x] | S | 1..1 | string | If parameter is a data type
part:hcName | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcName
value[x] | S | 1..1 | string | If parameter is a data type
part:hcAddress | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcAddress
value[x] | S | 1..1 | Address | If parameter is a data type
line | S | 1..* | string | Street name, number, direction & P.O. Box etc.
city | S | 1..1 | string | Name of city, town etc.
state | S | 1..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S | 1..1 | string | Postal code for area
part:hcContactPerson | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcContactPerson
value[x] | S | 1..1 | HumanName | If parameter is a data type
family | S | 1..1 | string | Family name (often called 'Surname')
given | S | 1..* | string | Given names (not always 'first'). Includes middle names
part:hcContactPhone | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcContactPhone
value[x] | S | 1..1 | ContactPoint | If parameter is a data type
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: phone
value | S | 1..1 | string | The actual contact point details
part:hcPrenatalCareByReferralOnly | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: hcPrenatalCareByReferralOnly
value[x] | S | 1..1 | boolean | If parameter is a data type
parameter:importProtocol | S | 1..1 | BackboneElement | Operation Parameter
name | S | 1..1 | string | Name from the definition Fixed Value: importProtocol
value[x] | S | 1..1 | code | If parameter is a data type Fixed Value: https
parameter:udsData | S | 1..* | BackboneElement | Operation Parameter
name | S | 1..1 | string | Name from the definition Fixed Value: udsData
Slices for part | S | 0..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:resourceType | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: type
value[x] | S | 1..1 | code | If parameter is a data type
part:resourceUrl | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: url
value[x] | S | 1..1 | url | If parameter is a data type
part:resourceUrlExpirationTime | S | 1..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: expirationTime
value[x] | S | 1..1 | dateTime | If parameter is a data type
part:importAccessToken | S | 0..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: bearer
value[x] | S | 1..1 | string | If parameter is a data type
part:incrementalData | S | 0..1 | BackboneElement | Named part of a multi-part parameter
name | S | 1..1 | string | Name from the definition Fixed Value: incrementalData
value[x] | S | 1..1 | boolean | If parameter is a data type
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Parameters |  | 0..* | Parameters | UDS Plus Import Manifest
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Slices for parameter | S Σ C | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:$this.name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | Name from the definition
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:inputFormat | S Σ C | 1..1 | BackboneElement | Parameter used to define the Mime Type of the data contained within the submitted files inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The parameter name for the Mime Type Fixed Value: inputFormat
value[x] | S Σ C | 1..1 | code | The Mime type of the data contained within the submitted files Fixed Value: fhir+ndjson
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:submissionId | S Σ C | 1..1 | BackboneElement | Parameter to convey the unique submission identifier inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for submission identifier Fixed Value: submissionId
value[x] | S Σ C | 1..1 | string | Submission Identifier value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:productInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the product acting as the UDS+ data source actor. inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for submitters to populate the data source name Fixed Value: productName
value[x] | S Σ C | 1..1 | string | UDS+ Data Source Actor name
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:developerInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the vendor who is providing the UDS+ Data Source system inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for vendor providing the UDS+ Data Source system Fixed Value: developerName
value[x] | S Σ C | 1..1 | string | The vendor's name who is providing the UDS+ Data Source system
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:submitterEntityInformation | S Σ C | 0..1 | BackboneElement | Parameter to convey the entity who is submitting the data on behalf of the health center inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name for the entity who is submitting the data on behalf of the health center Fixed Value: submitterEntityName
value[x] | S Σ C | 1..1 | string | The entity's name who is submitting the data on behalf of the health center
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:submissionTime | S Σ C | 1..1 | BackboneElement | Parameter to convey the submission time of the manifest resource to '$import' operation inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name of the parameter to convey the submission time Fixed Value: submissionTime
value[x] | S Σ C | 1..1 | dateTime | Submission Time value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:replaceSubmissionId | S Σ C | 0..1 | BackboneElement | Parameer to identify the previous submission data that needs to be replaced with this submission inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name of the parameter to convey the submission that needs to be replaced Fixed Value: replaceSubmissionId
value[x] | S Σ C | 1..1 | string | Actual value of the previous submission that needs to be replaced
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:partialSubmission | S Σ C | 0..1 | BackboneElement | Parameter to indicate if the submission has to be treated as a partial submission for the Health Center inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name to indicate that this ia a partial submission Fixed Value: partialSubmission
value[x] | S Σ C | 1..1 | boolean | Actual value indicating if this is a partial submission
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:partialSubmissionName | S Σ C | 0..1 | BackboneElement | Parameter that can be used by the Health Center to identify the partial submission, for e.g EHR product name or site name inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | The Parameter name to convey the partial submission name Fixed Value: partialSubmissionName
value[x] | S Σ C | 1..1 | string | Actual partial submission name
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:hcInformation | S Σ C | 1..1 | BackboneElement | Parameters to convey the Health Center information inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Parameter that holds the Health Center information Fixed Value: hcInformation
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | S Σ | 7..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:ueiNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the UEI number for the Health Center
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Parameter that indicates this is an UEI number Fixed Value: uei
value[x] | S Σ C | 1..1 | string | Actual UEI value
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:grantNumber | S Σ | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: grantNumber
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcName | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcName
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcAddress | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcAddress
value[x] | S Σ C | 1..1 | Address | If parameter is a data type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line | S Σ | 1..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city | S Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | S Σ | 1..1 | string | Sub-unit of country (abbreviations ok)
postalCode | S Σ | 1..1 | string | Postal code for area Example General: 9132
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcContactPerson | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcContactPerson
value[x] | S Σ C | 1..1 | HumanName | If parameter is a data type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text | Σ | 0..1 | string | Text representation of the full name
family | S Σ | 1..1 | string | Family name (often called 'Surname')
given | S Σ | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period | Σ | 0..1 | Period | Time period when name was/is in use
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcContactPhone | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcContactPhone
value[x] | S Σ C | 1..1 | ContactPoint | If parameter is a data type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:hcPrenatalCareByReferralOnly | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: hcPrenatalCareByReferralOnly
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:importProtocol | S Σ C | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: importProtocol
value[x] | S Σ C | 1..1 | code | If parameter is a data type Fixed Value: https
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
parameter:udsData | S Σ C | 1..* | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: udsData
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | S Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name
part:resourceType | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: type
value[x] | S Σ C | 1..1 | code | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:resourceUrl | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: url
value[x] | S Σ C | 1..1 | url | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:resourceUrlExpirationTime | S Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: expirationTime
value[x] | S Σ C | 1..1 | dateTime | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:importAccessToken | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: bearer
value[x] | S Σ C | 1..1 | string | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:incrementalData | S Σ | 0..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ | 1..1 | string | Name from the definition Fixed Value: incrementalData
value[x] | S Σ C | 1..1 | boolean | If parameter is a data type
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Parameters.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUse `http://hl7.org/fhir/ValueSet/address-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcAddress.value[x].type | required | AddressType `http://hl7.org/fhir/ValueSet/address-type|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUse `http://hl7.org/fhir/ValueSet/name-use|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phone `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` from the FHIR Standard
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
inv-1 | error | Parameters.parameter, Parameters.parameter:inputFormat, Parameters.parameter:submissionId, Parameters.parameter:productInformation, Parameters.parameter:developerInformation, Parameters.parameter:submitterEntityInformation, Parameters.parameter:submissionTime, Parameters.parameter:replaceSubmissionId, Parameters.parameter:partialSubmission, Parameters.parameter:partialSubmissionName, Parameters.parameter:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsData | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |

This structure is derived from Parameters

Summary

Mandatory: 54 elements(16 nested mandatory elements)
Must-Support: 81 elements
Fixed: 27 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter
- The element 1 is sliced based on the value of Parameters.parameter.part

Maturity: 2

Other representations of profile: CSV, Excel, Schematron