pca-healthcare-service-identifier
type: StructureDefinition
node role: treeRoot
resource.id:
  value: pca-healthcare-service-identifier
domain resource.text:
  narrative.status:
    value: extensions
  narrative.div: Name Flags Card. Type Description & Constraints Identifier 0..* Identifier PCA Healthcare Service Identifier (PCA-HSI) system 1..1 uri The namespace for the identifier value Fixed Value: http://pca.digitalhealth.gov.au/id/pca-healthcare-service value 1..1 string PCA-HSI Documentation for this format
structure definition.url:
  value: http://pca.digitalhealth.gov.au/fhir/4.0/StructureDefinition/pca-healthcare-service-identifier
structure definition.version:
  value: 2.4.0
structure definition.name:
  value: PcaHealthcareServiceIdentifier
structure definition.title:
  value: PCA Healthcare Service Identifier (PCA-HSI)
structure definition.status:
  value: draft
structure definition.date:
  value: 2023-09-15T10:45:26+10:00
structure definition.publisher:
  value: Australian Digital Health Agency
structure definition.contact:
  index: 0
  contact detail.telecom:
    index: 0
    contact point.system:
      value: email
structure definition.description:
  value: This profile of Identifier defines a PCA Healthcare Service Identifier (PCA-HSI). A PCA-HSI is an identifier issued by the PCA service to each PCA Healthcare Service.
structure definition.copyright:
  value: Copyright © 2023 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/.
structure definition.fhir version:
  value: 4.0.1
structure definition.mapping:
  index: 0
  structure definition.mapping.identity:
    value: v2
  structure definition.mapping.uri:
    value: http://hl7.org/v2
  structure definition.mapping.name:
    value: HL7 v2 Mapping
structure definition.mapping:
  index: 1
  structure definition.mapping.identity:
    value: rim
  structure definition.mapping.uri:
    value: http://hl7.org/v3
  structure definition.mapping.name:
    value: RIM Mapping
structure definition.mapping:
  index: 2
  structure definition.mapping.identity:
    value: servd
  structure definition.mapping.uri:
    value: http://www.omg.org/spec/ServD/1.0/
  structure definition.mapping.name:
    value: ServD
structure definition.kind:
  value: complex-type
structure definition.abstract:
  value: false
structure definition.type:
  value: Identifier
structure definition.base definition:
  value: http://hl7.org/fhir/StructureDefinition/Identifier
  link: http://hl7.org/fhir/StructureDefinition/Identifier
structure definition.derivation:
  value: constraint
structure definition.snapshot:
  structure definition.snapshot.element:
    index: 0
    element.id:
      value: Identifier
    element definition.path:
      value: Identifier
    element definition.short:
      value: PCA Healthcare Service Identifier (PCA-HSI)
    element definition.definition:
      value: The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service.
    element definition.min:
      value: 0
    element definition.max:
      value: *
    element definition.base:
      element definition.base.path:
        value: Identifier
      element definition.base.min:
        value: 0
      element definition.base.max:
        value: *
    element definition.condition:
      value: ele-1
      index: 0
    element definition.constraint:
      index: 0
      element definition.constraint.key:
        value: ele-1
      element definition.constraint.severity:
        value: error
      element definition.constraint.human:
        value: All FHIR elements must have a @value or children
      element definition.constraint.expression:
        value: hasValue() or (children().count() > id.count())
      element definition.constraint.xpath:
        value: @value|f:*|h:div
      element definition.constraint.source:
        value: http://hl7.org/fhir/StructureDefinition/Element
        link: http://hl7.org/fhir/StructureDefinition/Element
    element definition.is modifier:
      value: false
    element definition.mapping:
      index: 0
      element definition.mapping.identity:
        value: rim
      element definition.mapping.map:
        value: n/a
    element definition.mapping:
      index: 1
      element definition.mapping.identity:
        value: v2
      element definition.mapping.map:
        value: CX / EI (occasionally, more often EI maps to a resource id or a URL)
    element definition.mapping:
      index: 2
      element definition.mapping.identity:
        value: rim
      element definition.mapping.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]
    element definition.mapping:
      index: 3
      element definition.mapping.identity:
        value: servd
      element definition.mapping.map:
        value: Identifier
  structure definition.snapshot.element:
    index: 1
    element.id:
      value: Identifier.id
    element definition.path:
      value: Identifier.id
    element definition.representation:
      value: xmlAttr
      index: 0
    element definition.short:
      value: Unique id for inter-element referencing
    element definition.definition:
      value: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    element definition.min:
      value: 0
    element definition.max:
      value: 1
    element definition.base:
      element definition.base.path:
        value: Element.id
      element definition.base.min:
        value: 0
      element definition.base.max:
        value: 1
    element definition.type:
      index: 0
      element.extension:
        index: 0
      element definition.type.code:
        value: http://hl7.org/fhirpath/System.String
    element definition.is modifier:
      value: false
    element definition.is summary:
      value: false
    element definition.mapping:
      index: 0
      element definition.mapping.identity:
        value: rim
      element definition.mapping.map:
        value: n/a
  structure definition.snapshot.element:
    index: 2
    element.id:
      value: Identifier.extension
    element definition.path:
      value: Identifier.extension
    element definition.slicing:
      element definition.slicing.discriminator:
        index: 0
      element definition.slicing.description:
        value: Extensions are always sliced by (at least) url
      element definition.slicing.rules:
        value: open
    element definition.short:
      value: Additional content defined by implementations
    element definition.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.
    element definition.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.
    element definition.alias:
      value: extensions
      index: 0
    element definition.alias:
      value: user content
      index: 1
    element definition.min:
      value: 0

value: string

value: value

value: url

value: *

element definition.base.path:
  value: Element.extension
element definition.base.min:
  value: 0
element definition.base.max:
  value: *

index: 0
element definition.type.code:
  value: Extension

index: 0
element definition.constraint.key:
  value: ele-1
element definition.constraint.severity:
  value: error
element definition.constraint.human:
  value: All FHIR elements must have a @value or children
element definition.constraint.expression:
  value: hasValue() or (children().count() > id.count())
element definition.constraint.xpath:
  value: @value|f:*|h:div
element definition.constraint.source:
  value: http://hl7.org/fhir/StructureDefinition/Element
  link: http://hl7.org/fhir/StructureDefinition/Element

index: 1
element definition.constraint.key:
  value: ext-1
element definition.constraint.severity:
  value: error
element definition.constraint.human:
  value: Must have either extensions or value[x], not both
element definition.constraint.expression:
  value: extension.exists() != value.exists()
element definition.constraint.xpath:
  value: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
element definition.constraint.source:
  value: http://hl7.org/fhir/StructureDefinition/Extension
  link: http://hl7.org/fhir/StructureDefinition/Extension

value: false

value: false

index: 0
element definition.mapping.identity:
  value: rim
element definition.mapping.map:
  value: n/a

index: 3
element.id:
  value: Identifier.use
element definition.path:
  value: Identifier.use
element definition.short:
  value: usual | official | temp | secondary | old (If known)
element definition.definition:
  value: The purpose of this identifier.
element definition.comment:
  value: Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
element definition.requirements:
  value: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
element definition.min:
  value: 0
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Identifier.use
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: code
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: true
element definition.is modifier reason:
  value: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
element definition.is summary:
  value: true
element definition.binding:
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    extension.value string:
      value: IdentifierUse
  element definition.binding.strength:
    value: required
  element definition.binding.description:
    value: Identifies the purpose for this identifier, if known .
  element definition.binding.value set:
    value: http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    link: 4.0
    link: .1
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: v2
  element definition.mapping.map:
    value: N/A
element definition.mapping:
  index: 1
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: Role.code or implied by context

index: 4
element.id:
  value: Identifier.type
element definition.path:
  value: Identifier.type
element definition.short:
  value: Description of identifier
element definition.definition:
  value: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
element definition.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.
element definition.requirements:
  value: Allows users to make use of identifiers when the identifier system is not known.
element definition.min:
  value: 0
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Identifier.type
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: CodeableConcept
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: false
element definition.is summary:
  value: true
element definition.binding:
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    extension.value string:
      value: IdentifierType
  element.extension:
    index: 1
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    extension.value boolean:
      value: true
  element definition.binding.strength:
    value: extensible
  element definition.binding.description:
    value: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  element definition.binding.value set:
    value: http://hl7.org/fhir/ValueSet/identifier-type
    link: http://hl7.org/fhir/ValueSet/identifier-type
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: v2
  element definition.mapping.map:
    value: CX.5
element definition.mapping:
  index: 1
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: Role.code or implied by context

index: 5
element.id:
  value: Identifier.system
element definition.path:
  value: Identifier.system
element definition.short:
  value: The namespace for the identifier value
element definition.definition:
  value: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
element definition.comment:
  value: Identifier.system is always case sensitive.
element definition.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.
element definition.min:
  value: 1
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Identifier.system
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: uri
element definition.fixed uri:
  value: http://pca.digitalhealth.gov.au/id/pca-healthcare-service
element definition.example:
  index: 0
  element definition.example.label:
    value: General
  element definition.example.value uri:
    value: http://www.acme.com/identifiers/patient
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: false
element definition.is summary:
  value: true
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: v2
  element definition.mapping.map:
    value: CX.4 / EI-2-4
element definition.mapping:
  index: 1
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: II.root or Role.id.root
element definition.mapping:
  index: 2
  element definition.mapping.identity:
    value: servd
  element definition.mapping.map:
    value: ./IdentifierType

index: 6
element.id:
  value: Identifier.value
element definition.path:
  value: Identifier.value
element definition.short:
  value: PCA-HSI
element definition.definition:
  value: The portion of the identifier typically relevant to the user and which is unique within the context of the system.
element definition.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.
element definition.min:
  value: 1
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Identifier.value
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: string
element definition.example:
  index: 0
  element definition.example.label:
    value: General
  element definition.example.value string:
    value: 123456
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: false
element definition.is summary:
  value: true
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: v2
  element definition.mapping.map:
    value: CX.1 / EI.1
element definition.mapping:
  index: 1
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
element definition.mapping:
  index: 2
  element definition.mapping.identity:
    value: servd
  element definition.mapping.map:
    value: ./Value

index: 7
element.id:
  value: Identifier.period
element definition.path:
  value: Identifier.period
element definition.short:
  value: Time period when id is/was valid for use
element definition.definition:
  value: Time period during which identifier is/was valid for use.
element definition.min:
  value: 0
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Identifier.period
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: Period
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: false
element definition.is summary:
  value: true
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: v2
  element definition.mapping.map:
    value: CX.7 + CX.8
element definition.mapping:
  index: 1
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: Role.effectiveTime or implied by context
element definition.mapping:
  index: 2
  element definition.mapping.identity:
    value: servd
  element definition.mapping.map:
    value: ./StartDate and ./EndDate

index: 8
element.id:
  value: Identifier.assigner
element definition.path:
  value: Identifier.assigner
element definition.short:
  value: Organization that issued id (may be just text)
element definition.definition:
  value: Organization that issued/manages the identifier.
element definition.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.
element definition.min:
  value: 0
element definition.max:
  value: 1
element definition.base:
  element definition.base.path:
    value: Identifier.assigner
  element definition.base.min:
    value: 0
  element definition.base.max:
    value: 1
element definition.type:
  index: 0
  element definition.type.code:
    value: Reference
  element definition.type.target profile:
    value: http://hl7.org/fhir/StructureDefinition/Organization
    index: 0
    link: http://hl7.org/fhir/StructureDefinition/Organization
element definition.constraint:
  index: 0
  element definition.constraint.key:
    value: ele-1
  element definition.constraint.severity:
    value: error
  element definition.constraint.human:
    value: All FHIR elements must have a @value or children
  element definition.constraint.expression:
    value: hasValue() or (children().count() > id.count())
  element definition.constraint.xpath:
    value: @value|f:*|h:div
  element definition.constraint.source:
    value: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
element definition.is modifier:
  value: false
element definition.is summary:
  value: true
element definition.mapping:
  index: 0
  element definition.mapping.identity:
    value: v2
  element definition.mapping.map:
    value: CX.4 / (CX.4,CX.9,CX.10)
element definition.mapping:
  index: 1
  element definition.mapping.identity:
    value: rim
  element definition.mapping.map:
    value: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
element definition.mapping:
  index: 2
  element definition.mapping.identity:
    value: servd
  element definition.mapping.map:
    value: ./IdentifierIssuingAuthority

structure definition.differential.element:
  index: 0
  element.id:
    value: Identifier
  element definition.path:
    value: Identifier
  element definition.short:
    value: PCA Healthcare Service Identifier (PCA-HSI)
  element definition.definition:
    value: The PCA Healthcare Service Identifier (PCA-HSI) issued by the PCA service to each Healthcare Service.
structure definition.differential.element:
  index: 1
  element.id:
    value: Identifier.system
  element definition.path:
    value: Identifier.system
  element definition.min:
    value: 1
  element definition.fixed uri:
    value: http://pca.digitalhealth.gov.au/id/pca-healthcare-service
structure definition.differential.element:
  index: 2
  element.id:
    value: Identifier.value
  element definition.path:
    value: Identifier.value
  element definition.short:
    value: PCA-HSI
  element definition.min:
    value: 1