Smart Health Checks
0.3.0 - ci-build
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
| Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCPatch | Version: 0.3.0 | |||
| Draft as of 2025-09-23 | Computable Name: SmartHealthChecksPatch | |||
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 resources within Smart Health Checks.
This profile supports updating resources relevant to Smart Health Checks using the FHIRPath patch method. FHIRPath patch uses the Parameters resource to describe how a patch operation should be performed.
It describes how to represent patch operations against several specific elements in three different resource types. The resources and elements that can be updated using this profile are as follows:
| Profile | Patch element path |
|---|---|
| Smart Health Checks AllergyIntolerance |
|
| Smart Health Checks Condition |
|
| Smart Health Checks MedicationStatement |
|
Each resource to be patched requires a separate Parameters resource that includes the details of the operation. This section describes SHC Patch Parameters profile requirements applicable to updating each of the allowed resource profiles.
Parameters.parameter.part:path.value[x]:valueString SHALL identify one of the relevant AllergyIntolerance element paths included in the Smart Health Checks Patch Path value set: AllergyIntolerance.clinicalStatus or AllergyIntolerance.note[0].text.AllergyIntolerance.clinicalStatus:
Parameters.parameter.part:value.value[x] SHALL be of type CodeableConceptParameters.parameter.part:value.value[x]:valueCodeableConcept.coding SHALL have a value from the Allergy Intolerance Clinical Status Minimal value set.AllergyIntolerance.note[0].text:
Parameters.parameter.part:value.value[x] SHALL be of type markdown.Parameters.parameter.part:path.value[x]:valueString SHALL identify one of the relevant Condition element paths included in the Smart Health Checks Patch Path value set: Condition.clinicalStatus or Condition.abatement.Condition.clinicalStatus:
Parameters.parameter.part:value.value[x] SHALL be of type CodeableConceptParameters.parameter.part:value.value[x]:valueCodeableConcept.coding SHALL have a value from the Condition Clinical Status Codes value set.Condition.abatement:
Parameters.parameter.part:value.value[x] SHALL be of type dateTime.Parameters.parameter.part:path.value[x]:valueString SHALL identify one of the relevant MedicationStatement element paths included in the Smart Health Checks Patch Path value set: MedicationStatement.status, MedicationStatement.note[0].text or MedicationStatement.dosage[0].text.MedicationStatement.status:
Parameters.parameter.part:value.value[x] SHALL be of type codeParameters.parameter.part:value.value[x]:valueCode SHALL have a value from the Medication Statement Status Limited value set.MedicationStatement.note[0].text:
Parameters.parameter.part:value.value[x] SHALL be of type markdown.MedicationStatement.dosage[0].text:
Parameters.parameter.part:value.value[x] SHALL be of type string.Examples are provided to illustrate Parameters resources to patch the supported elements and resources.
Parameters.parameter.part:value.value[x] has Must Support obligations on each of the allowed data types. Due to a validation issue, it is not currently possible to have slices defined for both valueCode and valueString. For that reason, valueString is not currently defined as a slice and does not have Must Support obligations included in the StructureDefinition.
valueString is to be considered a Must Support data type with the same obligations as the other allowed data types (as below).
| Obligations | Actor |
|---|---|
SHALL:process |
SHC Host FHIR Server |
SHALL:populate-if-known |
SHC App |
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:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Parameters |
C | 0..* | Parameters | Parameters for patching elements supported in Smart Health Checks Constraints: shc-patch-01, shc-patch-02, shc-patch-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
| ||||||
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Parameters for element patching Fixed Value: operation
| ||||||
 Slices for part |
Σ | 3..* | 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
| ||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: type
| ||||||
 value[x] |
SOΣC | 1..1 | code | If parameter is a data type Fixed Value: replace
| ||||||
| part:path |
SOΣ | 1..1 | BackboneElement | Where to perform the operation
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: path
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch Path (required)
| ||||||
| part:value |
SOΣ | 1..1 | BackboneElement | Replacement value
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: value
| ||||||
 Slices for value[x] |
SOΣC | 1..1 | If parameter is a data type Slice: Unordered, Open by type:$this
| |||||||
| valueCode |
code | |||||||||
| valueDateTime |
dateTime | |||||||||
| valueMarkdown |
markdown | |||||||||
| valueString |
string | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| value[x]:valueCode |
SΣC | 0..1 | code | If parameter is a data type Binding: Medication Statement Status Limited (required) | ||||||
| value[x]:valueCodeableConcept |
SΣC | 0..1 | CodeableConcept | If parameter is a data type | ||||||
| Slices for coding |
SOΣ | 1..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
| ||||||
| coding:AllergyIntoleranceClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Allergy Intolerance Clinical Status Minimal (required)
| ||||||
| coding:ConditionClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: ConditionClinicalStatusCodes (required)
| ||||||
| value[x]:valueDateTime |
SOΣC | 0..1 | dateTime | If parameter is a data type
| ||||||
| value[x]:valueMarkdown |
SOΣC | 0..1 | markdown | If parameter is a data type
| ||||||
 part:pathLabel |
SOΣ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: pathLabel
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Parameters.parameter.part:path.value[x] | required | SHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)https://smartforms.csiro.au/ig/ValueSet/SHCPatchPathFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCode | required | MedicationStatementStatusLimitedhttps://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimitedFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | required | AllergyIntoleranceClinicalStatusMinimalhttps://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimalFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinicalFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') | |
| shc-patch-02 | error | Parameters | When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. : parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') | |
| shc-patch-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') |
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters | Parameters for patching elements supported in Smart Health Checks Constraints: shc-patch-01, shc-patch-02, shc-patch-03 | ||||||
| parameter |
SO | 1..* | BackboneElement | Operation Parameter
| ||||||
| name |
SO | 1..1 | string | Parameters for element patching Fixed Value: operation
| ||||||
| Slices for part |
3..* | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||||||
| part:type |
SO | 1..1 | BackboneElement | Patch operation to perform
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: type
| ||||||
| value[x] |
SO | 1..1 | code | If parameter is a data type Fixed Value: replace
| ||||||
| part:path |
SO | 1..1 | BackboneElement | Where to perform the operation
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: path
| ||||||
| value[x] |
SO | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch Path (required)
| ||||||
| part:value |
SO | 1..1 | BackboneElement | Replacement value
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: value
| ||||||
| Slices for value[x] |
SOC | 1..1 | If parameter is a data type Slice: Unordered, Open by type:$this
| |||||||
| valueCode |
code | |||||||||
| valueDateTime |
dateTime | |||||||||
| valueMarkdown |
markdown | |||||||||
| valueString |
string | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| value[x]:valueCode |
S | 0..1 | code | If parameter is a data type Binding: Medication Statement Status Limited (required) | ||||||
| value[x]:valueCodeableConcept |
S | 0..1 | CodeableConcept | If parameter is a data type | ||||||
| Slices for coding |
SO | 1..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
| ||||||
| coding:AllergyIntoleranceClinicalStatusCodes |
SO | 0..1 | Coding | Code defined by a terminology system Binding: Allergy Intolerance Clinical Status Minimal (required)
| ||||||
| coding:ConditionClinicalStatusCodes |
SO | 0..1 | Coding | Code defined by a terminology system Binding: ConditionClinicalStatusCodes (required)
| ||||||
| value[x]:valueDateTime |
SO | 0..1 | dateTime | If parameter is a data type
| ||||||
| value[x]:valueMarkdown |
SO | 0..1 | markdown | If parameter is a data type
| ||||||
| part:pathLabel |
SO | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: pathLabel
| ||||||
| value[x] |
SO | 1..1 | string | If parameter is a data type
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Parameters.parameter.part:path.value[x] | required | SHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)https://smartforms.csiro.au/ig/ValueSet/SHCPatchPathFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCode | required | MedicationStatementStatusLimitedhttps://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimitedFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | required | AllergyIntoleranceClinicalStatusMinimalhttps://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimalFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinicalFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| shc-patch-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') | |
| shc-patch-02 | error | Parameters | When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. : parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') | |
| shc-patch-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters | Parameters for patching elements supported in Smart Health Checks Constraints: shc-patch-01, shc-patch-02, shc-patch-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.
| |||||||
| parameter |
SOΣC | 1..* | BackboneElement | Operation Parameter Constraints: inv-1
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Parameters for element patching Fixed Value: operation
| ||||||
  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 |
Σ | 3..* | 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
| ||||||
| 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
| ||||||
| value[x] |
SOΣC | 1..1 | code | If parameter is a data type Fixed Value: replace
| ||||||
| 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
| ||||||
| 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
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch Path (required)
| ||||||
| 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
| ||||||
| 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
| ||||||
 Slices for value[x] |
SOΣC | 1..1 | If parameter is a data type Slice: Unordered, Open by type:$this
| |||||||
 valueCode |
code | |||||||||
| valueDateTime |
dateTime | |||||||||
| valueMarkdown |
markdown | |||||||||
| valueString |
string | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| value[x]:valueCode |
SΣC | 0..1 | code | If parameter is a data type Binding: Medication Statement Status Limited (required) | ||||||
| value[x]:valueCodeableConcept |
SΣC | 0..1 | CodeableConcept | If parameter is a data type | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| Slices for coding |
SOΣ | 1..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
| ||||||
| coding:AllergyIntoleranceClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Allergy Intolerance Clinical Status Minimal (required)
| ||||||
| coding:ConditionClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: ConditionClinicalStatusCodes (required)
| ||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
| value[x]:valueDateTime |
SOΣC | 0..1 | dateTime | If parameter is a data type
| ||||||
| value[x]:valueMarkdown |
SOΣC | 0..1 | markdown | If parameter is a data type
| ||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||||
| part:pathLabel |
SOΣ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
| ||||||
| 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
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type
| ||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Parameters.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Parameters.parameter.part:path.value[x] | required | SHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)https://smartforms.csiro.au/ig/ValueSet/SHCPatchPathFrom this IG | ||||
| Parameters.parameter.part:value.value[x]:valueCode | required | MedicationStatementStatusLimitedhttps://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimitedFrom this IG | ||||
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | required | AllergyIntoleranceClinicalStatusMinimalhttps://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimalFrom this IG | ||||
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinicalFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') | |
| shc-patch-02 | error | Parameters | When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. : parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') | |
| shc-patch-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') |
This structure is derived from Parameters
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 21 elements
Fixed: 6 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters | Parameters for patching elements supported in Smart Health Checks Constraints: shc-patch-01, shc-patch-02, shc-patch-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
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Parameters for element patching Fixed Value: operation
| ||||||
| Slices for part |
Σ | 3..* | 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
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: type
| ||||||
| value[x] |
SOΣC | 1..1 | code | If parameter is a data type Fixed Value: replace
| ||||||
| part:path |
SOΣ | 1..1 | BackboneElement | Where to perform the operation
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: path
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch Path (required)
| ||||||
| part:value |
SOΣ | 1..1 | BackboneElement | Replacement value
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: value
| ||||||
| Slices for value[x] |
SOΣC | 1..1 | If parameter is a data type Slice: Unordered, Open by type:$this
| |||||||
| valueCode |
code | |||||||||
| valueDateTime |
dateTime | |||||||||
| valueMarkdown |
markdown | |||||||||
| valueString |
string | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| value[x]:valueCode |
SΣC | 0..1 | code | If parameter is a data type Binding: Medication Statement Status Limited (required) | ||||||
| value[x]:valueCodeableConcept |
SΣC | 0..1 | CodeableConcept | If parameter is a data type | ||||||
| Slices for coding |
SOΣ | 1..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
| ||||||
| coding:AllergyIntoleranceClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Allergy Intolerance Clinical Status Minimal (required)
| ||||||
| coding:ConditionClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: ConditionClinicalStatusCodes (required)
| ||||||
| value[x]:valueDateTime |
SOΣC | 0..1 | dateTime | If parameter is a data type
| ||||||
| value[x]:valueMarkdown |
SOΣC | 0..1 | markdown | If parameter is a data type
| ||||||
| part:pathLabel |
SOΣ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
| ||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Name from the definition Fixed Value: pathLabel
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Parameters.parameter.part:path.value[x] | required | SHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)https://smartforms.csiro.au/ig/ValueSet/SHCPatchPathFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCode | required | MedicationStatementStatusLimitedhttps://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimitedFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | required | AllergyIntoleranceClinicalStatusMinimalhttps://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimalFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinicalFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') | |
| shc-patch-02 | error | Parameters | When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. : parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') | |
| shc-patch-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') |
Differential View
This structure is derived from Parameters
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters | Parameters for patching elements supported in Smart Health Checks Constraints: shc-patch-01, shc-patch-02, shc-patch-03 | ||||||
| parameter |
SO | 1..* | BackboneElement | Operation Parameter
| ||||||
| name |
SO | 1..1 | string | Parameters for element patching Fixed Value: operation
| ||||||
| Slices for part |
3..* | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||||||
| part:type |
SO | 1..1 | BackboneElement | Patch operation to perform
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: type
| ||||||
| value[x] |
SO | 1..1 | code | If parameter is a data type Fixed Value: replace
| ||||||
| part:path |
SO | 1..1 | BackboneElement | Where to perform the operation
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: path
| ||||||
| value[x] |
SO | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch Path (required)
| ||||||
| part:value |
SO | 1..1 | BackboneElement | Replacement value
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: value
| ||||||
| Slices for value[x] |
SOC | 1..1 | If parameter is a data type Slice: Unordered, Open by type:$this
| |||||||
| valueCode |
code | |||||||||
| valueDateTime |
dateTime | |||||||||
| valueMarkdown |
markdown | |||||||||
| valueString |
string | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| value[x]:valueCode |
S | 0..1 | code | If parameter is a data type Binding: Medication Statement Status Limited (required) | ||||||
| value[x]:valueCodeableConcept |
S | 0..1 | CodeableConcept | If parameter is a data type | ||||||
| Slices for coding |
SO | 1..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
| ||||||
| coding:AllergyIntoleranceClinicalStatusCodes |
SO | 0..1 | Coding | Code defined by a terminology system Binding: Allergy Intolerance Clinical Status Minimal (required)
| ||||||
| coding:ConditionClinicalStatusCodes |
SO | 0..1 | Coding | Code defined by a terminology system Binding: ConditionClinicalStatusCodes (required)
| ||||||
| value[x]:valueDateTime |
SO | 0..1 | dateTime | If parameter is a data type
| ||||||
| value[x]:valueMarkdown |
SO | 0..1 | markdown | If parameter is a data type
| ||||||
| part:pathLabel |
SO | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
| ||||||
| name |
SO | 1..1 | string | Name from the definition Fixed Value: pathLabel
| ||||||
| value[x] |
SO | 1..1 | string | If parameter is a data type
| ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Parameters.parameter.part:path.value[x] | required | SHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)https://smartforms.csiro.au/ig/ValueSet/SHCPatchPathFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCode | required | MedicationStatementStatusLimitedhttps://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimitedFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | required | AllergyIntoleranceClinicalStatusMinimalhttps://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimalFrom this IG | |
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinicalFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| shc-patch-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') | |
| shc-patch-02 | error | Parameters | When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. : parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') | |
| shc-patch-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Parameters |
C | 0..* | Parameters | Parameters for patching elements supported in Smart Health Checks Constraints: shc-patch-01, shc-patch-02, shc-patch-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.
| |||||||
| parameter |
SOΣC | 1..* | BackboneElement | Operation Parameter Constraints: inv-1
| ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
| name |
SOΣ | 1..1 | string | Parameters for element patching Fixed Value: operation
| ||||||
| 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 |
Σ | 3..* | 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
| ||||||
| 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
| ||||||
| value[x] |
SOΣC | 1..1 | code | If parameter is a data type Fixed Value: replace
| ||||||
| 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
| ||||||
| 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
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type Binding: Smart Health Checks Patch Path (required)
| ||||||
| 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
| ||||||
| 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
| ||||||
| Slices for value[x] |
SOΣC | 1..1 | If parameter is a data type Slice: Unordered, Open by type:$this
| |||||||
| valueCode |
code | |||||||||
| valueDateTime |
dateTime | |||||||||
| valueMarkdown |
markdown | |||||||||
| valueString |
string | |||||||||
| valueCodeableConcept |
CodeableConcept | |||||||||
| value[x]:valueCode |
SΣC | 0..1 | code | If parameter is a data type Binding: Medication Statement Status Limited (required) | ||||||
| value[x]:valueCodeableConcept |
SΣC | 0..1 | CodeableConcept | If parameter is a data type | ||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| Slices for coding |
SOΣ | 1..1 | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
| ||||||
| coding:AllergyIntoleranceClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: Allergy Intolerance Clinical Status Minimal (required)
| ||||||
| coding:ConditionClinicalStatusCodes |
SOΣ | 0..1 | Coding | Code defined by a terminology system Binding: ConditionClinicalStatusCodes (required)
| ||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
| value[x]:valueDateTime |
SOΣC | 0..1 | dateTime | If parameter is a data type
| ||||||
| value[x]:valueMarkdown |
SOΣC | 0..1 | markdown | If parameter is a data type
| ||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||||
| part:pathLabel |
SOΣ | 0..1 | BackboneElement | Human readable representation of the path. Typically this is the relevant item text from the Questionnaire.
| ||||||
| 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
| ||||||
| value[x] |
SOΣC | 1..1 | string | If parameter is a data type
| ||||||
| resource |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||||
| part |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||||
| Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Parameters.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Parameters.parameter.part:path.value[x] | required | SHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)https://smartforms.csiro.au/ig/ValueSet/SHCPatchPathFrom this IG | ||||
| Parameters.parameter.part:value.value[x]:valueCode | required | MedicationStatementStatusLimitedhttps://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimitedFrom this IG | ||||
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodes | required | AllergyIntoleranceClinicalStatusMinimalhttps://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimalFrom this IG | ||||
| Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodes | required | ConditionClinicalStatusCodeshttp://hl7.org/fhir/ValueSet/condition-clinicalFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| 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-01 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'AllergyIntolerance.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal') | |
| shc-patch-02 | error | Parameters | When the part parameter named 'path' has a value of 'Condition.clinicalStatus', the part parameter named 'value' SHALL have a value from the Condition Clinical Status Codes' value set. : parameter.part.where(name='path').value = 'Condition.clinicalStatus' implies parameter.part.where(name='value').value.memberOf('http://hl7.org/fhir/ValueSet/condition-clinical') | |
| shc-patch-03 | error | Parameters | When the part parameter named 'path' has a value of 'AllergyIntolerance.clinicalStatus', the part parameter named 'value' SHALL have a value from the 'Allergy Intolerance Clinical Status Minimal' value set. : parameter.part.where(name='path').value = 'MedicationStatement.status' implies parameter.part.where(name='value').value.memberOf('https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited') |
This structure is derived from Parameters
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 21 elements
Fixed: 6 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron