HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.1.0 - STU1 Release 1.1 - Standard for Trial-Use
HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG, published by HRSA BPHC. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/drajer-health/uds-plus/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-import-manifest | Version: 1.1.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.
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.
The following is new content for 1.1.0
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:
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:
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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: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 | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
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 | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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 |
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 |
part:grantNumber | SΣ | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center |
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 |
part:hcName | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:hcAddress | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
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 |
state | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | SΣ | 1..1 | string | Postal code for area Example General: 9132 |
part:hcContactPerson | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human 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 |
part:hcContactPhone | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
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. |
part:hcPrenatalCareByReferralOnly | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
parameter:importProtocol | SΣC | 1..1 | BackboneElement | Operation Parameter 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 |
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 |
parameter:udsData | SΣC | 1..* | BackboneElement | Operation Parameter 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 |
name | SΣ | 1..1 | string | Name from the definition 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 |
part:resourceType | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:resourceUrl | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:resourceUrlExpirationTime | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:importAccessToken | SΣ | 0..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:incrementalData | SΣ | 0..1 | BackboneElement | Named part of a multi-part parameter |
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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
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: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())) |
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.
| |||||
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: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 |
Path | Conformance | ValueSet / Code | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcAddress.value[x].type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
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: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(10 nested mandatory elements)
Must-Support: 72 elements
Fixed: 24 elements
Slices
This structure defines the following Slices:
Maturity: 2
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: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 |
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 |
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 | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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) |
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 |
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 |
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 |
part:grantNumber | SΣ | 1..1 | BackboneElement | Parameter to convey the GRANT number of the Health Center |
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 |
part:hcName | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:hcAddress | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
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 |
state | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | SΣ | 1..1 | string | Postal code for area Example General: 9132 |
part:hcContactPerson | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human 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 |
part:hcContactPhone | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
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. |
part:hcPrenatalCareByReferralOnly | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
parameter:importProtocol | SΣC | 1..1 | BackboneElement | Operation Parameter 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 |
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 |
parameter:udsData | SΣC | 1..* | BackboneElement | Operation Parameter 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 |
name | SΣ | 1..1 | string | Name from the definition 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 |
part:resourceType | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:resourceUrl | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:resourceUrlExpirationTime | SΣ | 1..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:importAccessToken | SΣ | 0..1 | BackboneElement | Named part of a multi-part parameter |
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 |
part:incrementalData | SΣ | 0..1 | BackboneElement | Named part of a multi-part parameter |
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 |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | |
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
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: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())) |
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.
| |||||
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: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 |
Path | Conformance | ValueSet / Code | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcAddress.value[x].use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcAddress.value[x].type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].system | required | Fixed Value: phonehttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard |
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: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(10 nested mandatory elements)
Must-Support: 72 elements
Fixed: 24 elements
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron