Smart Health Checks
0.3.0 - ci-build Australia flag

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

Official URL: https://smartforms.csiro.au/ig/StructureDefinition/SHCPatch Version: 0.3.0
Draft as of 2025-09-05 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.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
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 Parameters for element patching
Fixed Value: operation
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... 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
ObligationsActor
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
ObligationsActor
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: replace
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:path SOΣ 1..1 BackboneElement Where to perform the operation
ObligationsActor
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
ObligationsActor
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 Path (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:value SOΣ 1..1 BackboneElement Replacement value
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... Slices for value[x] ΣC 1..1 If parameter is a data type
Slice: Unordered, Closed by type:$this
....... valueCode code
....... valueDateTime dateTime
....... valueMarkdown markdown
....... valueString string
....... valueCodeableConcept CodeableConcept
....... value[x]:valueCode SOΣC 0..1 code If parameter is a data type
Binding: Medication Statement Status Limited (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueCodeableConcept SOΣC 0..1 CodeableConcept If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
........ Slices for coding Σ 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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
......... coding:ConditionClinicalStatusCodes SOΣ 0..1 Coding Code defined by a terminology system
Binding: ConditionClinicalStatusCodes (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueDateTime SOΣC 0..1 dateTime If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueString SOΣC 0..1 string If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueMarkdown SOΣC 0..1 markdown If parameter is a data type
ObligationsActor
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.
ObligationsActor
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
ObligationsActor
SHALL:populate SHC App
...... value[x] SOΣC 1..1 string If parameter is a data type
ObligationsActor
SHALL:populate SHC App

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter.part:path.value[x]requiredSHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)
https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath
From this IG
Parameters.parameter.part:value.value[x]:valueCoderequiredMedicationStatementStatusLimited
https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodesrequiredAllergyIntoleranceClinicalStatusMinimal
https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodesrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameterA 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-01errorParametersWhen 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-02errorParametersWhen 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-03errorParametersWhen 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... name SO 1..1 string Parameters for element patching
Fixed Value: operation
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... value[x] SO 1..1 code If parameter is a data type
Fixed Value: replace
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:path SO 1..1 BackboneElement Where to perform the operation
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: path
ObligationsActor
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 Path (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:value SO 1..1 BackboneElement Replacement value
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: value
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... Slices for value[x] 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]:code SO 0..1 code If parameter is a data type
Binding: Medication Statement Status Limited (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:CodeableConcept SO 0..1 CodeableConcept If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
........ Slices for coding 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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
......... coding:ConditionClinicalStatusCodes SO 0..1 Coding Code defined by a terminology system
Binding: ConditionClinicalStatusCodes (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:dateTime SO 0..1 dateTime If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:string SO 0..1 string If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:markdown SO 0..1 markdown If parameter is a data type
ObligationsActor
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.
ObligationsActor
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: pathLabel
ObligationsActor
SHALL:populate SHC App
...... value[x] SO 1..1 string If parameter is a data type
ObligationsActor
SHALL:populate SHC App

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Parameters.parameter.part:path.value[x]requiredSHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)
https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath
From this IG
Parameters.parameter.part:value.value[x]:coderequiredMedicationStatementStatusLimited
https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited
From this IG
Parameters.parameter.part:value.value[x]:CodeableConcept.coding:AllergyIntoleranceClinicalStatusCodesrequiredAllergyIntoleranceClinicalStatusMinimal
https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal
From this IG
Parameters.parameter.part:value.value[x]:CodeableConcept.coding:ConditionClinicalStatusCodesrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical
From this IG

Constraints

IdGradePath(s)DetailsRequirements
shc-patch-01errorParametersWhen 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-02errorParametersWhen 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-03errorParametersWhen 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')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... parameter SOΣC 1..* BackboneElement Operation Parameter
Constraints: inv-1
ObligationsActor
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 Parameters for element patching
Fixed Value: operation
ObligationsActor
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 Σ 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
ObligationsActor
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
ObligationsActor
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: replace
ObligationsActor
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
ObligationsActor
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
ObligationsActor
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 Path (required)
ObligationsActor
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
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... Slices for value[x] ΣC 1..1 If parameter is a data type
Slice: Unordered, Closed by type:$this
....... valueCode code
....... valueDateTime dateTime
....... valueMarkdown markdown
....... valueString string
....... valueCodeableConcept CodeableConcept
....... value[x]:valueCode SOΣC 0..1 code If parameter is a data type
Binding: Medication Statement Status Limited (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueCodeableConcept SOΣC 0..1 CodeableConcept If parameter is a data type
ObligationsActor
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
........ Slices for coding Σ 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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
......... coding:ConditionClinicalStatusCodes SOΣ 0..1 Coding Code defined by a terminology system
Binding: ConditionClinicalStatusCodes (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
........ text Σ 0..1 string Plain text representation of the concept
....... value[x]:valueDateTime SOΣC 0..1 dateTime If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueString SOΣC 0..1 string If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueMarkdown SOΣC 0..1 markdown If parameter is a data type
ObligationsActor
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.
ObligationsActor
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
ObligationsActor
SHALL:populate SHC App
...... value[x] SOΣC 1..1 string If parameter is a data type
ObligationsActor
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter.part:path.value[x]requiredSHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)
https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath
From this IG
Parameters.parameter.part:value.value[x]:valueCoderequiredMedicationStatementStatusLimited
https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodesrequiredAllergyIntoleranceClinicalStatusMinimal
https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodesrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameterA 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-01errorParametersWhen 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-02errorParametersWhen 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-03errorParametersWhen 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: 20 elements
Fixed: 6 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]
  • The element 1 is sliced based on the value of Parameters.parameter.part.value[x].coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
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 Parameters for element patching
Fixed Value: operation
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... 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
ObligationsActor
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
ObligationsActor
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: replace
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:path SOΣ 1..1 BackboneElement Where to perform the operation
ObligationsActor
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
ObligationsActor
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 Path (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:value SOΣ 1..1 BackboneElement Replacement value
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... Slices for value[x] ΣC 1..1 If parameter is a data type
Slice: Unordered, Closed by type:$this
....... valueCode code
....... valueDateTime dateTime
....... valueMarkdown markdown
....... valueString string
....... valueCodeableConcept CodeableConcept
....... value[x]:valueCode SOΣC 0..1 code If parameter is a data type
Binding: Medication Statement Status Limited (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueCodeableConcept SOΣC 0..1 CodeableConcept If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
........ Slices for coding Σ 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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
......... coding:ConditionClinicalStatusCodes SOΣ 0..1 Coding Code defined by a terminology system
Binding: ConditionClinicalStatusCodes (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueDateTime SOΣC 0..1 dateTime If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueString SOΣC 0..1 string If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueMarkdown SOΣC 0..1 markdown If parameter is a data type
ObligationsActor
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.
ObligationsActor
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
ObligationsActor
SHALL:populate SHC App
...... value[x] SOΣC 1..1 string If parameter is a data type
ObligationsActor
SHALL:populate SHC App

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter.part:path.value[x]requiredSHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)
https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath
From this IG
Parameters.parameter.part:value.value[x]:valueCoderequiredMedicationStatementStatusLimited
https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodesrequiredAllergyIntoleranceClinicalStatusMinimal
https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodesrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameterA 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-01errorParametersWhen 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-02errorParametersWhen 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-03errorParametersWhen 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... name SO 1..1 string Parameters for element patching
Fixed Value: operation
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
.... 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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... value[x] SO 1..1 code If parameter is a data type
Fixed Value: replace
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:path SO 1..1 BackboneElement Where to perform the operation
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: path
ObligationsActor
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 Path (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
..... part:value SO 1..1 BackboneElement Replacement value
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: value
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... Slices for value[x] 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]:code SO 0..1 code If parameter is a data type
Binding: Medication Statement Status Limited (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:CodeableConcept SO 0..1 CodeableConcept If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
........ Slices for coding 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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
......... coding:ConditionClinicalStatusCodes SO 0..1 Coding Code defined by a terminology system
Binding: ConditionClinicalStatusCodes (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:dateTime SO 0..1 dateTime If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:string SO 0..1 string If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:markdown SO 0..1 markdown If parameter is a data type
ObligationsActor
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.
ObligationsActor
SHALL:populate SHC App
...... name SO 1..1 string Name from the definition
Fixed Value: pathLabel
ObligationsActor
SHALL:populate SHC App
...... value[x] SO 1..1 string If parameter is a data type
ObligationsActor
SHALL:populate SHC App

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Parameters.parameter.part:path.value[x]requiredSHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)
https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath
From this IG
Parameters.parameter.part:value.value[x]:coderequiredMedicationStatementStatusLimited
https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited
From this IG
Parameters.parameter.part:value.value[x]:CodeableConcept.coding:AllergyIntoleranceClinicalStatusCodesrequiredAllergyIntoleranceClinicalStatusMinimal
https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal
From this IG
Parameters.parameter.part:value.value[x]:CodeableConcept.coding:ConditionClinicalStatusCodesrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical
From this IG

Constraints

IdGradePath(s)DetailsRequirements
shc-patch-01errorParametersWhen 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-02errorParametersWhen 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-03errorParametersWhen 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... parameter SOΣC 1..* BackboneElement Operation Parameter
Constraints: inv-1
ObligationsActor
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 Parameters for element patching
Fixed Value: operation
ObligationsActor
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 Σ 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
ObligationsActor
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
ObligationsActor
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: replace
ObligationsActor
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
ObligationsActor
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
ObligationsActor
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 Path (required)
ObligationsActor
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
ObligationsActor
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
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate SHC App
...... Slices for value[x] ΣC 1..1 If parameter is a data type
Slice: Unordered, Closed by type:$this
....... valueCode code
....... valueDateTime dateTime
....... valueMarkdown markdown
....... valueString string
....... valueCodeableConcept CodeableConcept
....... value[x]:valueCode SOΣC 0..1 code If parameter is a data type
Binding: Medication Statement Status Limited (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueCodeableConcept SOΣC 0..1 CodeableConcept If parameter is a data type
ObligationsActor
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
........ Slices for coding Σ 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)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
......... coding:ConditionClinicalStatusCodes SOΣ 0..1 Coding Code defined by a terminology system
Binding: ConditionClinicalStatusCodes (required)
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
........ text Σ 0..1 string Plain text representation of the concept
....... value[x]:valueDateTime SOΣC 0..1 dateTime If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueString SOΣC 0..1 string If parameter is a data type
ObligationsActor
SHALL:process SHC Host FHIR Server
SHALL:populate-if-known SHC App
....... value[x]:valueMarkdown SOΣC 0..1 markdown If parameter is a data type
ObligationsActor
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.
ObligationsActor
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
ObligationsActor
SHALL:populate SHC App
...... value[x] SOΣC 1..1 string If parameter is a data type
ObligationsActor
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter.part:path.value[x]requiredSHCPatchPath(a valid code from Smart Health Checks Patch Path Codes)
https://smartforms.csiro.au/ig/ValueSet/SHCPatchPath
From this IG
Parameters.parameter.part:value.value[x]:valueCoderequiredMedicationStatementStatusLimited
https://smartforms.csiro.au/ig/ValueSet/MedicationStatementStatusLimited
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:AllergyIntoleranceClinicalStatusCodesrequiredAllergyIntoleranceClinicalStatusMinimal
https://smartforms.csiro.au/ig/ValueSet/AllergyIntoleranceClinicalStatusMinimal
From this IG
Parameters.parameter.part:value.value[x]:valueCodeableConcept.coding:ConditionClinicalStatusCodesrequiredConditionClinicalStatusCodes
http://hl7.org/fhir/ValueSet/condition-clinical
From this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameterA 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-01errorParametersWhen 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-02errorParametersWhen 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-03errorParametersWhen 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: 20 elements
Fixed: 6 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]
  • The element 1 is sliced based on the value of Parameters.parameter.part.value[x].coding

 

Other representations of profile: CSV, Excel, Schematron