This page is part of the Csiro Stars (v0.3.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
Extension: CSIRO STARS Patient Animal Profile
| Official URL: https://starsapi.csiro.au/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | Version: 0.3.0 | |||
| Active as of 2025-06-03 | Computable Name: CsiroStarsPatientAnimalProfile | |||
An animals species, breed and gender status
Context of Use
-
Element ID:
Patient
This extension may be used on the following element(s)
Usage info
Usages:
- Use this Extension: CSIRO STARS Patient Profile
Formal Views of Extension Content
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from PatAnimal
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
PatAnimal | |||
  Slices for extension |
Content/Rules for all slices | |||
   extension:species |
1..1 | Extension | Extension | |
  value[x] |
1..1 | CodeableConcept | Value of extension Binding: STARS Species Value Set (required) | |
 extension:genderStatus |
0..1 | Extension | Extension | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: GenderStatus (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..1 | PatAnimal | This patient is known to be an animal (non-human) | |
  id |
0..1 | id | Unique id for inter-element referencing | |
  Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 extension:species |
1..1 | Extension | Extension | |
 id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "species" | |
 value[x] |
1..1 | CodeableConcept | Value of extension Binding: STARS Species Value Set (required) | |
| extension:breed |
0..1 | Extension | The animal breed. E.g. Poodle, Angus. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "breed" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: AnimalBreeds (example): The breed of an animal. | |
| extension:genderStatus |
0..1 | Extension | Extension | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "genderStatus" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: GenderStatus (required) | |
 url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |
| Documentation for this format | ||||
This structure is derived from PatAnimal
Differential View
This structure is derived from PatAnimal
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
PatAnimal | |||
| Slices for extension |
Content/Rules for all slices | |||
| extension:species |
1..1 | Extension | Extension | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: STARS Species Value Set (required) | |
| extension:genderStatus |
0..1 | Extension | Extension | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: GenderStatus (required) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..1 | PatAnimal | This patient is known to be an animal (non-human) | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| extension:species |
1..1 | Extension | Extension | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "species" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: STARS Species Value Set (required) | |
| extension:breed |
0..1 | Extension | The animal breed. E.g. Poodle, Angus. | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "breed" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: AnimalBreeds (example): The breed of an animal. | |
| extension:genderStatus |
0..1 | Extension | Extension | |
| id |
0..1 | id | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "genderStatus" | |
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: GenderStatus (required) | |
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-animal" | |
| Documentation for this format | ||||
This structure is derived from PatAnimal
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet | URI |
| Extension.extension:species.value[x] | required | SpeciesValueSet(a valid code from https://ontoacdp.csiro.au/fhir/CodeSystem/stars-species-code-system)https://starsapi.csiro.au/fhir-ig/stars/ValueSet/species-value-setFrom this IG | |
| Extension.extension:breed.value[x] | example | AnimalBreedshttp://hl7.org/fhir/ValueSet/animal-breeds | |
| Extension.extension:genderStatus.value[x] | required | GenderStatushttp://hl7.org/fhir/ValueSet/animal-genderstatus |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| 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() |