HL7 Europe Base and Core FHIR IG
0.1.0-ci-build - ci-build 150

HL7 Europe Base and Core FHIR IG, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base-r5/ and changes regularly. See the Directory of published versions

Resource Profile: Patient: Animal (EU core)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/patient-animal-eu-core Version: 0.1.0-ci-build
Standards status: Draft Maturity Level: 2 Computable Name: PatientAnimalEuCore

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile defines how to represent an Animal as subject of care in FHIR for the purpose of this guide. This is used to identify the species when a specimen is collected from an 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..* PatientEu Information about an 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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:species 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "species"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Types of species (example)
...... extension:breed 0..1 Extension The animal breed. E.g. Poodle, Angus.
....... 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 The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... extension 0..0
....... url 1..1 uri "genderStatus"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... identifier Σ 0..* Identifier Animal identifier
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... deceased[x] ?!Σ 0..1 Deceased status
.... 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 Σ 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, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:patient-animal.​extension:species.value[x] Base example Types of species 📦0.1.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
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 PatientEu

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientEu Information about an animal receiving health care services
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... Slices for extension Content/Rules for all slices
...... extension:species 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Types of species (example)
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... identifier 0..* Identifier Animal identifier
... deceased[x] 0..1 boolean, dateTime Deceased status
... maritalStatus 0..0
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:patient-animal.​extension:species.value[x] Base example Types of species 📦0.1.0-ci-build This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientEu Information about an 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... 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: Types of species (example)
...... 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 The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... 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 (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Animal identifier
... 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
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name.
.... family Σ 0..1 string Family name.
Example spanish: Valero Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... gender Σ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the patient
... deceased[x] ?!Σ 0..1 Deceased status
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* AddressEu An address for the individual
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... 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
.... relationship 0..* CodeableConcept Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name C 0..1 HumanName Contact name
.... telecom C 0..* ContactPoint Contact details for the person
.... address C 0..1 AddressEu Contact person address
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... 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 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 Σ 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, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base required All Languages 📍5.0.0 FHIR Std.
Patient.extension:patient-animal.​extension:species.value[x] Base example Types of species 📦0.1.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
Patient.name.use Base required NameUse 📍5.0.0 FHIR Std.
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()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientEu

Summary

Mandatory: 2 elements
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientEu Information about an 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:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... Slices for extension 1..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:species 1..1 Extension Extension
....... extension 0..0
....... url 1..1 uri "species"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Types of species (example)
...... extension:breed 0..1 Extension The animal breed. E.g. Poodle, Angus.
....... 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 The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... extension 0..0
....... url 1..1 uri "genderStatus"
....... value[x] 1..1 CodeableConcept Value of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... identifier Σ 0..* Identifier Animal identifier
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... deceased[x] ?!Σ 0..1 Deceased status
.... 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 Σ 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, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:patient-animal.​extension:species.value[x] Base example Types of species 📦0.1.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
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 PatientEu

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientEu Information about an animal receiving health care services
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... Slices for extension Content/Rules for all slices
...... extension:species 1..1 Extension Extension
....... value[x] 1..1 CodeableConcept Value of extension
Binding: Types of species (example)
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... identifier 0..* Identifier Animal identifier
... deceased[x] 0..1 boolean, dateTime Deceased status
... maritalStatus 0..0
... communication 0..0

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:patient-animal.​extension:species.value[x] Base example Types of species 📦0.1.0-ci-build This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* PatientEu Information about an 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 AddressEu Value of extension
.... extension:sex-for-clinical-use 0..* (Complex) Sex for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
.... extension:gender-identity 0..* (Complex) Gender identity
URL: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity
.... extension:pronouns 0..* (Complex) Pronouns
URL: http://hl7.org/fhir/StructureDefinition/individual-pronouns
.... extension:patient-citizenship 0..* (Complex) Citizenship
URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship
.... extension:patient-nationality 0..* (Complex) Nationality
URL: http://hl7.org/fhir/StructureDefinition/patient-nationality
.... extension:birthTime 0..1 dateTime Birth time
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
.... extension:patient-animal 1..1 (Complex) This patient is known to be an animal (non-human)
URL: http://hl7.org/fhir/StructureDefinition/patient-animal
..... 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: Types of species (example)
...... 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 The status of the animal's reproductive parts. E.g. Neutered, Intact.
....... 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 (example): The state of the animal's reproductive organs.
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-animal"
.... extension:recordedSexOrGender 0..1 (Complex) A recorded sex or gender property for the individual
URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Animal identifier
... 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
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name.
.... family Σ 0..1 string Family name.
Example spanish: Valero Iglesias
.... given Σ 0..* string Given names. Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... gender Σ 0..1 code Administrative Gender
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the patient
... deceased[x] ?!Σ 0..1 Deceased status
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* AddressEu An address for the individual
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... 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
.... relationship 0..* CodeableConcept Contact relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name C 0..1 HumanName Contact name
.... telecom C 0..* ContactPoint Contact details for the person
.... address C 0..1 AddressEu Contact person address
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... 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 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 Σ 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, or Patient/RelatedPerson when using the seealso code

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base required All Languages 📍5.0.0 FHIR Std.
Patient.extension:patient-animal.​extension:species.value[x] Base example Types of species 📦0.1.0-ci-build This IG
Patient.extension:patient-animal.​extension:breed.value[x] Base example animal breeds 📦5.2.0 FHIR Extensions Pack v5.2
Patient.extension:patient-animal.​extension:genderStatus.​value[x] Base example gender status value set 📦5.2.0 FHIR Extensions Pack v5.2
Patient.name.use Base required NameUse 📍5.0.0 FHIR Std.
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()
pat-1 error Patient.contact SHALL at least contain a contact's details or a reference to an organization name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from PatientEu

Summary

Mandatory: 2 elements
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron