New Zealand ICP Implementation Guide
1.0.0 - draft

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: IcpCase - Detailed Descriptions

Active as of 2022-11-20

Definitions for the acc-icp-case resource profile.

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

0. EpisodeOfCare
Invariantsend-date-when-active-invariant: End date is not allowed when status is active (status = 'active' implies period.end.empty())
end-date-when-finished-invariant: End date is required when status is finished (status = 'finished' implies period.end.exists())
2. EpisodeOfCare.contained
SlicingThis element introduces a set of slices on EpisodeOfCare.contained. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • profile @ $this
  • 4. EpisodeOfCare.extension
    Control1..?
    SlicingThis element introduces a set of slices on EpisodeOfCare.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. EpisodeOfCare.extension:acc-providerid
      Slice Nameacc-providerid
      ShortThe ACC provider ID associated with the ICP case
      Control1..1
      TypeExtension(ACC Provider ID) (Extension Type: string)
      8. EpisodeOfCare.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      SlicingThis element introduces a set of slices on EpisodeOfCare.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 10. EpisodeOfCare.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
        12. EpisodeOfCare.identifier:icpclaimnumber.id
        Control0..0
        14. EpisodeOfCare.identifier:icpclaimnumber.extension
        Control0..0
        16. EpisodeOfCare.identifier:icpclaimnumber.system
        Control1..?
        Fixed Valuehttps://standards.digital.health.nz/ns/acc-45-number
        18. EpisodeOfCare.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}$'))
        20. EpisodeOfCare.identifier:icpclaimnumber.period
        Control0..0
        22. EpisodeOfCare.identifier:icpclaimnumber.assigner
        Control0..0
        24. EpisodeOfCare.status
        Definition

        The Status of the ICP case (Active or Finished).

        Shortactive | finished
        BindingThe codes SHALL be taken from Status
        (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status)
        26. EpisodeOfCare.statusHistory
        Control0..0
        28. EpisodeOfCare.type
        ShortThe type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
        Control0..1
        30. EpisodeOfCare.type.coding
        Control1..1
        32. EpisodeOfCare.type.coding.system
        Control1..?
        Pattern Valuehttp://hl7.org.nz/fhir/CodeSystem/acc-icp-service-type
        34. EpisodeOfCare.type.coding.code
        Short(msk | tbi)
        Control1..?
        BindingThe codes SHALL be taken from Service Type
        (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-service-type)
        36. EpisodeOfCare.diagnosis
        Control0..0
        38. EpisodeOfCare.patient
        TypeReference(ACC ICP Patient)
        40. EpisodeOfCare.managingOrganization
        ShortThis is the ACC Vendor ID, in most cases this is the organisation's HPI ID.
        Control1..?
        42. EpisodeOfCare.period
        44. EpisodeOfCare.period.start
        Invariantsdate-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). ($this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
        date-not-in-future-invariant: The date value cannot be in the future ($this <= today())
        46. EpisodeOfCare.period.end
        Invariantsdate-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). ($this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
        date-not-in-future-invariant: The date value cannot be in the future ($this <= today())
        48. EpisodeOfCare.referralRequest
        Control0..0
        50. EpisodeOfCare.careManager
        Control0..0
        52. EpisodeOfCare.team
        Control0..0
        54. EpisodeOfCare.account
        Control0..0

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

        0. EpisodeOfCare
        Definition

        An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

        ShortAn association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Alternate NamesCase Program Problem
        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())
        end-date-when-active-invariant: End date is not allowed when status is active (status = 'active' implies period.end.empty())
        end-date-when-finished-invariant: End date is required when status is finished (status = 'finished' implies period.end.exists())
        2. EpisodeOfCare.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. EpisodeOfCare.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.

        Control0..*
        TypeResource
        Is Modifierfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        SlicingThis element introduces a set of slices on EpisodeOfCare.contained. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • profile @ $this
        • 6. EpisodeOfCare.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.

          Control10..*
          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 EpisodeOfCare.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 8. EpisodeOfCare.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 associated with the ICP case
            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())
            10. EpisodeOfCare.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())
            12. EpisodeOfCare.identifier
            Definition

            The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

            ShortBusiness Identifier(s) relevant for this EpisodeOfCare
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control10..1*
            TypeIdentifier
            Is Modifierfalse
            Summaryfalse
            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 EpisodeOfCare.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • 14. EpisodeOfCare.identifier:icpclaimnumber
              Slice Nameicpclaimnumber
              Definition

              The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

              ShortThe ACC 45 number to be used in combination with the contained patient's date of birth, as the ICP case idenfitier.Business Identifier(s) relevant for this EpisodeOfCare
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control10..1*
              TypeIdentifier
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              16. EpisodeOfCare.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
              18. EpisodeOfCare.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 EpisodeOfCare.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 20. EpisodeOfCare.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()))
                22. EpisodeOfCare.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()))
                24. EpisodeOfCare.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}$'))
                26. EpisodeOfCare.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()))
                28. EpisodeOfCare.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()))
                30. EpisodeOfCare.status
                Definition

                The Status of the ICP case (Active or Finished).


                planned | waitlist | active | onhold | finished | cancelled.

                Shortactive | finishedplanned | waitlist | active | onhold | finished | cancelled | entered-in-error
                Comments

                This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid.

                Control1..1
                BindingThe codes SHALL be taken from Statushttp://hl7.org/fhir/ValueSet/episode-of-care-status|4.0.1
                (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status)
                Typecode
                Is Modifiertrue because This element is labelled 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()))
                32. EpisodeOfCare.statusHistory
                Definition

                The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

                ShortPast list of status codes (the current status may be included to cover the start date of the status)
                Control0..0*
                TypeBackboneElement
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                37. EpisodeOfCare.type
                Definition

                A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

                ShortThe type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.Type/class - e.g. specialist referral, disease management
                Comments

                The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.

                Control0..1*
                BindingFor example codes, see EpisodeOfCareTypehttp://hl7.org/fhir/ValueSet/episodeofcare-type
                (example to http://hl7.org/fhir/ValueSet/episodeofcare-type)

                The type of the episode of care.

                TypeCodeableConcept
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                39. EpisodeOfCare.type.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()))
                41. EpisodeOfCare.type.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()))
                43. EpisodeOfCare.type.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).

                Short(msk | tbi)Symbol 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()))
                45. EpisodeOfCare.diagnosis
                Definition

                The list of diagnosis relevant to this episode of care.

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

                The patient who is the focus of this episode of care.

                ShortThe patient who is the focus of this episode of care
                Control1..1
                TypeReference(ACC ICP Patient, Patient)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                51. EpisodeOfCare.managingOrganization
                Definition

                The organization that has assumed the specific responsibilities for the specified duration.

                ShortThis is the ACC Vendor ID, in most cases this is the organisation's HPI ID.Organization that assumes care
                Control10..1
                TypeReference(Organization)
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                53. EpisodeOfCare.referralRequest
                Definition

                Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.

                ShortOriginating Referral Request(s)
                Control0..0*
                TypeReference(ServiceRequest)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                55. EpisodeOfCare.careManager
                Definition

                The practitioner that is the care manager/care coordinator for this patient.

                ShortCare manager/care coordinator for the patient
                Control0..01
                TypeReference(Practitioner, PractitionerRole)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                57. EpisodeOfCare.team
                Definition

                The list of practitioners that may be facilitating this episode of care for specific purposes.

                ShortOther practitioners facilitating this episode of care
                Control0..0*
                TypeReference(CareTeam)
                Is Modifierfalse
                Summaryfalse
                Alternate NamesCareTeam
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                59. EpisodeOfCare.account
                Definition

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

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

                The billing system may choose to allocate billable items associated with the EpisodeOfCare 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()))

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

                0. EpisodeOfCare
                Definition

                An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.

                ShortAn association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
                Control0..*
                Is Modifierfalse
                Summaryfalse
                Alternate NamesCase Program Problem
                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())
                end-date-when-active-invariant: End date is not allowed when status is active (status = 'active' implies period.end.empty())
                end-date-when-finished-invariant: End date is required when status is finished (status = 'finished' implies period.end.exists())
                2. EpisodeOfCare.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. EpisodeOfCare.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. EpisodeOfCare.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. EpisodeOfCare.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. EpisodeOfCare.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. EpisodeOfCare.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.

                Control0..*
                TypeResource
                Is Modifierfalse
                Summaryfalse
                Alternate Namesinline resources, anonymous resources, contained resources
                SlicingThis element introduces a set of slices on EpisodeOfCare.contained. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • profile @ $this
                • 14. EpisodeOfCare.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control1..*
                  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 EpisodeOfCare.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 16. EpisodeOfCare.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 associated with the ICP case
                    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())
                    18. EpisodeOfCare.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())
                    20. EpisodeOfCare.identifier
                    Definition

                    The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

                    ShortBusiness Identifier(s) relevant for this EpisodeOfCare
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control1..1
                    TypeIdentifier
                    Is Modifierfalse
                    Summaryfalse
                    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 EpisodeOfCare.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ system
                    • 22. EpisodeOfCare.identifier:icpclaimnumber
                      Slice Nameicpclaimnumber
                      Definition

                      The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.

                      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
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      24. EpisodeOfCare.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
                      26. EpisodeOfCare.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 EpisodeOfCare.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 28. EpisodeOfCare.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()))
                        30. EpisodeOfCare.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()))
                        32. EpisodeOfCare.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()))
                        34. EpisodeOfCare.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}$'))
                        36. EpisodeOfCare.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()))
                        38. EpisodeOfCare.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()))
                        40. EpisodeOfCare.status
                        Definition

                        The Status of the ICP case (Active or Finished).

                        Shortactive | finished
                        Comments

                        This element is labeled as a modifier because the status contains codes that mark the episode as not currently valid.

                        Control1..1
                        BindingThe codes SHALL be taken from Status
                        (required to http://hl7.org.nz/fhir/ValueSet/acc-icp-episodeofcare-status)
                        Typecode
                        Is Modifiertrue because This element is labelled 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()))
                        42. EpisodeOfCare.statusHistory
                        Definition

                        The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).

                        ShortPast list of status codes (the current status may be included to cover the start date of the status)
                        Control0..0
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        49. EpisodeOfCare.type
                        Definition

                        A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.

                        ShortThe type of ICP service. Currently only musculoskeletal (msk) is allowed, with more to be added in the future, e.g. concussion.
                        Comments

                        The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.

                        Control0..1
                        BindingFor example codes, see EpisodeOfCareType
                        (example to http://hl7.org/fhir/ValueSet/episodeofcare-type)

                        The type of the episode of care.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        51. EpisodeOfCare.type.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
                        53. EpisodeOfCare.type.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 EpisodeOfCare.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 55. EpisodeOfCare.type.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()))
                          57. EpisodeOfCare.type.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
                          59. EpisodeOfCare.type.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 EpisodeOfCare.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 61. EpisodeOfCare.type.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()))
                            63. EpisodeOfCare.type.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()))
                            65. EpisodeOfCare.type.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).

                            Short(msk | tbi)
                            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()))
                            67. EpisodeOfCare.type.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()))
                            69. EpisodeOfCare.type.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()))
                            71. EpisodeOfCare.type.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()))
                            73. EpisodeOfCare.diagnosis
                            Definition

                            The list of diagnosis relevant to this episode of care.

                            ShortThe list of diagnosis relevant to this episode of care
                            Control0..0
                            TypeBackboneElement
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            81. EpisodeOfCare.patient
                            Definition

                            The patient who is the focus of this episode of care.

                            ShortThe patient who is the focus of this episode of care
                            Control1..1
                            TypeReference(ACC ICP Patient)
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            83. EpisodeOfCare.managingOrganization
                            Definition

                            The organization that has assumed the specific responsibilities for the specified duration.

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

                            The interval during which the managing organization assumes the defined responsibility.

                            ShortInterval during responsibility is assumed
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            87. EpisodeOfCare.period.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
                            89. EpisodeOfCare.period.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 EpisodeOfCare.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 91. EpisodeOfCare.period.start
                              Definition

                              The start of the period. The boundary is inclusive.

                              ShortStarting time with inclusive boundary
                              Comments

                              If the low element is missing, the meaning is that the low boundary is not known.

                              Control0..1
                              This element is affected by the following invariants: per-1
                              TypedateTime
                              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()))
                              date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). ($this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
                              date-not-in-future-invariant: The date value cannot be in the future ($this <= today())
                              93. EpisodeOfCare.period.end
                              Definition

                              The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                              ShortEnd time with inclusive boundary, if not ongoing
                              Comments

                              The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                              Control0..1
                              This element is affected by the following invariants: per-1
                              TypedateTime
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). ($this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$'))
                              date-not-in-future-invariant: The date value cannot be in the future ($this <= today())
                              95. EpisodeOfCare.referralRequest
                              Definition

                              Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.

                              ShortOriginating Referral Request(s)
                              Control0..0
                              TypeReference(ServiceRequest)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              97. EpisodeOfCare.careManager
                              Definition

                              The practitioner that is the care manager/care coordinator for this patient.

                              ShortCare manager/care coordinator for the patient
                              Control0..0
                              TypeReference(Practitioner, PractitionerRole)
                              Is Modifierfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              99. EpisodeOfCare.team
                              Definition

                              The list of practitioners that may be facilitating this episode of care for specific purposes.

                              ShortOther practitioners facilitating this episode of care
                              Control0..0
                              TypeReference(CareTeam)
                              Is Modifierfalse
                              Summaryfalse
                              Alternate NamesCareTeam
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              101. EpisodeOfCare.account
                              Definition

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

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

                              The billing system may choose to allocate billable items associated with the EpisodeOfCare 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()))