Generated Narrative: StructureDefinition uds-plus-import-manifest version: 12; Last updated: 2022-07-12 02:03:11+0000; Information Source: #3LDMUQYYwafwTzqK Name Flags Card. Type Description & Constraints Parameters 0..* Parameters UDS Plus Import Manifest #xD; Slices for parameter S 2..* BackboneElement Operation Parameter Slice: Unordered, Open by value:$this.name #xD; parameter:inputFormat S 1..1 BackboneElement Operation Parameter #xD; name S 1..1 string Name from the definition Fixed Value: inputFormat #xD; value[x] S 1..1 code If parameter is a data type Fixed Value: fhir+ndjson #xD; parameter:submissionId S 1..1 BackboneElement Operation Parameter #xD; name S 1..1 string Name from the definition Fixed Value: submissionId #xD; value[x] S 1..1 string If parameter is a data type #xD; parameter:hcInformation S 1..1 BackboneElement Operation Parameter #xD; name S 1..1 string Name from the definition Fixed Value: hcInformation #xD; Slices for part S 7..* Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name #xD; part:ueiNumber S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: uei #xD; value[x] S 1..1 string If parameter is a data type #xD; part:grantNumber S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: grantNumber #xD; value[x] S 1..1 string If parameter is a data type #xD; part:hcName S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: hcName #xD; value[x] S 1..1 string If parameter is a data type #xD; part:hcAddress S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: hcAddress #xD; value[x] S 1..1 Address If parameter is a data type #xD; line S 1..* string Street name, number, direction & P.O. Box etc. #xD; city S 1..1 string Name of city, town etc. #xD; state S 1..1 string Sub-unit of country (abbreviations ok) #xD; postalCode S 1..1 string Postal code for area #xD; part:hcContactPerson S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: hcContactPerson #xD; value[x] S 1..1 HumanName If parameter is a data type #xD; family S 1..1 string Family name (often called 'Surname') #xD; given S 1..* string Given names (not always 'first'). Includes middle names #xD; part:hcContactPhone S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: hcContactPhone #xD; value[x] S 1..1 ContactPoint If parameter is a data type #xD; system S 1..1 code phone | fax | email | pager | url | sms | other Fixed Value: phone #xD; value S 1..1 string The actual contact point details #xD; part:hcPrenatalCareByReferralOnly S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: hcPrenatalCareByReferralOnly #xD; value[x] S 1..1 boolean If parameter is a data type #xD; parameter:importProtocol S 1..1 BackboneElement Operation Parameter #xD; name S 1..1 string Name from the definition Fixed Value: importProtocol #xD; value[x] S 1..1 code If parameter is a data type Fixed Value: https #xD; parameter:udsData S 0..* BackboneElement Operation Parameter #xD; name S 1..1 string Name from the definition Fixed Value: udsData #xD; Slices for part S 0..* Named part of a multi-part parameter Slice: Unordered, Open by value:$this.name #xD; part:resourceType S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: type #xD; value[x] S 1..1 code If parameter is a data type #xD; part:resourceUrl S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: url #xD; value[x] S 1..1 url If parameter is a data type #xD; part:resourceUrlExpirationTime S 1..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: expirationTime #xD; value[x] S 1..1 dateTime If parameter is a data type #xD; part:importAccessToken S 0..1 BackboneElement Named part of a multi-part parameter #xD; name S 1..1 string Name from the definition Fixed Value: bearer #xD; value[x] S 1..1 string If parameter is a data type #xD; Documentation for this format
HL7 International / Cross Group Projects
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.
The parameters that may be used are defined by the OperationDefinition resource.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
A parameter passed to or received from the operation.
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()))
(exists(f:resource) or exists(f:part) or exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:resource))) and not(exists(f:*[starts-with(local-name(.), 'value')])) and exists(f:part))) and not(exists(f:part) and exists(f:resource))
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the parameter (reference to the operation definition).
When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
Only one level of nested parameters is allowed.
Extensions are always sliced by (at least) url
home | work | temp | old | billing - purpose of this address
Applications can assume that an address is current unless it explicitly says that it is temporary or old.
Allows an appropriate address to be chosen from a list of many.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).
The type of an address (physical / postal).
Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
Street name, number, direction & P.O. Box etc.
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
The order in which lines should appear in an address label
XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
The name of the city, town, suburb, village or other community or delivery center.
The name of the administrative area (county).
District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).
A postal code designating a region defined by the postal service.
Country (e.g. can be ISO 3166 2 or 3 letter code)
Country - a nation as commonly understood or generally accepted.
ISO 3166 3 letter codes can be used in place of a human readable country name.
Allows addresses to be placed in historical context.
usual | official | temp | nickname | anonymous | old | maiden
Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Allows the appropriate name for a particular context of use to be selected from among a set of names.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
XPN.7, but often indicated by which field contains the name
Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Given names (not always 'first'). Includes middle names
If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
Given Names appear in the correct order for presenting the name
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Prefixes appear in the correct order for presenting the name
Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
Suffixes appear in the correct order for presenting the name
Indicates the period of time when this name was valid for the named person.
Allows names to be placed in historical context.
phone | fax | email | pager | url | sms | other
Telecommunications form for contact point - what communications system is required to make use of the contact.
Telecommunications form for contact point.
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Need to support legacy numbers that are not in a tightly controlled format.
home | work | temp | old | mobile - purpose of this contact point
Identifies the purpose for the contact point.
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
Specify preferred order of use (1 = highest)
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Time period when the contact point was/is in use
Time period when the contact point was/is in use.