This page is part of the ACCESS Model IG v0.9.8 DRAFT (v0.9.8: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
Resource Profile: ACCESS Alignment Request Parameters
| Official URL: https://dsacms.github.io/cmmi-access-model/StructureDefinition/access-align-in | Version: 0.9.8 | ||||
| Draft as of 2026-05-20 | Computable Name: ACCESSAlignmentRequestParameters | ||||
This is the profile for the $align operation input parameters. When a patient wishes to switch from one ACCESS participant to another after the 90-day lock-in period, the switchConsentAttestation parameter must be set to true to indicate that the patient has provided consent to switch providers.
The switchConsentAttestation parameter:
- Is optional (
0..1cardinality) - Should be omitted for initial alignments
- Must be set to
truewhen aligning a patient who is switching from another ACCESS participant after the lock-in period
By setting switchConsentAttestation to true, the submitting provider attests that:
- ==Legal text or link to same goes here==
The conditions parameter SHALL reference track-specific condition profiles, depending on the ACCESS track:
- eCKM Track: Use ACCESSeCKMCondition
- CKM Track: Use ACCESSCKMCondition
- MSK Track: Use ACCESSMSKCondition
- BH Track: Use ACCESSBHCondition
For detailed alignment workflows and examples, see the Alignment API section in the Operations Manual.
Usages:
- Examples for this Profile: Parameters/AlignmentRequestExample and Parameters/AlignmentRequestWithSwitchConsentExample
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Parameters |
0..* | Parameters(4.0.1) | Operation Request or Response | |
  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) | |
  Slices for parameter |
SΣC | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name Constraints: inv-1 |
   parameter:All Slices |
Content/Rules for all slices | |||
   modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
 name |
Σ | 1..1 | string | Name from the definition |
 parameter:participantID |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
 name |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID |
  value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern |
| parameter:payerID |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type |
| parameter:patient |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient |
| resource |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
| parameter:track |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: track |
| value[x] |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.8) (required) |
| parameter:condition |
SΣC | 1..* | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition |
| resource |
S | 1..1 | ACCESSCondition(0.9.8) | Detailed information about conditions, problems or diagnoses |
| parameter:isProviderReferral |
SΣC | 1..1 | BackboneElement | Provider referred? Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: isProviderReferral |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
 parameter:switchConsentAttestation |
SΣC | 0..1 | BackboneElement | Provider Switch Consent Attestation Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: switchConsentAttestation |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| 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:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.8 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345) |
value.matches('^ACCES\\d{5}$')
|
| ele-1 | error | Parameters.implicitRules, Parameters.language, Parameters.parameter, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter:participantID, Parameters.parameter:participantID.name, Parameters.parameter:participantID.value[x], Parameters.parameter:payerID, Parameters.parameter:payerID.name, Parameters.parameter:payerID.value[x], Parameters.parameter:patient, Parameters.parameter:patient.name, Parameters.parameter:track, Parameters.parameter:track.name, Parameters.parameter:track.value[x], Parameters.parameter:condition, Parameters.parameter:condition.name, Parameters.parameter:isProviderReferral, Parameters.parameter:isProviderReferral.name, Parameters.parameter:isProviderReferral.value[x], Parameters.parameter:switchConsentAttestation, Parameters.parameter:switchConsentAttestation.name, Parameters.parameter:switchConsentAttestation.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Parameters.parameter.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Parameters.parameter, Parameters.parameter:participantID, Parameters.parameter:payerID, Parameters.parameter:patient, Parameters.parameter:track, Parameters.parameter:condition, Parameters.parameter:isProviderReferral, Parameters.parameter:switchConsentAttestation | 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()))
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters(4.0.1) | Operation Request or Response | |
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
| Slices for parameter |
S | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name |
| parameter:participantID |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: participantID |
| value[x] |
SC | 1..1 | Identifier | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:payerID |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: payerID |
| value[x] |
S | 1..1 | Identifier | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:patient |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: patient |
| value[x] |
0..0 | If parameter is a data type | ||
| resource |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
| parameter:track |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: track |
| value[x] |
S | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.8) (required) |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:condition |
S | 1..* | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: condition |
| value[x] |
0..0 | If parameter is a data type | ||
| resource |
S | 1..1 | ACCESSCondition(0.9.8) | Detailed information about conditions, problems or diagnoses |
| parameter:isProviderReferral |
S | 1..1 | BackboneElement | Provider referred? |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: isProviderReferral |
| value[x] |
S | 1..1 | boolean | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:switchConsentAttestation |
S | 0..1 | BackboneElement | Provider Switch Consent Attestation |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: switchConsentAttestation |
| value[x] |
S | 1..1 | boolean | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Parameters.parameter:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.8 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345) |
value.matches('^ACCES\\d{5}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters(4.0.1) | 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 |
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
| Slices for parameter |
SΣC | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value: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 Constraints: ext-1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| 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:participantID |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:payerID |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:patient |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient |
| resource |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:track |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: track |
| value[x] |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.8) (required) |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:condition |
SΣC | 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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition |
| resource |
S | 1..1 | ACCESSCondition(0.9.8) | Detailed information about conditions, problems or diagnoses |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:isProviderReferral |
SΣC | 1..1 | BackboneElement | Provider referred? Constraints: inv-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: isProviderReferral |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:switchConsentAttestation |
SΣC | 0..1 | BackboneElement | Provider Switch Consent Attestation Constraints: inv-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: switchConsentAttestation |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| 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:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.8 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345) |
value.matches('^ACCES\\d{5}$')
|
| ele-1 | error | Parameters.meta, Parameters.implicitRules, Parameters.language, Parameters.parameter, Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter.value[x], Parameters.parameter.part, Parameters.parameter:participantID, Parameters.parameter:participantID.extension, Parameters.parameter:participantID.name, Parameters.parameter:participantID.value[x], Parameters.parameter:participantID.part, Parameters.parameter:payerID, Parameters.parameter:payerID.extension, Parameters.parameter:payerID.name, Parameters.parameter:payerID.value[x], Parameters.parameter:payerID.part, Parameters.parameter:patient, Parameters.parameter:patient.extension, Parameters.parameter:patient.name, Parameters.parameter:patient.part, Parameters.parameter:track, Parameters.parameter:track.extension, Parameters.parameter:track.name, Parameters.parameter:track.value[x], Parameters.parameter:track.part, Parameters.parameter:condition, Parameters.parameter:condition.extension, Parameters.parameter:condition.name, Parameters.parameter:condition.part, Parameters.parameter:isProviderReferral, Parameters.parameter:isProviderReferral.extension, Parameters.parameter:isProviderReferral.name, Parameters.parameter:isProviderReferral.value[x], Parameters.parameter:isProviderReferral.part, Parameters.parameter:switchConsentAttestation, Parameters.parameter:switchConsentAttestation.extension, Parameters.parameter:switchConsentAttestation.name, Parameters.parameter:switchConsentAttestation.value[x], Parameters.parameter:switchConsentAttestation.part | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter:participantID.extension, Parameters.parameter:payerID.extension, Parameters.parameter:patient.extension, Parameters.parameter:track.extension, Parameters.parameter:condition.extension, Parameters.parameter:isProviderReferral.extension, Parameters.parameter:switchConsentAttestation.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Parameters.parameter, Parameters.parameter:participantID, Parameters.parameter:payerID, Parameters.parameter:patient, Parameters.parameter:track, Parameters.parameter:condition, Parameters.parameter:isProviderReferral, Parameters.parameter:switchConsentAttestation | 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()))
|
Summary
Mandatory: 12 elements(1 nested mandatory element)
Must-Support: 22 elements
Fixed: 7 elements
Prohibited: 14 elements
Structures
This structure refers to these other structures:
- US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0)
- ACCESS Condition Profile (https://dsacms.github.io/cmmi-access-model/StructureDefinition/access-condition|0.9.8)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Parameters.parameter (Closed)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters(4.0.1) | Operation Request or Response | |
| 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) | |
| Slices for parameter |
SΣC | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name Constraints: inv-1 |
| parameter:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| name |
Σ | 1..1 | string | Name from the definition |
| parameter:participantID |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern |
| parameter:payerID |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type |
| parameter:patient |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient |
| resource |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
| parameter:track |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: track |
| value[x] |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.8) (required) |
| parameter:condition |
SΣC | 1..* | BackboneElement | Operation Parameter Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition |
| resource |
S | 1..1 | ACCESSCondition(0.9.8) | Detailed information about conditions, problems or diagnoses |
| parameter:isProviderReferral |
SΣC | 1..1 | BackboneElement | Provider referred? Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: isProviderReferral |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| parameter:switchConsentAttestation |
SΣC | 0..1 | BackboneElement | Provider Switch Consent Attestation Constraints: inv-1 |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: switchConsentAttestation |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| 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:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.8 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345) |
value.matches('^ACCES\\d{5}$')
|
| ele-1 | error | Parameters.implicitRules, Parameters.language, Parameters.parameter, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter:participantID, Parameters.parameter:participantID.name, Parameters.parameter:participantID.value[x], Parameters.parameter:payerID, Parameters.parameter:payerID.name, Parameters.parameter:payerID.value[x], Parameters.parameter:patient, Parameters.parameter:patient.name, Parameters.parameter:track, Parameters.parameter:track.name, Parameters.parameter:track.value[x], Parameters.parameter:condition, Parameters.parameter:condition.name, Parameters.parameter:isProviderReferral, Parameters.parameter:isProviderReferral.name, Parameters.parameter:isProviderReferral.value[x], Parameters.parameter:switchConsentAttestation, Parameters.parameter:switchConsentAttestation.name, Parameters.parameter:switchConsentAttestation.value[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Parameters.parameter.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Parameters.parameter, Parameters.parameter:participantID, Parameters.parameter:payerID, Parameters.parameter:patient, Parameters.parameter:track, Parameters.parameter:condition, Parameters.parameter:isProviderReferral, Parameters.parameter:switchConsentAttestation | 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()))
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters(4.0.1) | Operation Request or Response | |
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
| Slices for parameter |
S | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name |
| parameter:participantID |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: participantID |
| value[x] |
SC | 1..1 | Identifier | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:payerID |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: payerID |
| value[x] |
S | 1..1 | Identifier | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:patient |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: patient |
| value[x] |
0..0 | If parameter is a data type | ||
| resource |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
| parameter:track |
S | 1..1 | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: track |
| value[x] |
S | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.8) (required) |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:condition |
S | 1..* | BackboneElement | Operation Parameter |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: condition |
| value[x] |
0..0 | If parameter is a data type | ||
| resource |
S | 1..1 | ACCESSCondition(0.9.8) | Detailed information about conditions, problems or diagnoses |
| parameter:isProviderReferral |
S | 1..1 | BackboneElement | Provider referred? |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: isProviderReferral |
| value[x] |
S | 1..1 | boolean | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| parameter:switchConsentAttestation |
S | 0..1 | BackboneElement | Provider Switch Consent Attestation |
| modifierExtension |
0..0 | Extension | ||
| name |
S | 1..1 | string | Name from the definition Fixed Value: switchConsentAttestation |
| value[x] |
S | 1..1 | boolean | If parameter is a data type |
| resource |
0..0 | If parameter is a whole resource | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Parameters.parameter:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.8 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345) |
value.matches('^ACCES\\d{5}$')
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Parameters |
0..* | Parameters(4.0.1) | 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 |
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
| Slices for parameter |
SΣC | 6..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value: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 Constraints: ext-1 | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| 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:participantID |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:payerID |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID |
| value[x] |
SΣC | 1..1 | Identifier | If parameter is a data type |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:patient |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient |
| resource |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:track |
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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: track |
| value[x] |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.8) (required) |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:condition |
SΣC | 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 Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition |
| resource |
S | 1..1 | ACCESSCondition(0.9.8) | Detailed information about conditions, problems or diagnoses |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:isProviderReferral |
SΣC | 1..1 | BackboneElement | Provider referred? Constraints: inv-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: isProviderReferral |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter |
| parameter:switchConsentAttestation |
SΣC | 0..1 | BackboneElement | Provider Switch Consent Attestation Constraints: inv-1 |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
| name |
SΣ | 1..1 | string | Name from the definition Fixed Value: switchConsentAttestation |
| value[x] |
SΣC | 1..1 | boolean | If parameter is a data type |
| 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:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.8 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCES##### where ##### represents exactly 5 digits (e.g., ACCES00001, ACCES12345) |
value.matches('^ACCES\\d{5}$')
|
| ele-1 | error | Parameters.meta, Parameters.implicitRules, Parameters.language, Parameters.parameter, Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter.name, Parameters.parameter.value[x], Parameters.parameter.part, Parameters.parameter:participantID, Parameters.parameter:participantID.extension, Parameters.parameter:participantID.name, Parameters.parameter:participantID.value[x], Parameters.parameter:participantID.part, Parameters.parameter:payerID, Parameters.parameter:payerID.extension, Parameters.parameter:payerID.name, Parameters.parameter:payerID.value[x], Parameters.parameter:payerID.part, Parameters.parameter:patient, Parameters.parameter:patient.extension, Parameters.parameter:patient.name, Parameters.parameter:patient.part, Parameters.parameter:track, Parameters.parameter:track.extension, Parameters.parameter:track.name, Parameters.parameter:track.value[x], Parameters.parameter:track.part, Parameters.parameter:condition, Parameters.parameter:condition.extension, Parameters.parameter:condition.name, Parameters.parameter:condition.part, Parameters.parameter:isProviderReferral, Parameters.parameter:isProviderReferral.extension, Parameters.parameter:isProviderReferral.name, Parameters.parameter:isProviderReferral.value[x], Parameters.parameter:isProviderReferral.part, Parameters.parameter:switchConsentAttestation, Parameters.parameter:switchConsentAttestation.extension, Parameters.parameter:switchConsentAttestation.name, Parameters.parameter:switchConsentAttestation.value[x], Parameters.parameter:switchConsentAttestation.part | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Parameters.parameter.extension, Parameters.parameter.modifierExtension, Parameters.parameter:participantID.extension, Parameters.parameter:payerID.extension, Parameters.parameter:patient.extension, Parameters.parameter:track.extension, Parameters.parameter:condition.extension, Parameters.parameter:isProviderReferral.extension, Parameters.parameter:switchConsentAttestation.extension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Parameters.parameter, Parameters.parameter:participantID, Parameters.parameter:payerID, Parameters.parameter:patient, Parameters.parameter:track, Parameters.parameter:condition, Parameters.parameter:isProviderReferral, Parameters.parameter:switchConsentAttestation | 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()))
|
Summary
Mandatory: 12 elements(1 nested mandatory element)
Must-Support: 22 elements
Fixed: 7 elements
Prohibited: 14 elements
Structures
This structure refers to these other structures:
- US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|6.1.0)
- ACCESS Condition Profile (https://dsacms.github.io/cmmi-access-model/StructureDefinition/access-condition|0.9.8)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Parameters.parameter (Closed)
Other representations of profile: CSV, Excel, Schematron