Smart Health Checks
0.3.0 - ci-build

Smart Health Checks, published by AEHRC CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/smart-forms-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Smart Health Checks Patch AllergyIntolerance

Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCPatchAllergyIntolerance | Version: 0.3.0
Draft as of 2025-10-01 | Computable Name: SmartHealthChecksPatchAllergyIntolerance
Copyright/Legal: Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.

This profile sets the expectations for a Parameters resource when used to patch AllergyIntolerance resources within Smart Health Checks.

### Usage Scenarios

This profile supports updating AllergyIntolerance resource elements that are applicable to Smart Health Checks using the FHIRPath patch method. FHIRPath patch uses the Parameters resource to describe how a patch operation should be performed.

The elements that can be updated using this profile are as follows:

Profile | Element path
--- | ---
Smart Health Checks AllergyIntolerance | `AllergyIntolerance.clinicalStatus` `AllergyIntolerance.note[0].text`

### Profile Specific Implementation Guidance

- `Parameters.parameter.part:path.value[x]:valueString` SHALL identify one of the relevant AllergyIntolerance element paths included in the Smart Health Checks Patch AllergyIntolerance Element Path value set: `AllergyIntolerance` or `AllergyIntolerance.note[0]`.
- `Parameters.parameter.part:name.value[x]:valueString` SHALL identify one of the relevant AllergyIntolerance element paths included in the Smart Health Checks Patch AllergyIntolerance Element Name value set: `clinicalStatus`, `note` or `text`.
- When the path value is `AllergyIntolerance` and the name value is `clinicalStatus`:
  - `Parameters.parameter.part:value.value[x]` SHALL be of type `CodeableConcept`
  - `Parameters.parameter.part:value.value[x]:valueCodeableConcept` SHALL have a value from the Allergy Intolerance Clinical Status Minimal value set.
- When the path value is `AllergyIntolerance` and the name value is `note`:
  - `Parameters.parameter.part:value.value[x]` SHALL be of type `Annotation`.
- When the path value is `AllergyIntolerance.note[0]` and the name value is `text`:
  - `Parameters.parameter.part:value.value[x]` SHALL be of type `markdown`.

Illustrative examples are provided.

Usages:

- Use this Profile: Smart Health Checks Extract Bundle
- Examples for this Profile: Parameters/SHCPatchAllergyIntolerance1 and Parameters/SHCPatchAllergyIntolerance2
- CapabilityStatements using this Profile: SHC App and SHC Host FHIR Server

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks Constraints: shc-patch-allergy-intolerance-01, shc-patch-allergy-intolerance-02, shc-patch-allergy-intolerance-03
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
parameter | SO Σ C | 1..* | BackboneElement | Operation Parameter Constraints: inv-1
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for part | Σ | 4..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part: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
part:type | SO Σ | 1..1 | BackboneElement | Patch operation to perform
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | code | If parameter is a data type Fixed Value: add
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:path | SO Σ | 1..1 | BackboneElement | Where to perform the operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: path
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Path (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:name | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: name
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Name (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:value | SO Σ | 1..1 | BackboneElement | Replacement value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for value[x] | SO Σ C | 1..1 |  | If parameter is a data type Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
valueMarkdown |  |  | markdown |
valueAnnotation |  |  | Annotation |
valueCodeableConcept |  |  | CodeableConcept |
value[x]:valueCodeableConcept | S Σ C | 0..1 | CodeableConcept | If parameter is a data type Binding: Allergy Intolerance Clinical Status Minimal (required)
value[x]:valueMarkdown | SO Σ C | 0..1 | markdown | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
value[x]:valueAnnotation | SO Σ C | 0..1 | Annotation | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
part:pathLabel | SO Σ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
Obligations | Actor
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: pathLabel
Obligations | Actor
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type
Obligations | Actor
SHALL:populate | SHC App
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Parameters.parameter.​part:path.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Path | 📦0.3.0 | This IG
Parameters.parameter.​part:name.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Name | 📦0.3.0 | This IG
Parameters.parameter.​part:value.value[x]:valueCodeableConcept | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
inv-1 | error | Parameters.parameter | 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()))`
shc-patch-allergy-intolerance-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal')`
shc-patch-allergy-intolerance-02 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation`
shc-patch-allergy-intolerance-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown | `parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown`

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks Constraints: shc-patch-allergy-intolerance-01, shc-patch-allergy-intolerance-02, shc-patch-allergy-intolerance-03
parameter | SO | 1..* | BackboneElement | Operation Parameter
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for part |  | 4..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:type | SO | 1..1 | BackboneElement | Patch operation to perform
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO | 1..1 | code | If parameter is a data type Fixed Value: add
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:path | SO | 1..1 | BackboneElement | Where to perform the operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: path
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Path (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:name |  | 1..1 | BackboneElement | Named part of a multi-part parameter
name | SO | 1..1 | string | Name from the definition Fixed Value: name
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Name (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:value | SO | 1..1 | BackboneElement | Replacement value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for value[x] | SO C | 1..1 |  | If parameter is a data type Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
valueMarkdown |  |  | markdown |
valueAnnotation |  |  | Annotation |
valueCodeableConcept |  |  | CodeableConcept |
value[x]:valueCodeableConcept | S | 0..1 | CodeableConcept | If parameter is a data type Binding: Allergy Intolerance Clinical Status Minimal (required)
value[x]:valueMarkdown | SO | 0..1 | markdown | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
value[x]:valueAnnotation | SO | 0..1 | Annotation | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
text | SO | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
part:pathLabel | SO | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
Obligations | Actor
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: pathLabel
Obligations | Actor
SHALL:populate | SHC App
value[x] | SO | 1..1 | string | If parameter is a data type
Obligations | Actor
SHALL:populate | SHC App
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Parameters.parameter.​part:path.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Path | 📦0.3.0 | This IG
Parameters.parameter.​part:name.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Name | 📦0.3.0 | This IG
Parameters.parameter.​part:value.value[x]:valueCodeableConcept | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
shc-patch-allergy-intolerance-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal')`
shc-patch-allergy-intolerance-02 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation`
shc-patch-allergy-intolerance-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown | `parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks Constraints: shc-patch-allergy-intolerance-01, shc-patch-allergy-intolerance-02, shc-patch-allergy-intolerance-03
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
parameter | SO Σ C | 1..* | BackboneElement | Operation Parameter Constraints: inv-1
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | Σ | 4..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part: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
part:type | SO Σ | 1..1 | BackboneElement | Patch operation to perform
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | code | If parameter is a data type Fixed Value: add
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:path | SO Σ | 1..1 | BackboneElement | Where to perform the operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: path
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Path (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:name | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: name
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Name (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:value | SO Σ | 1..1 | BackboneElement | Replacement value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for value[x] | SO Σ C | 1..1 |  | If parameter is a data type Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
valueMarkdown |  |  | markdown |
valueAnnotation |  |  | Annotation |
valueCodeableConcept |  |  | CodeableConcept |
value[x]:valueCodeableConcept | S Σ C | 0..1 | CodeableConcept | If parameter is a data type Binding: Allergy Intolerance Clinical Status Minimal (required)
value[x]:valueMarkdown | SO Σ C | 0..1 | markdown | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
value[x]:valueAnnotation | SO Σ C | 0..1 | Annotation | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner | Patient | RelatedPerson | Organization) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:pathLabel | SO Σ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
Obligations | Actor
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: pathLabel
Obligations | Actor
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type
Obligations | Actor
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
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.​part:path.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Path | 📦0.3.0 | This IG
Parameters.parameter.​part:name.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Name | 📦0.3.0 | This IG
Parameters.parameter.​part:value.value[x]:valueCodeableConcept | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
inv-1 | error | Parameters.parameter | 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()))`
shc-patch-allergy-intolerance-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal')`
shc-patch-allergy-intolerance-02 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation`
shc-patch-allergy-intolerance-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown | `parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown`

This structure is derived from Parameters

Summary

Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 20 elements
Fixed: 7 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter.part
- The element 1 is sliced based on the value of Parameters.parameter.part.value[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks Constraints: shc-patch-allergy-intolerance-01, shc-patch-allergy-intolerance-02, shc-patch-allergy-intolerance-03
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
parameter | SO Σ C | 1..* | BackboneElement | Operation Parameter Constraints: inv-1
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for part | Σ | 4..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part: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
part:type | SO Σ | 1..1 | BackboneElement | Patch operation to perform
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | code | If parameter is a data type Fixed Value: add
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:path | SO Σ | 1..1 | BackboneElement | Where to perform the operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: path
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Path (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:name | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: name
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Name (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:value | SO Σ | 1..1 | BackboneElement | Replacement value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for value[x] | SO Σ C | 1..1 |  | If parameter is a data type Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
valueMarkdown |  |  | markdown |
valueAnnotation |  |  | Annotation |
valueCodeableConcept |  |  | CodeableConcept |
value[x]:valueCodeableConcept | S Σ C | 0..1 | CodeableConcept | If parameter is a data type Binding: Allergy Intolerance Clinical Status Minimal (required)
value[x]:valueMarkdown | SO Σ C | 0..1 | markdown | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
value[x]:valueAnnotation | SO Σ C | 0..1 | Annotation | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
part:pathLabel | SO Σ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
Obligations | Actor
SHALL:populate | SHC App
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: pathLabel
Obligations | Actor
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type
Obligations | Actor
SHALL:populate | SHC App
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Parameters.parameter.​part:path.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Path | 📦0.3.0 | This IG
Parameters.parameter.​part:name.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Name | 📦0.3.0 | This IG
Parameters.parameter.​part:value.value[x]:valueCodeableConcept | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
inv-1 | error | Parameters.parameter | 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()))`
shc-patch-allergy-intolerance-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal')`
shc-patch-allergy-intolerance-02 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation`
shc-patch-allergy-intolerance-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown | `parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown`

Differential View

This structure is derived from Parameters

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks Constraints: shc-patch-allergy-intolerance-01, shc-patch-allergy-intolerance-02, shc-patch-allergy-intolerance-03
parameter | SO | 1..* | BackboneElement | Operation Parameter
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for part |  | 4..* |  | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part:type | SO | 1..1 | BackboneElement | Patch operation to perform
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO | 1..1 | code | If parameter is a data type Fixed Value: add
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:path | SO | 1..1 | BackboneElement | Where to perform the operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: path
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Path (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:name |  | 1..1 | BackboneElement | Named part of a multi-part parameter
name | SO | 1..1 | string | Name from the definition Fixed Value: name
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Name (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
part:value | SO | 1..1 | BackboneElement | Replacement value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for value[x] | SO C | 1..1 |  | If parameter is a data type Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
valueMarkdown |  |  | markdown |
valueAnnotation |  |  | Annotation |
valueCodeableConcept |  |  | CodeableConcept |
value[x]:valueCodeableConcept | S | 0..1 | CodeableConcept | If parameter is a data type Binding: Allergy Intolerance Clinical Status Minimal (required)
value[x]:valueMarkdown | SO | 0..1 | markdown | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
value[x]:valueAnnotation | SO | 0..1 | Annotation | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
text | SO | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
part:pathLabel | SO | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
Obligations | Actor
SHALL:populate | SHC App
name | SO | 1..1 | string | Name from the definition Fixed Value: pathLabel
Obligations | Actor
SHALL:populate | SHC App
value[x] | SO | 1..1 | string | If parameter is a data type
Obligations | Actor
SHALL:populate | SHC App
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Parameters.parameter.​part:path.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Path | 📦0.3.0 | This IG
Parameters.parameter.​part:name.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Name | 📦0.3.0 | This IG
Parameters.parameter.​part:value.value[x]:valueCodeableConcept | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
shc-patch-allergy-intolerance-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal')`
shc-patch-allergy-intolerance-02 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation`
shc-patch-allergy-intolerance-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown | `parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Parameters | C | 0..* | Parameters | Parameters for patching AllergyIntolerance resource elements supported in Smart Health Checks Constraints: shc-patch-allergy-intolerance-01, shc-patch-allergy-intolerance-02, shc-patch-allergy-intolerance-03
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
parameter | SO Σ C | 1..* | BackboneElement | Operation Parameter Constraints: inv-1
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | Σ C | 0..1 |  | If parameter is a data type
valueBase64Binary |  |  | base64Binary |
valueBoolean |  |  | boolean |
valueCanonical |  |  | canonical(Any) |
valueCode |  |  | code |
valueDate |  |  | date |
valueDateTime |  |  | dateTime |
valueDecimal |  |  | decimal |
valueId |  |  | id |
valueInstant |  |  | instant |
valueInteger |  |  | integer |
valueMarkdown |  |  | markdown |
valueOid |  |  | oid |
valuePositiveInt |  |  | positiveInt |
valueString |  |  | string |
valueTime |  |  | time |
valueUnsignedInt |  |  | unsignedInt |
valueUri |  |  | uri |
valueUrl |  |  | url |
valueUuid |  |  | uuid |
valueAddress |  |  | Address |
valueAge |  |  | Age |
valueAnnotation |  |  | Annotation |
valueAttachment |  |  | Attachment |
valueCodeableConcept |  |  | CodeableConcept |
valueCoding |  |  | Coding |
valueContactPoint |  |  | ContactPoint |
valueCount |  |  | Count |
valueDistance |  |  | Distance |
valueDuration |  |  | Duration |
valueHumanName |  |  | HumanName |
valueIdentifier |  |  | Identifier |
valueMoney |  |  | Money |
valuePeriod |  |  | Period |
valueQuantity |  |  | Quantity |
valueRange |  |  | Range |
valueRatio |  |  | Ratio |
valueReference |  |  | Reference(Any) |
valueSampledData |  |  | SampledData |
valueSignature |  |  | Signature |
valueTiming |  |  | Timing |
valueContactDetail |  |  | ContactDetail |
valueContributor |  |  | Contributor |
valueDataRequirement |  |  | DataRequirement |
valueExpression |  |  | Expression |
valueParameterDefinition |  |  | ParameterDefinition |
valueRelatedArtifact |  |  | RelatedArtifact |
valueTriggerDefinition |  |  | TriggerDefinition |
valueUsageContext |  |  | UsageContext |
valueDosage |  |  | Dosage |
valueMeta |  |  | Meta |
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
Slices for part | Σ | 4..* | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name
part: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
part:type | SO Σ | 1..1 | BackboneElement | Patch operation to perform
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | code | If parameter is a data type Fixed Value: add
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:path | SO Σ | 1..1 | BackboneElement | Where to perform the operation
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: path
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Path (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:name | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | SO Σ | 1..1 | string | Name from the definition Fixed Value: name
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch AllergyIntolerance Element Name (required)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:value | SO Σ | 1..1 | BackboneElement | Replacement value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: value
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
Slices for value[x] | SO Σ C | 1..1 |  | If parameter is a data type Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate | SHC App
valueMarkdown |  |  | markdown |
valueAnnotation |  |  | Annotation |
valueCodeableConcept |  |  | CodeableConcept |
value[x]:valueCodeableConcept | S Σ C | 0..1 | CodeableConcept | If parameter is a data type Binding: Allergy Intolerance Clinical Status Minimal (required)
value[x]:valueMarkdown | SO Σ C | 0..1 | markdown | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
value[x]:valueAnnotation | SO Σ C | 0..1 | Annotation | If parameter is a data type
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner | Patient | RelatedPerson | Organization) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | SO Σ | 1..1 | markdown | The annotation - text content (as markdown)
Obligations | Actor
SHALL:process | SHC Host FHIR Server
SHALL:populate-if-known | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter
part:pathLabel | SO Σ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
Obligations | Actor
SHALL:populate | SHC App
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 | SO Σ | 1..1 | string | Name from the definition Fixed Value: pathLabel
Obligations | Actor
SHALL:populate | SHC App
value[x] | SO Σ C | 1..1 | string | If parameter is a data type
Obligations | Actor
SHALL:populate | SHC App
resource | Σ C | 0..1 | Resource | If parameter is a whole resource
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.​part:path.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Path | 📦0.3.0 | This IG
Parameters.parameter.​part:name.value[x] | Base | required | Smart Health Checks Patch AllergyIntolerance Element Name | 📦0.3.0 | This IG
Parameters.parameter.​part:value.value[x]:valueCodeableConcept | Base | required | Allergy Intolerance Clinical Status Minimal | 📦0.3.0 | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
inv-1 | error | Parameters.parameter | 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()))`
shc-patch-allergy-intolerance-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'clinicalStatus').part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal')`
shc-patch-allergy-intolerance-02 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance' and the part parameter named 'name' has a value of 'note', the part parameter named 'value' SHALL have a value of type Annotation | `parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance' and part.where(name='name').value = 'note').part.where(name='value').value is Annotation`
shc-patch-allergy-intolerance-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.note[0]' and the part parameter named 'name' has a value of 'text', the part parameter named 'value' SHALL have a value of type markdown | `parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').exists() implies parameter.where(part.where(name='path').value = 'AllergyIntolerance.note[0]' and part.where(name='name').value = 'text').part.where(name='value').value is markdown`

This structure is derived from Parameters

Summary

Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 20 elements
Fixed: 7 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Parameters.parameter.part
- The element 1 is sliced based on the value of Parameters.parameter.part.value[x]

Other representations of profile: CSV, Excel, Schematron