STARS Implementation Guide
0.5.1 - release

This page is part of the Csiro Stars (v0.5.1: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: CSIRO STARS Patient Profile

Official URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient Version: 0.5.1
Active as of 2025-10-15 Computable Name: CsiroStarsPatientProfile

A patient, primarily animal

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHuman S 1..1 boolean Is Human
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/is-human
.... extension:animal S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal
.... extension:age S 0..1 Age Patient Age
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age
.... extension:ageGrouping S 0..1 string Patient Age Grouping
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age-grouping
... identifier SΣ 1..* Identifier An identifier for this patient
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: STARS Identifier Type (required)
.... value ΣC 0..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... text SΣ 1..1 string Text representation of the full name
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(CSIRO STARS RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Required Pattern: refer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.type Base required STARS Identifier Type 📦0.5.1 This IG
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... language 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHuman S 1..1 boolean Is Human
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/is-human
.... extension:animal S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal
.... extension:age S 0..1 Age Patient Age
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age
.... extension:ageGrouping S 0..1 string Patient Age Grouping
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age-grouping
... identifier S 1..* Identifier An identifier for this patient
.... type 0..1 CodeableConcept Description of identifier
Binding: STARS Identifier Type (required)
.... value 0..1 string The value that is unique
.... use 0..0
.... text S 1..1 string Text representation of the full name
.... family 0..0
.... given 0..0
.... prefix 0..0
.... suffix 0..0
.... period 0..0
... telecom 0..0
... gender S 0..1 code male | female | other | unknown
... birthDate 0..0
... address 0..0
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication 0..0
... generalPractitioner 0..0
... managingOrganization 0..0
... link
.... other S 1..1 Reference(CSIRO STARS RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: refer

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier.type Base required STARS Identifier Type 📦0.5.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHuman S 1..1 boolean Is Human
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/is-human
.... extension:animal S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal
.... extension:age S 0..1 Age Patient Age
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age
.... extension:ageGrouping S 0..1 string Patient Age Grouping
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age-grouping
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier An identifier for this patient
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: STARS Identifier Type (required)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text SΣ 1..1 string Text representation of the full name
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(CSIRO STARS RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Required Pattern: refer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.type Base required STARS Identifier Type 📦0.5.1 This IG
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍5.0.0 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHuman S 1..1 boolean Is Human
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/is-human
.... extension:animal S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal
.... extension:age S 0..1 Age Patient Age
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age
.... extension:ageGrouping S 0..1 string Patient Age Grouping
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age-grouping
... identifier SΣ 1..* Identifier An identifier for this patient
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: STARS Identifier Type (required)
.... value ΣC 0..1 string The value that is unique
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... text SΣ 1..1 string Text representation of the full name
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(CSIRO STARS RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Required Pattern: refer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.type Base required STARS Identifier Type 📦0.5.1 This IG
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... language 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHuman S 1..1 boolean Is Human
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/is-human
.... extension:animal S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal
.... extension:age S 0..1 Age Patient Age
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age
.... extension:ageGrouping S 0..1 string Patient Age Grouping
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age-grouping
... identifier S 1..* Identifier An identifier for this patient
.... type 0..1 CodeableConcept Description of identifier
Binding: STARS Identifier Type (required)
.... value 0..1 string The value that is unique
.... use 0..0
.... text S 1..1 string Text representation of the full name
.... family 0..0
.... given 0..0
.... prefix 0..0
.... suffix 0..0
.... period 0..0
... telecom 0..0
... gender S 0..1 code male | female | other | unknown
... birthDate 0..0
... address 0..0
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication 0..0
... generalPractitioner 0..0
... managingOrganization 0..0
... link
.... other S 1..1 Reference(CSIRO STARS RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: refer

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.identifier.type Base required STARS Identifier Type 📦0.5.1 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHuman S 1..1 boolean Is Human
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/is-human
.... extension:animal S 0..1 (Complex) Extension
URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal
.... extension:age S 0..1 Age Patient Age
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age
.... extension:ageGrouping S 0..1 string Patient Age Grouping
URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/patient-age-grouping
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier An identifier for this patient
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: STARS Identifier Type (required)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... text SΣ 1..1 string Text representation of the full name
... gender SΣ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to a Patient or RelatedPerson resource that concerns the same actual individual
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other SΣ 1..1 Reference(CSIRO STARS RelatedPerson Profile) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code
Required Pattern: refer

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.type Base required STARS Identifier Type 📦0.5.1 This IG
Patient.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍5.0.0 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
Patient.communication.​language Base required All Languages 📍5.0.0 FHIR Std.
Patient.link.type Base required Link Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Patient If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Patient 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Patient 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 error Patient If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Patient A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron