HRSA 2023 Uniform Data System (UDS) Patient Level Submission (PLS) (UDS+) FHIR IG
1.1.0 - STU1 Release 1.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.1.0: 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.1.0
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..* Parameters UDS Plus DeIdentify Data
... Slices for parameter S 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:format S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: format
..... value[x] S 1..1 code If parameter is a data type
.... 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: resourceType
....... 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: resourceUrl
....... value[x] S 1..1 url If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters UDS Plus DeIdentify Data
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter SΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:$this.name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:format SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: format
..... value[x] SΣC 1..1 code If parameter is a data type
.... parameter:udsData SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: udsData
..... Slices for part SΣ 0..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:$this.name
...... part:resourceType SΣ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name SΣ 1..1 string Name from the definition
Fixed Value: resourceType
....... 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: resourceUrl
....... value[x] SΣC 1..1 url If 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..* Parameters UDS Plus DeIdentify Data
... 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
... Slices for parameter SΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:$this.name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:format SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: format
..... 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
.... parameter:udsData SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: udsData
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... Slices for part SΣ 0..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:$this.name
...... part:resourceType SΣ 1..1 BackboneElement Named part of a multi-part parameter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name SΣ 1..1 string Name from the definition
Fixed Value: resourceType
....... 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: resourceUrl
....... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

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: 4 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter
  • The element 1 is sliced based on the value of Parameters.parameter.part

Maturity: 2

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters UDS Plus DeIdentify Data
... Slices for parameter S 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:$this.name
.... parameter:format S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Fixed Value: format
..... value[x] S 1..1 code If parameter is a data type
.... 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: resourceType
....... 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: resourceUrl
....... value[x] S 1..1 url If parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters UDS Plus DeIdentify Data
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter SΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:$this.name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:format SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: format
..... value[x] SΣC 1..1 code If parameter is a data type
.... parameter:udsData SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: udsData
..... Slices for part SΣ 0..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:$this.name
...... part:resourceType SΣ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name SΣ 1..1 string Name from the definition
Fixed Value: resourceType
....... 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: resourceUrl
....... value[x] SΣC 1..1 url If 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..* Parameters UDS Plus DeIdentify Data
... 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
... Slices for parameter SΣC 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:$this.name
inv-1: A parameter must have one and only one of (value, resource, part)
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:format SΣC 1..1 BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: format
..... 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
.... parameter:udsData SΣC 0..* BackboneElement Operation Parameter
inv-1: A parameter must have one and only one of (value, resource, part)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name SΣ 1..1 string Name from the definition
Fixed Value: udsData
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... Slices for part SΣ 0..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:$this.name
...... part:resourceType SΣ 1..1 BackboneElement Named part of a multi-part parameter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name SΣ 1..1 string Name from the definition
Fixed Value: resourceType
....... 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: resourceUrl
....... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

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: 4 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter
  • The element 1 is sliced based on the value of Parameters.parameter.part

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron