CMS ACCESS Model API
0.9.0 - ci-build
CMS ACCESS Model API - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://globalalliantinc.com/access/StructureDefinition/access-unalign-in | Version: 0.9.0 | |||
| Draft as of 2026-03-06 | Computable Name: ACCESSUnalignmentRequestParameters | |||
This is the profile for the $unalign operation input parameters.
The reason parameter is required and must use one of four codes from ACCESSUnalignmentReasonVS.
The conditions parameter:
no-longer-clinically-eligible reason codeaccess-unalign-condition-required invariantFor detailed unalignment workflows and examples, see the Unalignment API Guidance section in the Operations Manual.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Parameters(4.0.1) | Operation Request or Response Constraints: access-unalign-condition-required |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
SΣC | 5..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name Constraints: inv-1 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: track |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.0) (required) |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSClinicalExclusionCondition(0.9.0) | Detailed information about conditions, problems or diagnoses |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: reason |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSUnalignmentReasonVS (0.9.0) (required) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.parameter:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.0 | This IG |
| Parameters.parameter:reason.value[x] | Base | required | ACCESS Unalignment Reason Value Set | 📍0.9.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCESS#### where #### represents exactly 4 digits (e.g., ACCESS0001, ACCESS1234) |
value.matches('^ACCESS\\d{4}$')
|
| access-unalign-condition-required | error | Parameters | When the unalignment reason is 'no-longer-clinically-eligible', at least one condition parameter must be provided to document the disqualifying diagnosis |
parameter.where(name = 'reason').value.ofType(CodeableConcept).coding.where(system = 'https://globalalliantinc.com/access/CodeSystem/ACCESSUnalignmentReasonCS' and code = 'no-longer-clinically-eligible').exists() implies parameter.where(name = 'condition').exists()
|
| ele-1 | error | Parameters.implicitRules, 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:reason, Parameters.parameter:reason.name, Parameters.parameter:reason.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:reason | 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()))
|
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Parameters(4.0.1) | Operation Request or Response |
![]() ![]() |
S | 5..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: participantID |
![]() ![]() ![]() ![]() |
SC | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: payerID |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: patient |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a data type | ||
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: track |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.0) (required) |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: condition |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a data type | ||
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSClinicalExclusionCondition(0.9.0) | Detailed information about conditions, problems or diagnoses |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: reason |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSUnalignmentReasonVS (0.9.0) (required) |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.parameter:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.0 | This IG |
| Parameters.parameter:reason.value[x] | Base | required | ACCESS Unalignment Reason Value Set | 📍0.9.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCESS#### where #### represents exactly 4 digits (e.g., ACCESS0001, ACCESS1234) |
value.matches('^ACCESS\\d{4}$')
|
| access-unalign-condition-required | error | Parameters | When the unalignment reason is 'no-longer-clinically-eligible', at least one condition parameter must be provided to document the disqualifying diagnosis |
parameter.where(name = 'reason').value.ofType(CodeableConcept).coding.where(system = 'https://globalalliantinc.com/access/CodeSystem/ACCESSUnalignmentReasonCS' and code = 'no-longer-clinically-eligible').exists() implies parameter.where(name = 'condition').exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Parameters(4.0.1) | Operation Request or Response Constraints: access-unalign-condition-required | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
SΣC | 5..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name Constraints: inv-1 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | If parameter is a data type | |||||
![]() ![]() ![]() ![]() ![]() |
base64Binary | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
id | |||||||
![]() ![]() ![]() ![]() ![]() |
instant | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() ![]() |
oid | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() |
unsignedInt | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() ![]() |
uuid | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactPoint | |||||||
![]() ![]() ![]() ![]() ![]() |
Count | |||||||
![]() ![]() ![]() ![]() ![]() |
Distance | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
HumanName | |||||||
![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() ![]() |
Signature | |||||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() |
Contributor | |||||||
![]() ![]() ![]() ![]() ![]() |
DataRequirement | |||||||
![]() ![]() ![]() ![]() ![]() |
Expression | |||||||
![]() ![]() ![]() ![]() ![]() |
ParameterDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
RelatedArtifact | |||||||
![]() ![]() ![]() ![]() ![]() |
TriggerDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
UsageContext | |||||||
![]() ![]() ![]() ![]() ![]() |
Dosage | |||||||
![]() ![]() ![]() ![]() ![]() |
Meta | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: track | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.0) (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSClinicalExclusionCondition(0.9.0) | Detailed information about conditions, problems or diagnoses | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: reason | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSUnalignmentReasonVS (0.9.0) (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
Documentation for this format | ||||||||
| 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.0 | This IG |
| Parameters.parameter:reason.value[x] | Base | required | ACCESS Unalignment Reason Value Set | 📍0.9.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCESS#### where #### represents exactly 4 digits (e.g., ACCESS0001, ACCESS1234) |
value.matches('^ACCESS\\d{4}$')
|
| access-unalign-condition-required | error | Parameters | When the unalignment reason is 'no-longer-clinically-eligible', at least one condition parameter must be provided to document the disqualifying diagnosis |
parameter.where(name = 'reason').value.ofType(CodeableConcept).coding.where(system = 'https://globalalliantinc.com/access/CodeSystem/ACCESSUnalignmentReasonCS' and code = 'no-longer-clinically-eligible').exists() implies parameter.where(name = 'condition').exists()
|
| 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:reason, Parameters.parameter:reason.extension, Parameters.parameter:reason.name, Parameters.parameter:reason.value[x], Parameters.parameter:reason.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:reason.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:reason | 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()))
|
This structure is derived from Parameters
Summary
Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 19 elements
Fixed: 6 elements
Prohibited: 12 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Parameters(4.0.1) | Operation Request or Response Constraints: access-unalign-condition-required |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
SΣC | 5..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name Constraints: inv-1 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: track |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.0) (required) |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSClinicalExclusionCondition(0.9.0) | Detailed information about conditions, problems or diagnoses |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: reason |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSUnalignmentReasonVS (0.9.0) (required) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.parameter:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.0 | This IG |
| Parameters.parameter:reason.value[x] | Base | required | ACCESS Unalignment Reason Value Set | 📍0.9.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCESS#### where #### represents exactly 4 digits (e.g., ACCESS0001, ACCESS1234) |
value.matches('^ACCESS\\d{4}$')
|
| access-unalign-condition-required | error | Parameters | When the unalignment reason is 'no-longer-clinically-eligible', at least one condition parameter must be provided to document the disqualifying diagnosis |
parameter.where(name = 'reason').value.ofType(CodeableConcept).coding.where(system = 'https://globalalliantinc.com/access/CodeSystem/ACCESSUnalignmentReasonCS' and code = 'no-longer-clinically-eligible').exists() implies parameter.where(name = 'condition').exists()
|
| ele-1 | error | Parameters.implicitRules, 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:reason, Parameters.parameter:reason.name, Parameters.parameter:reason.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:reason | 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
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Parameters(4.0.1) | Operation Request or Response |
![]() ![]() |
S | 5..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: participantID |
![]() ![]() ![]() ![]() |
SC | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: payerID |
![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: patient |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a data type | ||
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: track |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.0) (required) |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: condition |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a data type | ||
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSClinicalExclusionCondition(0.9.0) | Detailed information about conditions, problems or diagnoses |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Fixed Value: reason |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSUnalignmentReasonVS (0.9.0) (required) |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.parameter:track.value[x] | Base | required | ACCESS Model Tracks Value Set | 📍0.9.0 | This IG |
| Parameters.parameter:reason.value[x] | Base | required | ACCESS Unalignment Reason Value Set | 📍0.9.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCESS#### where #### represents exactly 4 digits (e.g., ACCESS0001, ACCESS1234) |
value.matches('^ACCESS\\d{4}$')
|
| access-unalign-condition-required | error | Parameters | When the unalignment reason is 'no-longer-clinically-eligible', at least one condition parameter must be provided to document the disqualifying diagnosis |
parameter.where(name = 'reason').value.ofType(CodeableConcept).coding.where(system = 'https://globalalliantinc.com/access/CodeSystem/ACCESSUnalignmentReasonCS' and code = 'no-longer-clinically-eligible').exists() implies parameter.where(name = 'condition').exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Parameters(4.0.1) | Operation Request or Response Constraints: access-unalign-condition-required | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
SΣC | 5..* | BackboneElement | Operation Parameter Slice: Unordered, Closed by value:name Constraints: inv-1 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | If parameter is a data type | |||||
![]() ![]() ![]() ![]() ![]() |
base64Binary | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
id | |||||||
![]() ![]() ![]() ![]() ![]() |
instant | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() ![]() |
oid | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() |
unsignedInt | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() ![]() |
uuid | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactPoint | |||||||
![]() ![]() ![]() ![]() ![]() |
Count | |||||||
![]() ![]() ![]() ![]() ![]() |
Distance | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
HumanName | |||||||
![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() ![]() |
Signature | |||||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() |
Contributor | |||||||
![]() ![]() ![]() ![]() ![]() |
DataRequirement | |||||||
![]() ![]() ![]() ![]() ![]() |
Expression | |||||||
![]() ![]() ![]() ![]() ![]() |
ParameterDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
RelatedArtifact | |||||||
![]() ![]() ![]() ![]() ![]() |
TriggerDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
UsageContext | |||||||
![]() ![]() ![]() ![]() ![]() |
Dosage | |||||||
![]() ![]() ![]() ![]() ![]() |
Meta | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: participantID | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type Constraints: access-participant-id-pattern | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: payerID | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: patient | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: track | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSTrackVS (0.9.0) (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: condition | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSClinicalExclusionCondition(0.9.0) | Detailed information about conditions, problems or diagnoses | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Fixed Value: reason | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | If parameter is a data type Binding: ACCESSUnalignmentReasonVS (0.9.0) (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
Documentation for this format | ||||||||
| 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.0 | This IG |
| Parameters.parameter:reason.value[x] | Base | required | ACCESS Unalignment Reason Value Set | 📍0.9.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| access-participant-id-pattern | error | Parameters.parameter:participantID.value[x] | ACCESS Participant ID must follow the pattern ACCESS#### where #### represents exactly 4 digits (e.g., ACCESS0001, ACCESS1234) |
value.matches('^ACCESS\\d{4}$')
|
| access-unalign-condition-required | error | Parameters | When the unalignment reason is 'no-longer-clinically-eligible', at least one condition parameter must be provided to document the disqualifying diagnosis |
parameter.where(name = 'reason').value.ofType(CodeableConcept).coding.where(system = 'https://globalalliantinc.com/access/CodeSystem/ACCESSUnalignmentReasonCS' and code = 'no-longer-clinically-eligible').exists() implies parameter.where(name = 'condition').exists()
|
| 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:reason, Parameters.parameter:reason.extension, Parameters.parameter:reason.name, Parameters.parameter:reason.value[x], Parameters.parameter:reason.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:reason.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:reason | 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()))
|
This structure is derived from Parameters
Summary
Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 19 elements
Fixed: 6 elements
Prohibited: 12 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron