STARS Implementation Guide
0.1.0 - ci-build
STARS Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Official URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient | Version: 0.1.0 | |||
Draft as of 2023-04-26 | Computable Name: CsiroStarsPatientProfile |
A patient, primarily animal
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
isHuman | 1..1 | boolean | Is Human URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/is-human | |
animal | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | |
name | ||||
use | 0..0 | |||
text | 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 | |||
address | 0..0 | |||
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
isHuman | 1..1 | boolean | Is Human URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/is-human | |
animal | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | 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. |
Documentation for this format |
Path | Conformance | ValueSet | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
isHuman | 1..1 | boolean | Is Human URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/is-human | |
animal | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | An identifier for this patient |
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 | Σ | 1..1 | string | Text representation of the full name |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | Σ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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 | Σ | 1..1 | Reference(Patient | RelatedPerson) | 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. |
Documentation for this format |
Path | Conformance | ValueSet | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
This structure is derived from Patient
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
isHuman | 1..1 | boolean | Is Human URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/is-human | |
animal | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | |
name | ||||
use | 0..0 | |||
text | 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 | |||
address | 0..0 | |||
maritalStatus | 0..0 | |||
multipleBirth[x] | 0..0 | |||
photo | 0..0 | |||
contact | 0..0 | |||
communication | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
isHuman | 1..1 | boolean | Is Human URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/is-human | |
animal | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | 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. |
Documentation for this format |
Path | Conformance | ValueSet | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
isHuman | 1..1 | boolean | Is Human URL: https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/is-human | |
animal | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/StructureDefinition/patient-animal profiled by https://acdp.csiro.au/starsapi-sandbox/fhir-ig/stars/StructureDefinition/csiro-stars-patient-animal | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | An identifier for this patient |
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 | Σ | 1..1 | string | Text representation of the full name |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | Σ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
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 | Σ | 1..1 | Reference(Patient | RelatedPerson) | 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. |
Documentation for this format |
Path | Conformance | ValueSet | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | preferred | CommonLanguages
| ||||
Patient.link.type | required | LinkType |
This structure is derived from Patient
Other representations of profile: CSV, Excel, Schematron