New Zealand ICP Implementation Guide
1.0.0 - release

New Zealand ICP Implementation Guide, published by Accident Compensation Corporation. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/acc-fhir-publisher/icp/ and changes regularly. See the Directory of published versions

Resource Profile: IcpReferralDecline - Detailed Descriptions

Active as of 2022-11-20

Definitions for the acc-icp-referral-decline resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Encounter
2. Encounter.contained
Control1..?
SlicingThis element introduces a set of slices on Encounter.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
  • 4. Encounter.contained:patient
    Slice Namepatient
    Definition

    Contained patient resource for the required patient's date of birth.

    ShortPatient's date of birth.
    Control1..1
    TypePatient(ACC ICP Patient)
    6. Encounter.extension
    Control3..4
    SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • value @ url
    • 8. Encounter.extension:acc-providerid
      Slice Nameacc-providerid
      ShortThe ACC provider Id of the practioner providing this information
      Control1..1
      TypeExtension(ACC Provider ID) (Extension Type: string)
      10. Encounter.extension:referral-source
      Slice Namereferral-source
      Short(gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
      Control1..1
      TypeExtension(Referral Source) (Complex Extension)
      12. Encounter.extension:referral-declined
      Slice Namereferral-declined
      ShortThe declined reason and details for declining the referral
      Control1..1
      TypeExtension(ICP Referral Declined) (Complex Extension)
      14. Encounter.extension:triage
      Slice Nametriage
      ShortThe triage assessment of the patient must be present when a triage has been performed
      Control0..1
      TypeExtension(ICP Triage) (Complex Extension)
      16. Encounter.extension:triage.extension:client-participation-agreement
      Slice Nameclient-participation-agreement
      18. Encounter.extension:triage.extension:client-participation-agreement.value[x]
      Control0..0
      20. Encounter.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      SlicingThis element introduces a set of slices on Encounter.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • value @ system
      • 22. Encounter.identifier:icpclaimnumber
        Slice Nameicpclaimnumber
        ShortThe ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..1
        24. Encounter.identifier:icpclaimnumber.id
        Control0..0
        26. Encounter.identifier:icpclaimnumber.extension
        Control0..0
        28. Encounter.identifier:icpclaimnumber.system
        Control1..?
        Fixed Valuehttps://standards.digital.health.nz/ns/acc-45-number
        30. Encounter.identifier:icpclaimnumber.value
        ShortThe ACC 45 number.
        Control1..?
        Invariantsacc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. ($this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$'))
        32. Encounter.identifier:icpclaimnumber.period
        Control0..0
        34. Encounter.identifier:icpclaimnumber.assigner
        Control0..0
        36. Encounter.status
        Definition

        The Status of the encounter can only be finished (Finished).

        Shortfinished
        BindingThe codes SHALL be taken from Encounter Status
        (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status)
        38. Encounter.statusHistory
        Control0..0
        40. Encounter.class
        Definition

        The class of the encounter can only be pre-admission (pre-admission).

        ShortPRENC
        BindingThe codes SHALL be taken from Encounter Class
        (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class)
        42. Encounter.classHistory
        Control0..0
        44. Encounter.type
        Control0..0
        46. Encounter.serviceType
        ShortThe type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
        Control1..?
        48. Encounter.serviceType.coding
        Control1..1
        50. Encounter.serviceType.coding.system
        Control1..?
        Pattern Valuehttp://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
        52. Encounter.serviceType.coding.code
        Shortmsk
        Control1..?
        BindingThe codes SHALL be taken from Service Type
        (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type)
        54. Encounter.priority
        Control0..0
        56. Encounter.subject
        Control1..?
        TypeReference(ACC ICP Patient)
        58. Encounter.episodeOfCare
        Control0..0
        60. Encounter.basedOn
        Control0..0
        62. Encounter.participant
        Control0..0
        64. Encounter.appointment
        Control0..0
        66. Encounter.period
        Control0..0
        68. Encounter.length
        Control0..0
        70. Encounter.reasonCode
        Control0..0
        72. Encounter.reasonReference
        Control0..0
        74. Encounter.diagnosis
        Control0..0
        76. Encounter.account
        Control0..0
        78. Encounter.hospitalization
        Control0..0
        80. Encounter.location
        Control0..0
        82. Encounter.serviceProvider
        ShortThis is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
        Control1..?
        84. Encounter.partOf
        Control0..0

        Guidance on how to interpret the contents of this table can be found here

        0. Encounter
        Definition

        An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

        ShortAn interaction during which services are provided to the patient
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Alternate NamesVisit
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
        dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
        dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        dom-6: A resource should have narrative for robust management (text.`div`.exists())
        2. Encounter.implicitRules
        Definition

        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

        ShortA set of rules under which this content was created
        Comments

        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        4. Encounter.contained
        Definition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        ShortContained, inline Resources
        Comments

        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

        Control10..*
        TypeResource
        Is Modifierfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        SlicingThis element introduces a set of slices on Encounter.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • type @ $this
        • 6. Encounter.contained:patient
          Slice Namepatient
          Definition

          Contained patient resource for the required patient's date of birth.


          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

          ShortPatient's date of birth.Contained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

          Control10..1*
          TypePatientResource(ACC ICP Patient)
          Is Modifierfalse
          Summaryfalse
          Alternate NamesSubjectOfCare Client Resident, inline resources, anonymous resources, contained resources
          8. Encounter.extension
          Definition

          An Extension


          May be used to represent additional information that is not part of the basic definition of the resource. 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.

          ShortExtensionAdditional content defined by implementations
          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.

          Control30..4*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators:
          • value @ url
          • 10. Encounter.extension:acc-providerid
            Slice Nameacc-providerid
            Definition

            This represents the person submitting this form to ACC. It should take the form of their ACC Provider ID.

            ShortThe ACC provider Id of the practioner providing this information
            Control1..1
            This element is affected by the following invariants: ele-1
            TypeExtension(ACC Provider ID) (Extension Type: string)
            Is Modifierfalse
            Invariantsele-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())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            12. Encounter.extension:referral-source
            Slice Namereferral-source
            Definition

            The source of the ICP referral, e.g. ACC referral, GP referral, rongoa referral, etc.

            Short(gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
            Control1..1
            This element is affected by the following invariants: ele-1
            TypeExtension(Referral Source) (Complex Extension)
            Is Modifierfalse
            Invariantsele-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())
            14. Encounter.extension:referral-declined
            Slice Namereferral-declined
            Definition

            Integrated Care Pathways Referral Declined

            ShortThe declined reason and details for declining the referral
            Control1..1
            This element is affected by the following invariants: ele-1
            TypeExtension(ICP Referral Declined) (Complex Extension)
            Is Modifierfalse
            Invariantsele-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())
            other-reason-invariant: if reason code is 'other', other-reason is required. ((extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists()))
            not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. ((extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty()))
            16. Encounter.extension:triage
            Slice Nametriage
            Definition

            Integrated Care Pathways Triage

            ShortThe triage assessment of the patient must be present when a triage has been performed
            Control0..1
            This element is affected by the following invariants: ele-1
            TypeExtension(ICP Triage) (Complex Extension)
            Is Modifierfalse
            Invariantsele-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())
            18. Encounter.extension:triage.extension
            Definition

            An Extension


            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.

            ShortExtensionAdditional content defined by implementations
            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.

            Control30..4*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis element introduces a set of slices on Encounter.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 20. Encounter.extension:triage.extension:triage-assessment-date
              Slice Nametriage-assessment-date
              Definition

              The date the triage assessment was completed.

              ShortThe date the triage assessment was completed.
              Control1..1
              TypeExtension(Triage Assessment Date) (Extension Type: date)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              22. Encounter.extension:triage.extension:acc-client-authority
              Slice Nameacc-client-authority
              Definition

              Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information.

              ShortIndicates that the Client has agreed to ACC being able to collect, store, use, & share their information.
              Control1..1
              TypeExtension(Client Authority) (Extension Type: boolean)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              24. Encounter.extension:triage.extension:complexityScores
              Slice NamecomplexityScores
              Definition

              The scores obtained from the ICP complexity assessment/tool.

              ShortThe scores obtained from the ICP complexity assessment/tool.
              Control1..1
              TypeExtension(Complexity Scores) (Complex Extension)
              Is Modifierfalse
              Invariantsele-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())
              26. Encounter.extension:triage.extension:client-participation-agreement
              Slice Nameclient-participation-agreement
              Definition

              Indicates that the Client has agreed to participating in ICP.

              ShortClient Participation Agreement
              Control0..1
              TypeExtension(Client Participation Agreement) (Extension Type: boolean)
              Is Modifierfalse
              Summaryfalse
              Invariantsele-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())
              28. Encounter.extension:triage.extension:client-participation-agreement.extension
              Definition

              An Extension


              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.

              ShortExtensionAdditional content defined by implementations
              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.

              Control0..0*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-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())
              SlicingThis element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 30. Encounter.extension:triage.extension:client-participation-agreement.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement
                32. Encounter.extension:triage.extension:client-participation-agreement.value[x]
                Definition

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                ShortValue of extension
                Control0..01
                Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                34. Encounter.extension:triage.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
                36. Encounter.extension:triage.value[x]
                Definition

                Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                ShortValue of extension
                Control0..01
                TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                38. Encounter.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                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.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content
                Invariantsele-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())
                40. Encounter.identifier
                Definition

                Identifier(s) by which this encounter is known.

                ShortIdentifier(s) by which this encounter is known
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control10..1*
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Encounter.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • value @ system
                • 42. Encounter.identifier:icpclaimnumber
                  Slice Nameicpclaimnumber
                  Definition

                  Identifier(s) by which this encounter is known.

                  ShortThe ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.Identifier(s) by which this encounter is known
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control10..1*
                  TypeIdentifier
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  44. Encounter.identifier:icpclaimnumber.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..01
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  46. Encounter.identifier:icpclaimnumber.extension
                  Definition

                  An Extension


                  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.

                  ShortExtensionAdditional content defined by implementations
                  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.

                  Control0..0*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-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())
                  SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 48. Encounter.identifier:icpclaimnumber.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                    Identifies the purpose for this identifier, if known .

                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    50. Encounter.identifier:icpclaimnumber.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control10..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    Fixed Valuehttps://standards.digital.health.nz/ns/acc-45-number
                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    52. Encounter.identifier:icpclaimnumber.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortThe ACC 45 number.The value that is unique
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control10..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Example<br/><b>General</b>:123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. ($this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$'))
                    54. Encounter.identifier:icpclaimnumber.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..01
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    56. Encounter.identifier:icpclaimnumber.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..01
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    58. Encounter.status
                    Definition

                    The Status of the encounter can only be finished (Finished).


                    planned | arrived | triaged | in-progress | onleave | finished | cancelled +.

                    Shortfinishedplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
                    Comments

                    Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).

                    Control1..1
                    BindingThe codes SHALL be taken from Encounter Statushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1
                    (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status)
                    Typecode
                    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    60. Encounter.statusHistory
                    Definition

                    The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

                    ShortList of past encounter statuses
                    Comments

                    The current status is always found in the current version of the resource, not the status history.

                    Control0..0*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    65. Encounter.class
                    Definition

                    The class of the encounter can only be pre-admission (pre-admission).


                    Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.

                    ShortPRENCClassification of patient encounter
                    Control1..1
                    BindingThe codes SHALL be taken from Unless not suitable, these codes SHALL be taken from Encounter Classhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode
                    (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class)
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    67. Encounter.classHistory
                    Definition

                    The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

                    ShortList of past encounter classes
                    Control0..0*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    72. Encounter.type
                    Definition

                    Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                    ShortSpecific type of encounter
                    Comments

                    Since there are many ways to further classify encounters, this element is 0..*.

                    Control0..0*
                    BindingFor example codes, see EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type
                    (example to http://hl7.org/fhir/ValueSet/encounter-type)

                    The type of encounter.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    74. Encounter.serviceType
                    Definition

                    Broad categorization of the service that is to be provided (e.g. cardiology).

                    ShortThe type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.Specific type of service
                    Control10..1
                    BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type
                    (example to http://hl7.org/fhir/ValueSet/service-type)

                    Broad categorization of the service that is to be provided.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    76. Encounter.serviceType.coding
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control10..1*
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    78. Encounter.serviceType.coding.system
                    Definition

                    The identification of the code system that defines the meaning of the symbol in the code.

                    ShortIdentity of the terminology system
                    Comments

                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                    Control10..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Need to be unambiguous about the source of the definition of the symbol.

                    Pattern Valuehttp://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    80. Encounter.serviceType.coding.code
                    Definition

                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                    ShortmskSymbol in syntax defined by the system
                    Control10..1
                    BindingThe codes SHALL be taken from For codes, see Service Type
                    (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type)
                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Need to refer to a particular code in the system.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Encounter.priority
                    Definition

                    Indicates the urgency of the encounter.

                    ShortIndicates the urgency of the encounter
                    Control0..01
                    BindingFor example codes, see ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority
                    (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)

                    Indicates the urgency of the encounter.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    84. Encounter.subject
                    Definition

                    The patient or group present at the encounter.

                    ShortThe patient or group present at the encounter
                    Comments

                    While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).

                    Control10..1
                    TypeReference(ACC ICP Patient, Patient, Group)
                    Is Modifierfalse
                    Summarytrue
                    Alternate Namespatient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    86. Encounter.episodeOfCare
                    Definition

                    Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

                    ShortEpisode(s) of care that this encounter should be recorded against
                    Control0..0*
                    TypeReference(EpisodeOfCare)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    88. Encounter.basedOn
                    Definition

                    The request this encounter satisfies (e.g. incoming referral or procedure request).

                    ShortThe ServiceRequest that initiated this encounter
                    Control0..0*
                    TypeReference(ServiceRequest)
                    Is Modifierfalse
                    Summaryfalse
                    Alternate NamesincomingReferral
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    90. Encounter.participant
                    Definition

                    The list of people responsible for providing the service.

                    ShortList of participants involved in the encounter
                    Control0..0*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    93. Encounter.appointment
                    Definition

                    The appointment that scheduled this encounter.

                    ShortThe appointment that scheduled this encounter
                    Control0..0*
                    TypeReference(Appointment)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    95. Encounter.period
                    Definition

                    The start and end time of the encounter.

                    ShortThe start and end time of the encounter
                    Comments

                    If not (yet) known, the end of the Period may be omitted.

                    Control0..01
                    TypePeriod
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    97. Encounter.length
                    Definition

                    Quantity of time the encounter lasted. This excludes the time during leaves of absence.

                    ShortQuantity of time the encounter lasted (less time absent)
                    Comments

                    May differ from the time the Encounter.period lasted because of leave of absence.

                    Control0..01
                    TypeDuration
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    99. Encounter.reasonCode
                    Definition

                    Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                    ShortCoded reason the encounter takes place
                    Comments

                    For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                    Control0..0*
                    BindingThe codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason
                    (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                    Reason why the encounter takes place.

                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesIndication, Admission diagnosis
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    101. Encounter.reasonReference
                    Definition

                    Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                    ShortReason the encounter takes place (reference)
                    Comments

                    For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                    Control0..0*
                    TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
                    Is Modifierfalse
                    Summarytrue
                    Alternate NamesIndication, Admission diagnosis
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    103. Encounter.diagnosis
                    Definition

                    The list of diagnosis relevant to this encounter.

                    ShortThe list of diagnosis relevant to this encounter
                    Control0..0*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    107. Encounter.account
                    Definition

                    The set of accounts that may be used for billing for this Encounter.

                    ShortThe set of accounts that may be used for billing for this Encounter
                    Comments

                    The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.

                    Control0..0*
                    TypeReference(Account)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    109. Encounter.hospitalization
                    Definition

                    Details about the admission to a healthcare service.

                    ShortDetails about the admission to a healthcare service
                    Comments

                    An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.

                    The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.

                    Control0..01
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    112. Encounter.location
                    Definition

                    List of locations where the patient has been during this encounter.

                    ShortList of locations where the patient has been
                    Comments

                    Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

                    Control0..0*
                    TypeBackboneElement
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    116. Encounter.serviceProvider
                    Definition

                    The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

                    ShortThis is the ACC Vendor ID, in most cases this is the organisation's HPI ID.The organization (facility) responsible for this encounter
                    Control10..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    118. Encounter.partOf
                    Definition

                    Another Encounter of which this encounter is a part of (administratively or in time).

                    ShortAnother Encounter this encounter is part of
                    Comments

                    This is also used for associating a child's encounter back to the mother's encounter.

                    Refer to the Notes section in the Patient resource for further details.

                    Control0..01
                    TypeReference(Encounter)
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

                    Guidance on how to interpret the contents of this table can be found here

                    0. Encounter
                    Definition

                    An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

                    ShortAn interaction during which services are provided to the patient
                    Control0..*
                    Is Modifierfalse
                    Summaryfalse
                    Alternate NamesVisit
                    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                    dom-6: A resource should have narrative for robust management (text.`div`.exists())
                    2. Encounter.id
                    Definition

                    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

                    ShortLogical id of this artifact
                    Comments

                    The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

                    Control0..1
                    Typeid
                    Is Modifierfalse
                    Summarytrue
                    4. Encounter.meta
                    Definition

                    The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

                    ShortMetadata about the resource
                    Control0..1
                    TypeMeta
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    6. Encounter.implicitRules
                    Definition

                    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                    ShortA set of rules under which this content was created
                    Comments

                    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                    Control0..1
                    Typeuri
                    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    8. Encounter.language
                    Definition

                    The base language in which the resource is written.

                    ShortLanguage of the resource content
                    Comments

                    Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

                    Control0..1
                    BindingThe codes SHOULD be taken from CommonLanguages
                    (preferred to http://hl7.org/fhir/ValueSet/languages)

                    A human language.

                    Additional BindingsPurpose
                    AllLanguagesMax Binding
                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    10. Encounter.text
                    Definition

                    A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                    ShortText summary of the resource, for human interpretation
                    Comments

                    Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                    Control0..1
                    TypeNarrative
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesnarrative, html, xhtml, display
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    12. Encounter.contained
                    Definition

                    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                    ShortContained, inline Resources
                    Comments

                    This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                    Control1..*
                    TypeResource
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesinline resources, anonymous resources, contained resources
                    SlicingThis element introduces a set of slices on Encounter.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                    • type @ $this
                    • 14. Encounter.contained:patient
                      Slice Namepatient
                      Definition

                      Contained patient resource for the required patient's date of birth.

                      ShortPatient's date of birth.
                      Comments

                      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                      Control1..1
                      TypePatient(ACC ICP Patient)
                      Is Modifierfalse
                      Summaryfalse
                      Alternate NamesSubjectOfCare Client Resident
                      16. Encounter.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control3..4
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-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())
                      SlicingThis element introduces a set of slices on Encounter.extension. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                      • value @ url
                      • 18. Encounter.extension:acc-providerid
                        Slice Nameacc-providerid
                        Definition

                        This represents the person submitting this form to ACC. It should take the form of their ACC Provider ID.

                        ShortThe ACC provider Id of the practioner providing this information
                        Control1..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(ACC Provider ID) (Extension Type: string)
                        Is Modifierfalse
                        Invariantsele-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())
                        20. Encounter.extension:referral-source
                        Slice Namereferral-source
                        Definition

                        The source of the ICP referral, e.g. ACC referral, GP referral, rongoa referral, etc.

                        Short(gp | physio | specialist | allied | employer | rongoa | other | acc | patient)
                        Control1..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(Referral Source) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-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())
                        22. Encounter.extension:referral-declined
                        Slice Namereferral-declined
                        Definition

                        Integrated Care Pathways Referral Declined

                        ShortThe declined reason and details for declining the referral
                        Control1..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(ICP Referral Declined) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-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())
                        other-reason-invariant: if reason code is 'other', other-reason is required. ((extension.where(url='reason').value = 'other' implies extension.where(url='other-reason').value.exists()))
                        not-other-reason-invariant: if reason code is not 'other', other-reason must not be populated. ((extension.where(url='reason').value != 'other' implies extension.where(url='other-reason').value.empty()))
                        24. Encounter.extension:triage
                        Slice Nametriage
                        Definition

                        Integrated Care Pathways Triage

                        ShortThe triage assessment of the patient must be present when a triage has been performed
                        Control0..1
                        This element is affected by the following invariants: ele-1
                        TypeExtension(ICP Triage) (Complex Extension)
                        Is Modifierfalse
                        Invariantsele-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())
                        26. Encounter.extension:triage.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        28. Encounter.extension:triage.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control3..4
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-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())
                        SlicingThis element introduces a set of slices on Encounter.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 30. Encounter.extension:triage.extension:triage-assessment-date
                          Slice Nametriage-assessment-date
                          Definition

                          The date the triage assessment was completed.

                          ShortThe date the triage assessment was completed.
                          Control1..1
                          TypeExtension(Triage Assessment Date) (Extension Type: date)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-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())
                          32. Encounter.extension:triage.extension:acc-client-authority
                          Slice Nameacc-client-authority
                          Definition

                          Indicates that the Client has agreed to ACC being able to collect, store, use, & share their information.

                          ShortIndicates that the Client has agreed to ACC being able to collect, store, use, &amp; share their information.
                          Control1..1
                          TypeExtension(Client Authority) (Extension Type: boolean)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-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())
                          34. Encounter.extension:triage.extension:complexityScores
                          Slice NamecomplexityScores
                          Definition

                          The scores obtained from the ICP complexity assessment/tool.

                          ShortThe scores obtained from the ICP complexity assessment/tool.
                          Control1..1
                          TypeExtension(Complexity Scores) (Complex Extension)
                          Is Modifierfalse
                          Invariantsele-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())
                          36. Encounter.extension:triage.extension:client-participation-agreement
                          Slice Nameclient-participation-agreement
                          Definition

                          Indicates that the Client has agreed to participating in ICP.

                          ShortClient Participation Agreement
                          Control0..1
                          TypeExtension(Client Participation Agreement) (Extension Type: boolean)
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-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())
                          38. Encounter.extension:triage.extension:client-participation-agreement.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          40. Encounter.extension:triage.extension:client-participation-agreement.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..0
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Invariantsele-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())
                          SlicingThis element introduces a set of slices on Encounter.extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 42. Encounter.extension:triage.extension:client-participation-agreement.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            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.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/acc-icp-client-participation-agreement
                            44. Encounter.extension:triage.extension:client-participation-agreement.value[x]
                            Definition

                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortValue of extension
                            Control0..0
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            46. Encounter.extension:triage.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            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.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org.nz/fhir/StructureDefinition/acc-icp-triage
                            48. Encounter.extension:triage.value[x]
                            Definition

                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortValue of extension
                            Control0..0
                            TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            50. Encounter.modifierExtension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                            ShortExtensions that cannot be ignored
                            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.

                            Control0..*
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                            Summaryfalse
                            Requirements

                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                            Alternate Namesextensions, user content
                            Invariantsele-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())
                            52. Encounter.identifier
                            Definition

                            Identifier(s) by which this encounter is known.

                            ShortIdentifier(s) by which this encounter is known
                            NoteThis is a business identifier, not a resource identifier (see discussion)
                            Control1..1
                            TypeIdentifier
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            SlicingThis element introduces a set of slices on Encounter.identifier. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                            • value @ system
                            • 54. Encounter.identifier:icpclaimnumber
                              Slice Nameicpclaimnumber
                              Definition

                              Identifier(s) by which this encounter is known.

                              ShortThe ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.
                              NoteThis is a business identifier, not a resource identifier (see discussion)
                              Control1..1
                              TypeIdentifier
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              56. Encounter.identifier:icpclaimnumber.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..0
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              58. Encounter.identifier:icpclaimnumber.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..0
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-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())
                              SlicingThis element introduces a set of slices on Encounter.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 60. Encounter.identifier:icpclaimnumber.use
                                Definition

                                The purpose of this identifier.

                                Shortusual | official | temp | secondary | old (If known)
                                Comments

                                Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                Control0..1
                                BindingThe codes SHALL be taken from IdentifierUse
                                (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                Identifies the purpose for this identifier, if known .

                                Typecode
                                Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                62. Encounter.identifier:icpclaimnumber.type
                                Definition

                                A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                                ShortDescription of identifier
                                Comments

                                This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                Control0..1
                                BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                                (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                                A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows users to make use of identifiers when the identifier system is not known.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                64. Encounter.identifier:icpclaimnumber.system
                                Definition

                                Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                ShortThe namespace for the identifier value
                                Comments

                                Identifier.system is always case sensitive.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                                Fixed Valuehttps://standards.digital.health.nz/ns/acc-45-number
                                Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                66. Encounter.identifier:icpclaimnumber.value
                                Definition

                                The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                                ShortThe ACC 45 number.
                                Comments

                                If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                Control1..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Example<br/><b>General</b>:123456
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                acc-claim-number: The claim number format is invalid; it must be in the form A999999, AA99999, 9999AAA or 99999AA, where A is any capital letter, 9 is any single digit, and there are 7 characters altogether. ($this.toString().matches('^[A-Z][0-9]{6}$|^[A-Z]{2}[0-9]{5}$|^[0-9]{4}[A-Z]{3}$|^[0-9]{5}[A-Z]{2}$'))
                                68. Encounter.identifier:icpclaimnumber.period
                                Definition

                                Time period during which identifier is/was valid for use.

                                ShortTime period when id is/was valid for use
                                Control0..0
                                TypePeriod
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                70. Encounter.identifier:icpclaimnumber.assigner
                                Definition

                                Organization that issued/manages the identifier.

                                ShortOrganization that issued id (may be just text)
                                Comments

                                The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                                Control0..0
                                TypeReference(Organization)
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                72. Encounter.status
                                Definition

                                The Status of the encounter can only be finished (Finished).

                                Shortfinished
                                Comments

                                Note that internal business rules will determine the appropriate transitions that may occur between statuses (and also classes).

                                Control1..1
                                BindingThe codes SHALL be taken from Encounter Status
                                (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-status)
                                Typecode
                                Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                74. Encounter.statusHistory
                                Definition

                                The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.

                                ShortList of past encounter statuses
                                Comments

                                The current status is always found in the current version of the resource, not the status history.

                                Control0..0
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                81. Encounter.class
                                Definition

                                The class of the encounter can only be pre-admission (pre-admission).

                                ShortPRENC
                                Control1..1
                                BindingThe codes SHALL be taken from Encounter Class
                                (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-encounter-class)
                                TypeCoding
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                83. Encounter.classHistory
                                Definition

                                The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transitions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kind of discharge from emergency to inpatient.

                                ShortList of past encounter classes
                                Control0..0
                                TypeBackboneElement
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                90. Encounter.type
                                Definition

                                Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).

                                ShortSpecific type of encounter
                                Comments

                                Since there are many ways to further classify encounters, this element is 0..*.

                                Control0..0
                                BindingFor example codes, see EncounterType
                                (example to http://hl7.org/fhir/ValueSet/encounter-type)

                                The type of encounter.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                92. Encounter.serviceType
                                Definition

                                Broad categorization of the service that is to be provided (e.g. cardiology).

                                ShortThe type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
                                Control1..1
                                BindingFor example codes, see ServiceType
                                (example to http://hl7.org/fhir/ValueSet/service-type)

                                Broad categorization of the service that is to be provided.

                                TypeCodeableConcept
                                Is Modifierfalse
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                94. Encounter.serviceType.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                96. Encounter.serviceType.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.

                                ShortAdditional content defined by implementations
                                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.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-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())
                                SlicingThis element introduces a set of slices on Encounter.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 98. Encounter.serviceType.coding
                                  Definition

                                  A reference to a code defined by a terminology system.

                                  ShortCode defined by a terminology system
                                  Comments

                                  Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                  Control1..1
                                  TypeCoding
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Allows for alternative encodings within a code system, and translations to other code systems.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  100. Encounter.serviceType.coding.id
                                  Definition

                                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                  ShortUnique id for inter-element referencing
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  102. Encounter.serviceType.coding.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.

                                  ShortAdditional content defined by implementations
                                  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.

                                  Control0..*
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Alternate Namesextensions, user content
                                  Invariantsele-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())
                                  SlicingThis element introduces a set of slices on Encounter.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 104. Encounter.serviceType.coding.system
                                    Definition

                                    The identification of the code system that defines the meaning of the symbol in the code.

                                    ShortIdentity of the terminology system
                                    Comments

                                    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Need to be unambiguous about the source of the definition of the symbol.

                                    Pattern Valuehttp://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    106. Encounter.serviceType.coding.version
                                    Definition

                                    The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                    ShortVersion of the system - if relevant
                                    Comments

                                    Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                    NoteThis is a business version Id, not a resource version Id (see discussion)
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    108. Encounter.serviceType.coding.code
                                    Definition

                                    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                    Shortmsk
                                    Control1..1
                                    BindingThe codes SHALL be taken from Service Type
                                    (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type)
                                    Typecode
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Need to refer to a particular code in the system.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    110. Encounter.serviceType.coding.display
                                    Definition

                                    A representation of the meaning of the code in the system, following the rules of the system.

                                    ShortRepresentation defined by the system
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    112. Encounter.serviceType.coding.userSelected
                                    Definition

                                    Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                    ShortIf this coding was chosen directly by the user
                                    Comments

                                    Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                    Control0..1
                                    Typeboolean
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    114. Encounter.serviceType.text
                                    Definition

                                    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                    ShortPlain text representation of the concept
                                    Comments

                                    Very often the text is the same as a displayName of one of the codings.

                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    116. Encounter.priority
                                    Definition

                                    Indicates the urgency of the encounter.

                                    ShortIndicates the urgency of the encounter
                                    Control0..0
                                    BindingFor example codes, see ActPriority
                                    (example to http://terminology.hl7.org/ValueSet/v3-ActPriority)

                                    Indicates the urgency of the encounter.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    118. Encounter.subject
                                    Definition

                                    The patient or group present at the encounter.

                                    ShortThe patient or group present at the encounter
                                    Comments

                                    While the encounter is always about the patient, the patient might not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).

                                    Control1..1
                                    TypeReference(ACC ICP Patient)
                                    Is Modifierfalse
                                    Summarytrue
                                    Alternate Namespatient
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    120. Encounter.episodeOfCare
                                    Definition

                                    Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).

                                    ShortEpisode(s) of care that this encounter should be recorded against
                                    Control0..0
                                    TypeReference(EpisodeOfCare)
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    122. Encounter.basedOn
                                    Definition

                                    The request this encounter satisfies (e.g. incoming referral or procedure request).

                                    ShortThe ServiceRequest that initiated this encounter
                                    Control0..0
                                    TypeReference(ServiceRequest)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate NamesincomingReferral
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    124. Encounter.participant
                                    Definition

                                    The list of people responsible for providing the service.

                                    ShortList of participants involved in the encounter
                                    Control0..0
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    132. Encounter.appointment
                                    Definition

                                    The appointment that scheduled this encounter.

                                    ShortThe appointment that scheduled this encounter
                                    Control0..0
                                    TypeReference(Appointment)
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    134. Encounter.period
                                    Definition

                                    The start and end time of the encounter.

                                    ShortThe start and end time of the encounter
                                    Comments

                                    If not (yet) known, the end of the Period may be omitted.

                                    Control0..0
                                    TypePeriod
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    136. Encounter.length
                                    Definition

                                    Quantity of time the encounter lasted. This excludes the time during leaves of absence.

                                    ShortQuantity of time the encounter lasted (less time absent)
                                    Comments

                                    May differ from the time the Encounter.period lasted because of leave of absence.

                                    Control0..0
                                    TypeDuration
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    138. Encounter.reasonCode
                                    Definition

                                    Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                                    ShortCoded reason the encounter takes place
                                    Comments

                                    For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                                    Control0..0
                                    BindingThe codes SHOULD be taken from EncounterReasonCodes
                                    (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                                    Reason why the encounter takes place.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summarytrue
                                    Alternate NamesIndication, Admission diagnosis
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    140. Encounter.reasonReference
                                    Definition

                                    Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.

                                    ShortReason the encounter takes place (reference)
                                    Comments

                                    For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis).

                                    Control0..0
                                    TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
                                    Is Modifierfalse
                                    Summarytrue
                                    Alternate NamesIndication, Admission diagnosis
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    142. Encounter.diagnosis
                                    Definition

                                    The list of diagnosis relevant to this encounter.

                                    ShortThe list of diagnosis relevant to this encounter
                                    Control0..0
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    150. Encounter.account
                                    Definition

                                    The set of accounts that may be used for billing for this Encounter.

                                    ShortThe set of accounts that may be used for billing for this Encounter
                                    Comments

                                    The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules.

                                    Control0..0
                                    TypeReference(Account)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    152. Encounter.hospitalization
                                    Definition

                                    Details about the admission to a healthcare service.

                                    ShortDetails about the admission to a healthcare service
                                    Comments

                                    An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included.

                                    The duration recorded in the period of this encounter covers the entire scope of this hospitalization record.

                                    Control0..0
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    166. Encounter.location
                                    Definition

                                    List of locations where the patient has been during this encounter.

                                    ShortList of locations where the patient has been
                                    Comments

                                    Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual".

                                    Control0..0
                                    TypeBackboneElement
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    175. Encounter.serviceProvider
                                    Definition

                                    The organization that is primarily responsible for this Encounter's services. This MAY be the same as the organization on the Patient record, however it could be different, such as if the actor performing the services was from an external organization (which may be billed seperately) for an external consultation. Refer to the example bundle showing an abbreviated set of Encounters for a colonoscopy.

                                    ShortThis is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
                                    Control1..1
                                    TypeReference(Organization)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    177. Encounter.partOf
                                    Definition

                                    Another Encounter of which this encounter is a part of (administratively or in time).

                                    ShortAnother Encounter this encounter is part of
                                    Comments

                                    This is also used for associating a child's encounter back to the mother's encounter.

                                    Refer to the Notes section in the Patient resource for further details.

                                    Control0..0
                                    TypeReference(Encounter)
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))