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

This page is part of the HRSA Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+ or uds-plus) FHIR IG (v1.0.1: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: UDS Plus DeIdentify Data Urls Parameter

Official URL: http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/uds-plus-deidentify-operation-data-urls-parameter Version: 1.0.1
Standards status: Trial-use Maturity Level: 2 Computable Name: UDSPlusDeIdentifyDataUrlsParameter

The UDS+ profile is based on the **Parameters FHIR Resource and establishes the core elements, extensions, vocabularies and value sets for representing the data for sending input and receiving output for the DeIdentify operation of UDS+ .

Introduction

This profile is used to represent the input and output parameters for the $deidentify operation of UDSPlus.

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 DeIdentify Data
... Slices for parameter S1..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:format S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: format
..... value[x] S1..1codeIf parameter is a data type
.... 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: resourceType
....... 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: resourceUrl
....... value[x] S1..1urlIf parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus DeIdentify Data
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC1..*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:format SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: format
..... value[x] SΣC1..1codeIf parameter is a data type
.... 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: resourceType
....... 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: resourceUrl
....... value[x] SΣC1..1urlIf parameter is a data type

doco Documentation for this format

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:format, 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 DeIdentify Data
... 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ΣC1..*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:format 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: format
..... 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
.... 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: resourceType
....... 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: resourceUrl
....... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

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:format, 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()))

This structure is derived from Parameters

Summary

Mandatory: 4 elements (7 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:$this.name
  • The element Parameters.parameter.part is sliced based on the value of value:$this.name

Maturity: 2

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus DeIdentify Data
... Slices for parameter S1..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:format S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: format
..... value[x] S1..1codeIf parameter is a data type
.... 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: resourceType
....... 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: resourceUrl
....... value[x] S1..1urlIf parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus DeIdentify Data
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC1..*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:format SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: format
..... value[x] SΣC1..1codeIf parameter is a data type
.... 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: resourceType
....... 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: resourceUrl
....... value[x] SΣC1..1urlIf parameter is a data type

doco Documentation for this format

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:format, 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()))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersUDS Plus DeIdentify Data
... 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ΣC1..*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:format 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: format
..... 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
.... 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: resourceType
....... 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: resourceUrl
....... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

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:format, 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()))

This structure is derived from Parameters

Summary

Mandatory: 4 elements (7 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:$this.name
  • The element Parameters.parameter.part is sliced based on the value of value:$this.name

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron