HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.0.0 - STU1 Release 1 - Standard for Trial-Use International flag

HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: UDS Plus Import Manifest

Official URL: http://hl7.org/fhir/us/uds-plus/StructureDefinition/uds-plus-import-manifest Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: UDSPlusImportManifest

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

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

Introduction

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

Representing Health Center Information

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

  • UEI Number: Unique Entity Identifier (UEI) is a unique number assigned by SAM (System for Awards Management) to all entities who register to do business with the federal government.

  • Grant Number: This is comprised of the activity code and the serial number for the particular grant. This number, once assigned does not change for the life of the grant. The activity code which is used to form the static grant number is the activity code which the grant is currently tied to. When a new grant is created, the static Grant Number now gets populated from within the code. Examples of grant numbers include “H80CS##### and LALCS#####” where the [#####] is substituted with the actual value.

  • Health Center Contact Person has to be provided with a First and Last Name.

  • Health Center Address has to be provided.

  • Health Center Contact phone number has to be provided.

Providing Security Tokens

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus Import Manifest
... Slices for parameter S2..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:inputFormat S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: inputFormat
..... value[x] S1..1codeIf parameter is a data type
Fixed Value: fhir+ndjson
.... parameter:submissionId S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: submissionId
..... value[x] S1..1stringIf parameter is a data type
.... parameter:hcInformation S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: hcInformation
..... Slices for part S7..*Named part of a multi-part parameter
Slice: Unordered, Open by value:$this.name
...... part:ueiNumber S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: uei
....... value[x] S1..1stringIf parameter is a data type
...... part:grantNumber S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: grantNumber
....... value[x] S1..1stringIf parameter is a data type
...... part:hcName S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: hcName
....... value[x] S1..1stringIf parameter is a data type
...... part:hcAddress S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: hcAddress
....... value[x] S1..1AddressIf parameter is a data type
........ line S1..*stringStreet name, number, direction & P.O. Box etc.
........ city S1..1stringName of city, town etc.
........ state S1..1stringSub-unit of country (abbreviations ok)
........ postalCode S1..1stringPostal code for area
...... part:hcContactPerson S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: hcContactPerson
....... value[x] S1..1HumanNameIf parameter is a data type
........ family S1..1stringFamily name (often called 'Surname')
........ given S1..*stringGiven names (not always 'first'). Includes middle names
...... part:hcContactPhone S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: hcContactPhone
....... value[x] S1..1ContactPointIf parameter is a data type
........ system S1..1codephone | fax | email | pager | url | sms | other
Fixed Value: phone
........ value S1..1stringThe actual contact point details
...... part:hcPrenatalCareByReferralOnly S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: hcPrenatalCareByReferralOnly
....... value[x] S1..1booleanIf parameter is a data type
.... parameter:importProtocol S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: importProtocol
..... value[x] S1..1codeIf parameter is a data type
Fixed Value: https
.... parameter:udsData S0..*BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: udsData
..... Slices for part S0..*Named part of a multi-part parameter
Slice: Unordered, Open by value:$this.name
...... part:resourceType S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: type
....... value[x] S1..1codeIf parameter is a data type
...... part:resourceUrl S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: url
....... value[x] S1..1urlIf parameter is a data type
...... part:resourceUrlExpirationTime S1..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: expirationTime
....... value[x] S1..1dateTimeIf parameter is a data type
...... part:importAccessToken S0..1BackboneElementNamed part of a multi-part parameter
....... name S1..1stringName from the definition
Fixed Value: bearer
....... value[x] S1..1stringIf parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus Import Manifest
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC2..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
.... parameter:inputFormat SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: inputFormat
..... value[x] SΣC1..1codeIf parameter is a data type
Fixed Value: fhir+ndjson
.... parameter:submissionId SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: submissionId
..... value[x] SΣC1..1stringIf parameter is a data type
.... parameter:hcInformation SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
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..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: uei
....... value[x] SΣC1..1stringIf parameter is a data type
...... part:grantNumber SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: grantNumber
....... value[x] SΣC1..1stringIf parameter is a data type
...... part:hcName SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcName
....... value[x] SΣC1..1stringIf parameter is a data type
...... part:hcAddress SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcAddress
....... value[x] SΣC1..1AddressIf parameter is a data type
........ use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
........ line SΣ1..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
........ state SΣ1..1stringSub-unit of country (abbreviations ok)
........ postalCode SΣ1..1stringPostal code for area
Example General: 9132
...... part:hcContactPerson SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcContactPerson
....... value[x] SΣC1..1HumanNameIf parameter is a data type
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

........ family SΣ1..1stringFamily name (often called 'Surname')
........ given SΣ1..*stringGiven 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..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcContactPhone
....... value[x] SΣC1..1ContactPointIf parameter is a data type
........ system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
........ value SΣ1..1stringThe actual contact point details
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

...... part:hcPrenatalCareByReferralOnly SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcPrenatalCareByReferralOnly
....... value[x] SΣC1..1booleanIf parameter is a data type
.... parameter:importProtocol SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: importProtocol
..... value[x] SΣC1..1codeIf parameter is a data type
Fixed Value: https
.... parameter:udsData SΣC0..*BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName 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..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: type
....... value[x] SΣC1..1codeIf parameter is a data type
...... part:resourceUrl SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: url
....... value[x] SΣC1..1urlIf parameter is a data type
...... part:resourceUrlExpirationTime SΣ1..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: expirationTime
....... value[x] SΣC1..1dateTimeIf parameter is a data type
...... part:importAccessToken SΣ0..1BackboneElementNamed part of a multi-part parameter
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: bearer
....... value[x] SΣC1..1stringIf parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Parameters.parameter:hcInformation.part:hcAddress.value[x].userequiredAddressUse
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].userequiredNameUse
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].systemrequiredFixed Value: phone
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].userequiredContactPointUse

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:inputFormat, Parameters.parameter:submissionId, Parameters.parameter:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsDataA 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()))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus Import Manifest
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC2..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:inputFormat SΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: inputFormat
..... value[x] SΣC1..1codeIf parameter is a data type
Fixed Value: fhir+ndjson
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:submissionId SΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: submissionId
..... value[x] SΣC1..1stringIf parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:hcInformation SΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: hcInformation
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf 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..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: uei
....... value[x] SΣC1..1stringIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:grantNumber SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: grantNumber
....... value[x] SΣC1..1stringIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:hcName SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcName
....... value[x] SΣC1..1stringIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:hcAddress SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcAddress
....... value[x] SΣC1..1AddressIf parameter is a data type
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
........ type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
........ text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
........ line SΣ1..*stringStreet 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..1stringName of city, town etc.
Example General: Erewhon
........ district Σ0..1stringDistrict name (aka county)
Example General: Madison
........ state SΣ1..1stringSub-unit of country (abbreviations ok)
........ postalCode SΣ1..1stringPostal code for area
Example General: 9132
........ country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
........ period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:hcContactPerson SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcContactPerson
....... value[x] SΣC1..1HumanNameIf parameter is a data type
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

........ text Σ0..1stringText representation of the full name
........ family SΣ1..1stringFamily name (often called 'Surname')
........ given SΣ1..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
........ prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
........ suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
........ period Σ0..1PeriodTime period when name was/is in use
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:hcContactPhone SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcContactPhone
....... value[x] SΣC1..1ContactPointIf parameter is a data type
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
........ value SΣ1..1stringThe actual contact point details
........ use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

........ rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
........ period Σ0..1PeriodTime period when the contact point was/is in use
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:hcPrenatalCareByReferralOnly SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: hcPrenatalCareByReferralOnly
....... value[x] SΣC1..1booleanIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:importProtocol SΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: importProtocol
..... value[x] SΣC1..1codeIf parameter is a data type
Fixed Value: https
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:udsData SΣC0..*BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: udsData
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf 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..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: type
....... value[x] SΣC1..1codeIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:resourceUrl SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: url
....... value[x] SΣC1..1urlIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:resourceUrlExpirationTime SΣ1..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: expirationTime
....... value[x] SΣC1..1dateTimeIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
...... part:importAccessToken SΣ0..1BackboneElementNamed part of a multi-part parameter
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... name SΣ1..1stringName from the definition
Fixed Value: bearer
....... value[x] SΣC1..1stringIf parameter is a data type
....... resource ΣC0..1ResourceIf parameter is a whole resource
....... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter:hcInformation.part:hcAddress.value[x].userequiredAddressUse
Parameters.parameter:hcInformation.part:hcAddress.value[x].typerequiredAddressType
Parameters.parameter:hcInformation.part:hcContactPerson.value[x].userequiredNameUse
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].systemrequiredFixed Value: phone
Parameters.parameter:hcInformation.part:hcContactPhone.value[x].userequiredContactPointUse

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:inputFormat, Parameters.parameter:submissionId, Parameters.parameter:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsDataA 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()))