Profiles & Operations Index > Profile: Parameters (Parameters Search Submission)

Profile: Parameters (Parameters Submission)

Canonical URL: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-parameters-submission

Simplifier project page: ParametersSubmission

Derived from: Parameters (R4)

Formal Views of Profile Content

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

Differential View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueStringstring
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueUriuri
resourceΣ I0..1Resource
partΣ0..*see (parameter)

Hybrid View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueStringstring
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueUriuri
resourceΣ I0..1Resource
partΣ0..*see (parameter)

Snapshot View

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ1..1string
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueBase64Binarybase64Binary
valueBooleanboolean
valueCanonicalcanonical()
valueCodecode
valueDatedate
valueDateTimedateTime
valueDecimaldecimal
valueIdid
valueInstantinstant
valueIntegerinteger
valueMarkdownmarkdown
valueOidoid
valuePositiveIntpositiveInt
valueStringstring
valueTimetime
valueUnsignedIntunsignedInt
valueUriuri
valueUrlurl
valueUuiduuid
valueAddressAddress
valueAgeAge
valueAnnotationAnnotation
valueAttachmentAttachment
valueCodeableConceptCodeableConcept
valueCodingCoding
valueContactPointContactPoint
valueCountCount
valueDistanceDistance
valueDurationDuration
valueHumanNameHumanName
valueIdentifierIdentifier
valueMoneyMoney
valuePeriodPeriod
valueQuantityQuantity
valueRangeRange
valueRatioRatio
valueSampledDataSampledData
valueSignatureSignature
valueTimingTiming
valueContactDetailContactDetail
valueContributorContributor
valueDataRequirementDataRequirement
valueExpressionExpression
valueParameterDefinitionParameterDefinition
valueRelatedArtifactRelatedArtifact
valueTriggerDefinitionTriggerDefinition
valueUsageContextUsageContext
valueDosageDosage
valueMetaMeta
valueReferenceReference()
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueStringstring
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueCodecode
resourceΣ I0..1Resource
partΣ0..*see (parameter)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1stringFixed Value
valueUriuri
resourceΣ I0..1Resource
partΣ0..*see (parameter)

Table View

Parameters..
Parameters.meta1..
Parameters.meta.profile1..1
Parameters.parameter..
Parameters.parameter1..1
Parameters.parameter.name..
Parameters.parameter.value[x]code1..
Parameters.parameter..1
Parameters.parameter.name..
Parameters.parameter.part1..
Parameters.parameter.part1..1
Parameters.parameter.part.name..
Parameters.parameter.part.value[x]code..
Parameters.parameter.part..1
Parameters.parameter.part.name..
Parameters.parameter.part.value[x]string1..
Parameters.parameter1..
Parameters.parameter.name..
Parameters.parameter.value[x]code..
Parameters.parameter.part1..
Parameters.parameter.part1..1
Parameters.parameter.part.name..
Parameters.parameter.part.value[x]code1..
Parameters.parameter.part1..1
Parameters.parameter.part.name..
Parameters.parameter.part.value[x]uri1..

JSON View

{
    "resourceType": "StructureDefinition",
    "text": {
        "status": "empty",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-phsd-parameters-submission",
    "version": "1.0.0",
    "name": "ParametersSubmission",
    "status": "draft",
    "description": "Defines the Parameters resource for PHSD bulk import.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Parameters",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Parameters.meta",
                "path": "Parameters.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Parameters.meta.profile",
                "path": "Parameters.meta.profile",
                "min": 1,
                "max": "1",
                "fixedCanonical": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-cms-profile-Parameters",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter",
                "path": "Parameters.parameter",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "name"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Parameters.parameter:inputFormat",
                "path": "Parameters.parameter",
                "sliceName": "inputFormat",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:inputFormat.name",
                "path": "Parameters.parameter.name",
                "fixedString": "inputFormat",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:inputFormat.value[x]",
                "path": "Parameters.parameter.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "fixedCode": "application/fhir+ndjson",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail",
                "path": "Parameters.parameter",
                "sliceName": "storageDetail",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.name",
                "path": "Parameters.parameter.name",
                "fixedString": "storageDetail",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.part",
                "path": "Parameters.parameter.part",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "name"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.part:slicePartType",
                "path": "Parameters.parameter.part",
                "sliceName": "slicePartType",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Parameters.parameter:storageDetail.part:slicePartType.name",
                "path": "Parameters.parameter.part.name",
                "fixedString": "type",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.part:slicePartType.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.part:slicePartCredential",
                "path": "Parameters.parameter.part",
                "sliceName": "slicePartCredential",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.part:slicePartCredential.name",
                "path": "Parameters.parameter.part.name",
                "fixedString": "credentialHttpBasic",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:storageDetail.part:slicePartCredential.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input",
                "path": "Parameters.parameter",
                "sliceName": "input",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.name",
                "path": "Parameters.parameter.name",
                "fixedString": "input",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.value[x]",
                "path": "Parameters.parameter.value[x]",
                "type":  [
                    {
                        "code": "code"
                    }
                ]
            },
            {
                "id": "Parameters.parameter:input.part",
                "path": "Parameters.parameter.part",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "name"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.part:slicePartType",
                "path": "Parameters.parameter.part",
                "sliceName": "slicePartType",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.part:slicePartType.name",
                "path": "Parameters.parameter.part.name",
                "fixedString": "type",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.part:slicePartType.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "code"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.part:slicePartUrl",
                "path": "Parameters.parameter.part",
                "sliceName": "slicePartUrl",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.part:slicePartUrl.name",
                "path": "Parameters.parameter.part.name",
                "fixedString": "url",
                "mustSupport": true
            },
            {
                "id": "Parameters.parameter:input.part:slicePartUrl.value[x]",
                "path": "Parameters.parameter.part.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "uri"
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Usage

The Parameters Resource is submitted during PHSD bulk import.

Notes

inputFormat (string, required)

Servers SHALL support Newline Delimited JSON with a format type of application/fhir+ndjson but MAY choose to support additional input formats.

storageDetail (object, optional)

Holds information about how to access source data.

input (array, required)

json array of objects containing the following fields:

  • type (string, required) FHIR resource type
  • url (url, required) Path to bulk data file of the type reflected in inputFormat containing FHIR resources