FHIR General Extensions IG
0.1.0 - Working Copy International flag

This page is part of the FHIR Core Extensions Registry (v0.1.0: Releases Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Extension: Patient Animal

Official URL: http://hl7.org/fhir/StructureDefinition/patient-animal Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: PatAnimal
Other Identifiers: id: urn:oid:2.16.840.1.113883.4.642.5.1343

This patient is known to be an animal.

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionThis patient is known to be an animal (non-human)
... extension:species 1..1ExtensionThe animal species. E.g. Dog, Cow.
.... extension 0..0
.... url 1..1uri"species"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalSpecies (example): The species of an animal.

... extension:breed 0..1ExtensionThe animal breed. E.g. Poodle, Angus.
.... extension 0..0
.... url 1..1uri"breed"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalBreeds (example): The breed of an animal.

... extension:genderStatus 0..1ExtensionThe status of the animal's reproductive parts. E.g. Neutered, Intact.
.... extension 0..0
.... url 1..1uri"genderStatus"
.... value[x] 1..1CodeableConceptValue of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionThis patient is known to be an animal (non-human)
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:species 1..1ExtensionThe animal species. E.g. Dog, Cow.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"species"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalSpecies (example): The species of an animal.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"breed"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalBreeds (example): The breed of an animal.

... extension:genderStatus 0..1ExtensionThe status of the animal's reproductive parts. E.g. Neutered, Intact.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"genderStatus"
.... value[x] 1..1CodeableConceptValue of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements (2 nested mandatory elements)
Fixed Value: 4 elements
Prohibited: 4 elements

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionThis patient is known to be an animal (non-human)
... extension:species 1..1ExtensionThe animal species. E.g. Dog, Cow.
.... extension 0..0
.... url 1..1uri"species"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalSpecies (example): The species of an animal.

... extension:breed 0..1ExtensionThe animal breed. E.g. Poodle, Angus.
.... extension 0..0
.... url 1..1uri"breed"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalBreeds (example): The breed of an animal.

... extension:genderStatus 0..1ExtensionThe status of the animal's reproductive parts. E.g. Neutered, Intact.
.... extension 0..0
.... url 1..1uri"genderStatus"
.... value[x] 1..1CodeableConceptValue of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionThis patient is known to be an animal (non-human)
... id 0..1idUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:species 1..1ExtensionThe animal species. E.g. Dog, Cow.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"species"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalSpecies (example): The species of an animal.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"breed"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AnimalBreeds (example): The breed of an animal.

... extension:genderStatus 0..1ExtensionThe status of the animal's reproductive parts. E.g. Neutered, Intact.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"genderStatus"
.... value[x] 1..1CodeableConceptValue of extension
Binding: GenderStatus (example): The state of the animal's reproductive organs.

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-animal"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:species.value[x]exampleAnimalSpecies
Extension.extension:breed.value[x]exampleAnimalBreeds
Extension.extension:genderStatus.value[x]exampleGenderStatus (a valid code from gender status)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Search Parameters for this Extension

(none found)

;