Da Vinci Postable Remittance
0.1.0 - ci-build United States of America flag

Da Vinci Postable Remittance, published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pr/ and changes regularly. See the Directory of published versions

Resource Profile: Download Remittance Incoming Parameters

Official URL: http://hl7.org/fhir/us/davinci-pr/StructureDefinition/downloadRemittanceParameters Version: 0.1.0
Standards status: Trial-use Maturity Level: 3 Computable Name: DownloadRemittanceParameters

A profile of Parameters that indicate the specific remittance advice to download.

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 Operation Request or Response
... Slices for parameter 1..2 BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:RemittanceAdviceIdentifier 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Required Pattern: RemittanceAdviceIdentifier
..... value[x] 1..1 string If parameter is a data type
.... parameter:RemittanceAdviceType 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Required Pattern: RemittanceAdviceType
..... value[x] 1..1 code If parameter is a data type
Binding: Remittance Advice Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Parameters.parameter:RemittanceAdviceType.value[x]requiredRemittanceAdviceType (a valid code from Remittance Advice Code System)
http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..2 BackboneElement Operation Parameter
Slice: Unordered, Open by value: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:RemittanceAdviceIdentifier Σ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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceIdentifier
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:RemittanceAdviceType ΣC 0..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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceType
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: Remittance Advice Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:RemittanceAdviceType.value[x]requiredRemittanceAdviceType (a valid code from Remittance Advice Code System)
http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType
from this IG

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:RemittanceAdviceIdentifier, Parameters.parameter:RemittanceAdviceTypeA 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 Operation Request or Response
... 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 ΣC 1..2 BackboneElement Operation Parameter
Slice: Unordered, Open by value: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:RemittanceAdviceIdentifier Σ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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceIdentifier
..... value[x] Σ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:RemittanceAdviceType ΣC 0..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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceType
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: Remittance Advice Value Set (required)
..... 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
Parameters.parameter:RemittanceAdviceType.value[x]requiredRemittanceAdviceType (a valid code from Remittance Advice Code System)
http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType
from this IG

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:RemittanceAdviceIdentifier, Parameters.parameter:RemittanceAdviceTypeA 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: 3 elements(1 nested mandatory element)

Slices

This structure defines the following Slices:

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

Maturity: 3

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 1..2 BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:RemittanceAdviceIdentifier 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Required Pattern: RemittanceAdviceIdentifier
..... value[x] 1..1 string If parameter is a data type
.... parameter:RemittanceAdviceType 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Required Pattern: RemittanceAdviceType
..... value[x] 1..1 code If parameter is a data type
Binding: Remittance Advice Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Parameters.parameter:RemittanceAdviceType.value[x]requiredRemittanceAdviceType (a valid code from Remittance Advice Code System)
http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..2 BackboneElement Operation Parameter
Slice: Unordered, Open by value: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:RemittanceAdviceIdentifier Σ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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceIdentifier
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:RemittanceAdviceType ΣC 0..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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceType
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: Remittance Advice Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:RemittanceAdviceType.value[x]requiredRemittanceAdviceType (a valid code from Remittance Advice Code System)
http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType
from this IG

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:RemittanceAdviceIdentifier, Parameters.parameter:RemittanceAdviceTypeA 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 Operation Request or Response
... 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 ΣC 1..2 BackboneElement Operation Parameter
Slice: Unordered, Open by value: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:RemittanceAdviceIdentifier Σ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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceIdentifier
..... value[x] Σ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:RemittanceAdviceType ΣC 0..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 Σ 1..1 string Name from the definition
Required Pattern: RemittanceAdviceType
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: Remittance Advice Value Set (required)
..... 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
Parameters.parameter:RemittanceAdviceType.value[x]requiredRemittanceAdviceType (a valid code from Remittance Advice Code System)
http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType
from this IG

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:RemittanceAdviceIdentifier, Parameters.parameter:RemittanceAdviceTypeA 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: 3 elements(1 nested mandatory element)

Slices

This structure defines the following Slices:

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

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron