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.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:$this.name Constraints: inv-1
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	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: inputFormat
value[x]	SΣC	1..1	code	If parameter is a data type Fixed Value: fhir+ndjson
parameter:submissionId	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: submissionId
value[x]	SΣC	1..1	string	If parameter is a data type
parameter:hcInformation	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name 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: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
part:ueiNumber	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: uei
value[x]	SΣC	1..1	string	If parameter is a data type
part:grantNumber	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: 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 Constraints: inv-1
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	0..*	BackboneElement	Operation Parameter Constraints: inv-1
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: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
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
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Parameters.parameter:hcInformation.​part:hcAddress.value[x].​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcContactPerson.​value[x].use	Base	required	NameUse	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcContactPhone.​value[x].system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcContactPhone.​value[x].use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:hcInformation, Parameters.parameter:importProtocol, Parameters.parameter:udsData	A parameter must have one and only one of (value, resource, part)	(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	UDS Plus Import Manifest
Slices for parameter	S	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:$this.name
parameter:inputFormat	S	1..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: inputFormat
value[x]	S	1..1	code	If parameter is a data type Fixed Value: fhir+ndjson
parameter:submissionId	S	1..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: submissionId
value[x]	S	1..1	string	If parameter is a data type
parameter:hcInformation	S	1..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition 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	Named part of a multi-part parameter
name	S	1..1	string	Name from the definition Fixed Value: uei
value[x]	S	1..1	string	If parameter is a data type
part:grantNumber	S	1..1	BackboneElement	Named part of a multi-part parameter
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	0..*	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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	UDS Plus Import Manifest
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	SΣC	2..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:$this.name Constraints: inv-1
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	Operation Parameter Constraints: inv-1
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: inputFormat
value[x]	SΣC	1..1	code	If parameter is a data type 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	Operation Parameter Constraints: inv-1
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: submissionId
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
parameter:hcInformation	SΣC	1..1	BackboneElement	Operation Parameter Constraints: inv-1
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: 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: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
part:ueiNumber	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: uei
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:grantNumber	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: 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 Constraints: inv-1
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	0..*	BackboneElement	Operation Parameter Constraints: inv-1
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: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
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
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Parameters.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcAddress.value[x].​use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcAddress.value[x].​type	Base	required	AddressType	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcContactPerson.​value[x].use	Base	required	NameUse	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcContactPhone.​value[x].system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Parameters.parameter:hcInformation.​part:hcContactPhone.​value[x].use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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: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()))