Provider Connect Australia (PCA)
24.2.0.0 - active

Provider Connect Australia (PCA) - Local Development build (v24.2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Data Type Profile: PcaPartnerServiceIdentifier - XML Profile

Active as of 2024-09-23

XML representation of the pca-partner-service-identifier data type profile.

Raw xml | Download

    <StructureDefinition xmlns="http://hl7.org/fhir">
      <id value="pca-partner-service-identifier"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition pca-partner-service-identifier</b></p><a name="pca-partner-service-identifier"> </a><a name="hcpca-partner-service-identifier"> </a><a name="pca-partner-service-identifier-en-AU"> </a><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64, " alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-pca-partner-service-identifier-definitions.html#Identifier" title="The PCA Partner Service Identifier (PCA-PSI) issued by the PCA service to each Partner Service.">Identifier</a><a name="Identifier"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">PCA Partner Service Identifier (PCA-PSI)</td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-pca-partner-service-identifier-definitions.html#Identifier.system">system</a><a name="Identifier.system"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">The namespace for the identifier value</span><br/><span style="font-weight:bold">Fixed Value: </span><span style="color: darkgreen">http://pca.digitalhealth.gov.au/id/partner-service</span></td></tr>
    <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-pca-partner-service-identifier-definitions.html#Identifier.value">value</a><a name="Identifier.value"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..<span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.5" href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">PCA-PSI</td></tr>
    <tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64, " alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
      </text>
      <url
           value="http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-partner-service-identifier"/>
      <version value="24.2.0.0"/>
      <name value="PcaPartnerServiceIdentifier"/>
      <title value="PCA Partner Service Identifier (PCA-PSI)"/>
      <status value="active"/>
      <date value="2024-09-23T10:57:22+10:00"/>
      <publisher value="Australian Digital Health Agency"/>
      <contact>
        <telecom>
          <system value="email"/>
          <value value="mailto:help@digitalhealth.gov.au"/>
        </telecom>
      </contact>
      <description
                   value="This profile of Identifier defines a PCA Partner Service Identifier (PCA-PSI). A PCA-PSI is an identifier issued by the PCA service to each PCA Partner Service."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="AU"/>
        </coding>
      </jurisdiction>
      <copyright
                 value="Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/."/>
      <fhirVersion value="4.0.1"/>
      <mapping>
        <identity value="v2"/>
        <uri value="http://hl7.org/v2"/>
        <name value="HL7 v2 Mapping"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <uri value="http://hl7.org/v3"/>
        <name value="RIM Mapping"/>
      </mapping>
      <mapping>
        <identity value="servd"/>
        <uri value="http://www.omg.org/spec/ServD/1.0/"/>
        <name value="ServD"/>
      </mapping>
      <kind value="complex-type"/>
      <abstract value="false"/>
      <type value="Identifier"/>
      <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier"/>
      <derivation value="constraint"/>
      <snapshot>
        <element id="Identifier">
          <path value="Identifier"/>
          <short value="PCA Partner Service Identifier (PCA-PSI)"/>
          <definition
                      value="The PCA Partner Service Identifier (PCA-PSI) issued by the PCA service to each Partner Service."/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="Identifier"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <condition value="ele-1"/>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
          <mapping>
            <identity value="v2"/>
            <map
                 value="CX / EI (occasionally, more often EI maps to a resource id or a URL)"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value="II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]"/>
          </mapping>
          <mapping>
            <identity value="servd"/>
            <map value="Identifier"/>
          </mapping>
        </element>
        <element id="Identifier.id">
          <path value="Identifier.id"/>
          <representation value="xmlAttr"/>
          <short value="Unique id for inter-element referencing"/>
          <definition
                      value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Element.id"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
              <valueUrl value="string"/>
            </extension>
            <code value="http://hl7.org/fhirpath/System.String"/>
          </type>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="Identifier.extension">
          <path value="Identifier.extension"/>
          <slicing>
            <discriminator>
              <type value="value"/>
              <path value="url"/>
            </discriminator>
            <description value="Extensions are always sliced by (at least) url"/>
            <rules value="open"/>
          </slicing>
          <short value="Additional content defined by implementations"/>
          <definition
                      value="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."/>
          <comment
                   value="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."/>
          <alias value="extensions"/>
          <alias value="user content"/>
          <min value="0"/>
          <max value="*"/>
          <base>
            <path value="Element.extension"/>
            <min value="0"/>
            <max value="*"/>
          </base>
          <type>
            <code value="Extension"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <constraint>
            <key value="ext-1"/>
            <severity value="error"/>
            <human value="Must have either extensions or value[x], not both"/>
            <expression value="extension.exists() != value.exists()"/>
            <xpath
                   value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), &quot;value&quot;)])"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Extension"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="false"/>
          <mapping>
            <identity value="rim"/>
            <map value="n/a"/>
          </mapping>
        </element>
        <element id="Identifier.use">
          <path value="Identifier.use"/>
          <short value="usual | official | temp | secondary | old (If known)"/>
          <definition value="The purpose of this identifier."/>
          <comment
                   value="Applications can assume that an identifier is permanent unless it explicitly says that it is temporary."/>
          <requirements
                        value="Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Identifier.use"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="code"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="true"/>
          <isModifierReason
                            value="This is labeled as &quot;Is Modifier&quot; because applications should not mistake a temporary id for a permanent one."/>
          <isSummary value="true"/>
          <binding>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
              <valueString value="IdentifierUse"/>
            </extension>
            <strength value="required"/>
            <description
                         value="Identifies the purpose for this identifier, if known ."/>
            <valueSet value="http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"/>
          </binding>
          <mapping>
            <identity value="v2"/>
            <map value="N/A"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="Role.code or implied by context"/>
          </mapping>
        </element>
        <element id="Identifier.type">
          <path value="Identifier.type"/>
          <short value="Description of identifier"/>
          <definition
                      value="A coded type for the identifier that can be used to determine which identifier to use for a specific purpose."/>
          <comment
                   value="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."/>
          <requirements
                        value="Allows users to make use of identifiers when the identifier system is not known."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Identifier.type"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="CodeableConcept"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <binding>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
              <valueString value="IdentifierType"/>
            </extension>
            <strength value="extensible"/>
            <description
                         value="A coded type for an identifier that can be used to determine which identifier to use for a specific purpose."/>
            <valueSet value="http://hl7.org/fhir/ValueSet/identifier-type"/>
          </binding>
          <mapping>
            <identity value="v2"/>
            <map value="CX.5"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="Role.code or implied by context"/>
          </mapping>
        </element>
        <element id="Identifier.system">
          <path value="Identifier.system"/>
          <short value="The namespace for the identifier value"/>
          <definition
                      value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique."/>
          <comment value="Identifier.system is always case sensitive."/>
          <requirements
                        value="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."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="Identifier.system"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="uri"/>
          </type>
          <fixedUri value="http://pca.digitalhealth.gov.au/id/partner-service"/>
          <example>
            <label value="General"/>
            <valueUri value="http://www.acme.com/identifiers/patient"/>
          </example>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="CX.4 / EI-2-4"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="II.root or Role.id.root"/>
          </mapping>
          <mapping>
            <identity value="servd"/>
            <map value="./IdentifierType"/>
          </mapping>
        </element>
        <element id="Identifier.value">
          <path value="Identifier.value"/>
          <short value="PCA-PSI"/>
          <definition
                      value="The portion of the identifier typically relevant to the user and which is unique within the context of the system."/>
          <comment
                   value="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](http://hl7.org/fhir/R4/extension-rendered-value.html). 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."/>
          <min value="1"/>
          <max value="1"/>
          <base>
            <path value="Identifier.value"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="string"/>
          </type>
          <example>
            <label value="General"/>
            <valueString value="123456"/>
          </example>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="CX.1 / EI.1"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value="II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"/>
          </mapping>
          <mapping>
            <identity value="servd"/>
            <map value="./Value"/>
          </mapping>
        </element>
        <element id="Identifier.period">
          <path value="Identifier.period"/>
          <short value="Time period when id is/was valid for use"/>
          <definition
                      value="Time period during which identifier is/was valid for use."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Identifier.period"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Period"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="CX.7 + CX.8"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map value="Role.effectiveTime or implied by context"/>
          </mapping>
          <mapping>
            <identity value="servd"/>
            <map value="./StartDate and ./EndDate"/>
          </mapping>
        </element>
        <element id="Identifier.assigner">
          <path value="Identifier.assigner"/>
          <short value="Organization that issued id (may be just text)"/>
          <definition value="Organization that issued/manages the identifier."/>
          <comment
                   value="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."/>
          <min value="0"/>
          <max value="1"/>
          <base>
            <path value="Identifier.assigner"/>
            <min value="0"/>
            <max value="1"/>
          </base>
          <type>
            <code value="Reference"/>
            <targetProfile
                           value="http://hl7.org/fhir/StructureDefinition/Organization"/>
          </type>
          <constraint>
            <key value="ele-1"/>
            <severity value="error"/>
            <human value="All FHIR elements must have a @value or children"/>
            <expression
                        value="hasValue() or (children().count() &gt; id.count())"/>
            <xpath value="@value|f:*|h:div"/>
            <source value="http://hl7.org/fhir/StructureDefinition/Element"/>
          </constraint>
          <isModifier value="false"/>
          <isSummary value="true"/>
          <mapping>
            <identity value="v2"/>
            <map value="CX.4 / (CX.4,CX.9,CX.10)"/>
          </mapping>
          <mapping>
            <identity value="rim"/>
            <map
                 value="II.assigningAuthorityName but note that this is an improper use by the definition of the field.  Also Role.scoper"/>
          </mapping>
          <mapping>
            <identity value="servd"/>
            <map value="./IdentifierIssuingAuthority"/>
          </mapping>
        </element>
      </snapshot>
      <differential>
        <element id="Identifier">
          <path value="Identifier"/>
          <short value="PCA Partner Service Identifier (PCA-PSI)"/>
          <definition
                      value="The PCA Partner Service Identifier (PCA-PSI) issued by the PCA service to each Partner Service."/>
        </element>
        <element id="Identifier.system">
          <path value="Identifier.system"/>
          <min value="1"/>
          <fixedUri value="http://pca.digitalhealth.gov.au/id/partner-service"/>
        </element>
        <element id="Identifier.value">
          <path value="Identifier.value"/>
          <short value="PCA-PSI"/>
          <min value="1"/>
        </element>
      </differential>
    </StructureDefinition>