BCY Immunization Distribution Service Implementation Guide

SpecialCondStatusExtension

The FHIR extension is for Immunization Supplemental Data - Special Consideration status purposes.

SpecialCondStatusExtension (Extension)	I		Extension	Element id Extension Short description Optional Extensions Element Definition Optional Extension Element - found in all resources. Comments To be applied when Special Consideration has been deleted in PIR Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..0	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
scDeleteReason	I	0..1	Extension	Element id Extension.extension:scDeleteReason Short description Special Consideration Deleted Reason Alternate names extensions, user content Definition Special Consideration Deleted Reason Other, specify Comments To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
id		0..0	string	There are no (further) constraints on this element Element id Extension.extension:scDeleteReason.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:scDeleteReason.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
url		1..1	uriFixed Value	Element id Extension.extension:scDeleteReason.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value scDeleteReason Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.extension:scDeleteReason.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueString			string	Data type string
scDeleteReasonOther	I	0..1	Extension	Element id Extension.extension:scDeleteReasonOther Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
id		0..0	string	There are no (further) constraints on this element Element id Extension.extension:scDeleteReasonOther.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension:scDeleteReasonOther.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
url		1..1	uriFixed Value	Element id Extension.extension:scDeleteReasonOther.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value scDeleteReasonOther Mappings rim: N/A
value[x]		1..1		There are no (further) constraints on this element Element id Extension.extension:scDeleteReasonOther.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueString			string	Data type string
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status Mappings rim: N/A
value[x]		0..0		There are no (further) constraints on this element Element id Extension.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A

Extension
Definition	Optional Extension Element - found in all resources.
Cardinality	0...*
Comments	To be applied when Special Consideration has been deleted in PIR
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...0
Type	string
Mappings	rim: n/a
Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Extension.extension:scDeleteReason
Definition	Special Consideration Deleted Reason Other, specify
Cardinality	0...1
Type	Extension
Alias	extensions, user content
Comments	To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Extension.extension:scDeleteReason.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...0
Type	string
Mappings	rim: n/a
Extension.extension:scDeleteReason.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Extension.extension:scDeleteReason.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	scDeleteReason
Mappings	rim: N/A
Extension.extension:scDeleteReason.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality	1...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
Extension.extension:scDeleteReasonOther
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...1
Type	Extension
Alias	extensions, user content
Comments	To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Extension.extension:scDeleteReasonOther.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0...0
Type	string
Mappings	rim: n/a
Extension.extension:scDeleteReasonOther.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0...*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value)
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Extension.extension:scDeleteReasonOther.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	scDeleteReasonOther
Mappings	rim: N/A
Extension.extension:scDeleteReasonOther.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality	1...1
Type	string
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A
Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1...1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status
Mappings	rim: N/A
Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality	0...0
Type	base64Binary
Invariants	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A

<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status" />
    <name value="SpecialCondStatusExtension" />
    <status value="draft" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="CarePlan.status" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <comment value="To be applied when Special Consideration has been deleted in PIR" />
        </element>
        <element id="Extension.id">
            <path value="Extension.id" />
            <max value="0" />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Extension.extension:scDeleteReason">
            <path value="Extension.extension" />
            <sliceName value="scDeleteReason" />
            <short value="Special Consideration Deleted Reason" />
            <definition value="Special Consideration Deleted Reason Other, specify" />
            <comment value="To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list" />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:scDeleteReason.id">
            <path value="Extension.extension.id" />
            <max value="0" />
        </element>
        <element id="Extension.extension:scDeleteReason.url">
            <path value="Extension.extension.url" />
            <fixedUri value="scDeleteReason" />
        </element>
        <element id="Extension.extension:scDeleteReason.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="string" />
            </type>
        </element>
        <element id="Extension.extension:scDeleteReasonOther">
            <path value="Extension.extension" />
            <sliceName value="scDeleteReasonOther" />
            <comment value="To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list" />
            <min value="0" />
            <max value="1" />
        </element>
        <element id="Extension.extension:scDeleteReasonOther.id">
            <path value="Extension.extension.id" />
            <max value="0" />
        </element>
        <element id="Extension.extension:scDeleteReasonOther.url">
            <path value="Extension.extension.url" />
            <fixedUri value="scDeleteReasonOther" />
        </element>
        <element id="Extension.extension:scDeleteReasonOther.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="string" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status",
    "name": "SpecialCondStatusExtension",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "CarePlan.status"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "comment": "To be applied when Special Consideration has been deleted in PIR"
            },
            {
                "id": "Extension.id",
                "path": "Extension.id",
                "max": "0"
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Extension.extension:scDeleteReason",
                "path": "Extension.extension",
                "sliceName": "scDeleteReason",
                "short": "Special Consideration Deleted Reason",
                "definition": "Special Consideration Deleted Reason Other, specify",
                "comment": "To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:scDeleteReason.id",
                "path": "Extension.extension.id",
                "max": "0"
            },
            {
                "id": "Extension.extension:scDeleteReason.url",
                "path": "Extension.extension.url",
                "fixedUri": "scDeleteReason"
            },
            {
                "id": "Extension.extension:scDeleteReason.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "Extension.extension:scDeleteReasonOther",
                "path": "Extension.extension",
                "sliceName": "scDeleteReasonOther",
                "comment": "To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list",
                "min": 0,
                "max": "1"
            },
            {
                "id": "Extension.extension:scDeleteReasonOther.id",
                "path": "Extension.extension.id",
                "max": "0"
            },
            {
                "id": "Extension.extension:scDeleteReasonOther.url",
                "path": "Extension.extension.url",
                "fixedUri": "scDeleteReasonOther"
            },
            {
                "id": "Extension.extension:scDeleteReasonOther.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}