AEFIpublicHealthRecomm

The FHIR extension is for Immunization AEFI Public Health Recommendation purposes.

id0..1string
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
id0..0string
extensionI0..*Extension
timeΣ0..0dateTime
textΣ1..1markdown
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
url1..1uriFixed Value
Extension
DefinitionOptional Extension Element - found in all resources.
Cardinality0...*
Comments

Version 2024.4: Send DateTime for element phrDate.

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
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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:phrRecommendations
DefinitionAEFI Public Health Recommendations
Cardinality0...*
TypeExtension
Aliasextensions, 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.

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:phrRecommendations.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
Extension.extension:phrRecommendations.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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:phrRecommendations.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

phrRecommendations

Mappings
  • rim: N/A
Extension.extension:phrRecommendations.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeAnnotation
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:phrRecommendations.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
Extension.extension:phrRecommendations.value[x].extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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:phrRecommendations.value[x].author[x]
DefinitionThe individual responsible for making the annotation.
Cardinality0...0
TypeReference(Practitioner | Patient | RelatedPerson | Organization)
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
Extension.extension:phrRecommendations.value[x].time
DefinitionIndicates when this particular annotation was made.
Cardinality0...0
TypedateTime
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
Extension.extension:phrRecommendations.value[x].text
DefinitionThe text of the annotation in markdown format.
Cardinality1...1
Typemarkdown
SummaryTrue
Comments

NOCHANGE_CD_CNCPT_ID EXPERTREF_CD_CNCPT_ID DETPROTANT_CD_CNCPT_ID CONTROLSETIMM_CD_CNCPT_ID NOFURTHER_CD_CNCPT_ID OTHER_CD_CNCPT_ID ACTIVEFOLLOWUP_CD_CNCPT_ID NOTHING_CD_CNCPT_ID

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
Extension.extension:phrDate
DefinitionAEFI Public Health Recommendations Date
Cardinality0...*
TypeExtension
Aliasextensions, 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.

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:phrDate.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
Extension.extension:phrDate.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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:phrDate.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

phrDate

Mappings
  • rim: N/A
Extension.extension:phrDate.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypedateTime
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON
Extension.extension:phrComment
DefinitionAEFI Public Health Recommendations Comments
Cardinality0...*
TypeExtension
Aliasextensions, 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.

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:phrComment.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
Extension.extension:phrComment.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, 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:phrComment.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

phrComment

Mappings
  • rim: N/A
Extension.extension:phrComment.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Comments

See Mappings. Only applies to adverse event recommendation comment types, i.e.,where reportng.ae_event_recommendation.ae_event_recommendation_id = immunization_comment.row_id AND comment_type = 'AE' AND comment_subtype = 'RECOMM'

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: IMMUNIZATION_COMMENT.COMMENT_TEXT
Extension.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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/AEFI-publicHealth-recomm

Mappings
  • rim: N/A
Extension.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
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/AEFI-publicHealth-recomm" />
    <name value="AEFIpublicHealthRecomm" />
    <status value="draft" />
    <fhirVersion value="4.0.1" />
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="AdverseEvent" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <comment value="Version 2024.4: Send DateTime for element phrDate." />
        </element>
        <element id="Extension.extension:phrRecommendations">
            <path value="Extension.extension" />
            <sliceName value="phrRecommendations" />
            <short value="AEFI Public Health Recommendations" />
            <definition value="AEFI Public Health Recommendations" />
        </element>
        <element id="Extension.extension:phrRecommendations.id">
            <path value="Extension.extension.id" />
            <max value="0" />
        </element>
        <element id="Extension.extension:phrRecommendations.url">
            <path value="Extension.extension.url" />
            <fixedUri value="phrRecommendations" />
        </element>
        <element id="Extension.extension:phrRecommendations.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="Annotation" />
            </type>
        </element>
        <element id="Extension.extension:phrRecommendations.value[x].id">
            <path value="Extension.extension.value[x].id" />
            <max value="0" />
        </element>
        <element id="Extension.extension:phrRecommendations.value[x].author[x]">
            <path value="Extension.extension.value[x].author[x]" />
            <max value="0" />
        </element>
        <element id="Extension.extension:phrRecommendations.value[x].time">
            <path value="Extension.extension.value[x].time" />
            <max value="0" />
        </element>
        <element id="Extension.extension:phrRecommendations.value[x].text">
            <path value="Extension.extension.value[x].text" />
            <comment value="NOCHANGE_CD_CNCPT_ID\nEXPERTREF_CD_CNCPT_ID\nDETPROTANT_CD_CNCPT_ID\nCONTROLSETIMM_CD_CNCPT_ID\nNOFURTHER_CD_CNCPT_ID\nOTHER_CD_CNCPT_ID\nACTIVEFOLLOWUP_CD_CNCPT_ID\nNOTHING_CD_CNCPT_ID" />
        </element>
        <element id="Extension.extension:phrDate">
            <path value="Extension.extension" />
            <sliceName value="phrDate" />
            <short value="AEFI Public Health Recommendations Date" />
            <definition value="AEFI Public Health Recommendations Date" />
        </element>
        <element id="Extension.extension:phrDate.id">
            <path value="Extension.extension.id" />
            <max value="0" />
        </element>
        <element id="Extension.extension:phrDate.url">
            <path value="Extension.extension.url" />
            <fixedUri value="phrDate" />
        </element>
        <element id="Extension.extension:phrDate.value[x]">
            <path value="Extension.extension.value[x]" />
            <comment value="See Mappings" />
            <min value="1" />
            <type>
                <code value="dateTime" />
            </type>
            <mapping>
                <identity value="source-PIR" />
                <map value="REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON" />
            </mapping>
        </element>
        <element id="Extension.extension:phrComment">
            <path value="Extension.extension" />
            <sliceName value="phrComment" />
            <short value="AEFI Public Health Recommendations Comments" />
            <definition value="AEFI Public Health Recommendations Comments" />
        </element>
        <element id="Extension.extension:phrComment.id">
            <path value="Extension.extension.id" />
            <max value="0" />
        </element>
        <element id="Extension.extension:phrComment.url">
            <path value="Extension.extension.url" />
            <fixedUri value="phrComment" />
        </element>
        <element id="Extension.extension:phrComment.value[x]">
            <path value="Extension.extension.value[x]" />
            <comment value="See Mappings. Only applies to adverse event recommendation comment types, i.e.,where reportng.ae_event_recommendation.ae_event_recommendation_id = immunization_comment.row_id AND comment_type = &#39;AE&#39; AND comment_subtype = &#39;RECOMM&#39;" />
            <min value="1" />
            <type>
                <code value="string" />
            </type>
            <mapping>
                <identity value="source-PIR" />
                <map value="IMMUNIZATION_COMMENT.COMMENT_TEXT" />
            </mapping>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-publicHealth-recomm" />
        </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/AEFI-publicHealth-recomm",
    "name": "AEFIpublicHealthRecomm",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "AdverseEvent"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "comment": "Version 2024.4: Send DateTime for element phrDate."
            },
            {
                "id": "Extension.extension:phrRecommendations",
                "path": "Extension.extension",
                "sliceName": "phrRecommendations",
                "short": "AEFI Public Health Recommendations",
                "definition": "AEFI Public Health Recommendations"
            },
            {
                "id": "Extension.extension:phrRecommendations.id",
                "path": "Extension.extension.id",
                "max": "0"
            },
            {
                "id": "Extension.extension:phrRecommendations.url",
                "path": "Extension.extension.url",
                "fixedUri": "phrRecommendations"
            },
            {
                "id": "Extension.extension:phrRecommendations.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Annotation"
                    }
                ]
            },
            {
                "id": "Extension.extension:phrRecommendations.value[x].id",
                "path": "Extension.extension.value[x].id",
                "max": "0"
            },
            {
                "id": "Extension.extension:phrRecommendations.value[x].author[x]",
                "path": "Extension.extension.value[x].author[x]",
                "max": "0"
            },
            {
                "id": "Extension.extension:phrRecommendations.value[x].time",
                "path": "Extension.extension.value[x].time",
                "max": "0"
            },
            {
                "id": "Extension.extension:phrRecommendations.value[x].text",
                "path": "Extension.extension.value[x].text",
                "comment": "NOCHANGE_CD_CNCPT_ID\nEXPERTREF_CD_CNCPT_ID\nDETPROTANT_CD_CNCPT_ID\nCONTROLSETIMM_CD_CNCPT_ID\nNOFURTHER_CD_CNCPT_ID\nOTHER_CD_CNCPT_ID\nACTIVEFOLLOWUP_CD_CNCPT_ID\nNOTHING_CD_CNCPT_ID"
            },
            {
                "id": "Extension.extension:phrDate",
                "path": "Extension.extension",
                "sliceName": "phrDate",
                "short": "AEFI Public Health Recommendations Date",
                "definition": "AEFI Public Health Recommendations Date"
            },
            {
                "id": "Extension.extension:phrDate.id",
                "path": "Extension.extension.id",
                "max": "0"
            },
            {
                "id": "Extension.extension:phrDate.url",
                "path": "Extension.extension.url",
                "fixedUri": "phrDate"
            },
            {
                "id": "Extension.extension:phrDate.value[x]",
                "path": "Extension.extension.value[x]",
                "comment": "See Mappings",
                "min": 1,
                "type":  [
                    {
                        "code": "dateTime"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON"
                    }
                ]
            },
            {
                "id": "Extension.extension:phrComment",
                "path": "Extension.extension",
                "sliceName": "phrComment",
                "short": "AEFI Public Health Recommendations Comments",
                "definition": "AEFI Public Health Recommendations Comments"
            },
            {
                "id": "Extension.extension:phrComment.id",
                "path": "Extension.extension.id",
                "max": "0"
            },
            {
                "id": "Extension.extension:phrComment.url",
                "path": "Extension.extension.url",
                "fixedUri": "phrComment"
            },
            {
                "id": "Extension.extension:phrComment.value[x]",
                "path": "Extension.extension.value[x]",
                "comment": "See Mappings. Only applies to adverse event recommendation comment types, i.e.,where reportng.ae_event_recommendation.ae_event_recommendation_id = immunization_comment.row_id AND comment_type = 'AE' AND comment_subtype = 'RECOMM'",
                "min": 1,
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "IMMUNIZATION_COMMENT.COMMENT_TEXT"
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-publicHealth-recomm"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}