Care Coordination Management
0.0.1 - ci-build Estonia (EST)

Care Coordination Management, published by Helex OÜ. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/helexlab/ig-ccm/ and changes regularly. See the Directory of published versions

Resource Profile: PatientCcm

Official URL: http://helex.org/ig/ccm/StructureDefinition/patient-ccm Version: 0.0.1
Draft as of 2025-12-05 Computable Name: PatientCcm

A localized profile of Patient for use in CCM.

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..* EEBasePatient 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
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Patient Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string Patient identification code or document number.
Example General: 123456
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Patient name
Slice: Unordered, Open by value:use
.... name:official SΣ 1..1 HumanName Ametlik nimi
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Perekonnanimi
..... given SΣ 1..1 string Eesnimi
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..1 string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... period SΣ 0..1 Period Time period when name was/is in use
.... name:nickname SΣ 0..1 HumanName Tundmatu või anonüümse patsiendi nimi
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: nickname
..... text SΣ 1..1 string Tundmatu patsiendi hüüdnimi
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣC 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: Administrative Gender (required)
... birthDate SΣ 0..1 date The date of birth for the individual
.... Slices for extension Content/Rules for all slices
..... extension:birthTime S 0..1 (Complex) Sünniaeg
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] S 1..1 dateTime Value of extension
..... extension:age 0..1 Age Vanus
URL: https://fhir.ee/base/StructureDefinition/ee-patient-age
..... extension:accuracyIndicator 0..1 Coding Kuupäeva täpsuse indikaator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceased[x]All Types Content/Rules for all Types
..... Slices for extension Content/Rules for all slices
...... extension:accuracyIndicator 0..1 Coding Date accuracy indicator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* EEBaseAddress An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:adsAdrId S 0..1 Coding ADS AdrId
URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id
Binding: ADS AdrId (required)
..... extension:adsOid S 0..1 Coding ADS Oid
URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid
Binding: ADS Oid (required)
..... extension:ehak S 0..1 Coding EHAK code
URL: https://fhir.ee/base/StructureDefinition/ee-ehak
..... extension:official S 0..1 boolean Indicator of address of residency
URL: http://hl7.org/fhir/StructureDefinition/address-official
..... extension:notice S 0..* Coding Address notices and warnings
URL: https://fhir.ee/base/StructureDefinition/ee-address-notice
.... use ?!SΣ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... Slices for extension Content/Rules for all slices
...... extension:censusTract 0..1 string A geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
...... extension:streetName 0..1 string Street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:streetNameBase 0..1 string The base name of a roadway or artery recognized by a municipality (excluding street type and direction).
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
...... extension:houseNumber 0..1 string House number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:additionalLocator 0..1 string Additional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... country SΣ 1..1 string Should use a 2 digit ISO 3166 code
Binding: Iso316612 (required)
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... generalPractitioner S 0..* Reference(EEBase Practitioner | EEBase PractitionerRole) Patient's nominated primary care provider
... link ?!SΣ 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(EEBase Patient | EEBase 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.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.system Base required Patient Identifier Domain 📦1.0.0 Estonian Terminology resources v1.0
Patient.name:official.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.name:nickname.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Patient.gender Base required Administrative Gender 📦1.0.0 Estonian Terminology resources v1.0
Patient.address.use Base required AddressUse 📍5.0.0 FHIR Std.
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦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 EEBasePatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* EEBasePatient Information about an individual or animal receiving health care services
... name 1..* HumanName Patient name
... Slices for name Content/Rules for all slices
.... name:official 1..1 HumanName Ametlik nimi
... address
.... line S 1..1 string Street name, number, direction & P.O. Box etc.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* EEBasePatient 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Patient Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string Patient identification code or document number.
Example General: 123456
.... period Σ 0..1 Period Validity period of the identifier of identification document.
.... assigner Σ 0..1 Reference(Organization) Organization that issued the document. Can be used as a reference to an organization or as free text.
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Patient name
Slice: Unordered, Open by value:use
.... name:official SΣ 1..1 HumanName Ametlik nimi
..... 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 ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Perekonnanimi
..... given SΣ 1..1 string Eesnimi
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..1 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 SΣ 0..1 Period Time period when name was/is in use
.... name:nickname SΣ 0..1 HumanName Tundmatu või anonüümse patsiendi nimi
..... 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 ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: nickname
..... text SΣ 1..1 string Tundmatu patsiendi hüüdnimi
..... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣC 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: Administrative Gender (required)
... birthDate SΣ 0..1 date The date of birth for the individual
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime S 0..1 (Complex) Sünniaeg
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] S 1..1 dateTime Value of extension
..... extension:age 0..1 Age Vanus
URL: https://fhir.ee/base/StructureDefinition/ee-patient-age
..... extension:accuracyIndicator 0..1 Coding Kuupäeva täpsuse indikaator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
.... value 0..1 date Primitive value for date
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceased[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:accuracyIndicator 0..1 Coding Date accuracy indicator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* EEBaseAddress An address for the individual
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:adsAdrId S 0..1 Coding ADS AdrId
URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id
Binding: ADS AdrId (required)
..... extension:adsOid S 0..1 Coding ADS Oid
URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid
Binding: ADS Oid (required)
..... extension:ehak S 0..1 Coding EHAK code
URL: https://fhir.ee/base/StructureDefinition/ee-ehak
..... extension:official S 0..1 boolean Indicator of address of residency
URL: http://hl7.org/fhir/StructureDefinition/address-official
..... extension:notice S 0..* Coding Address notices and warnings
URL: https://fhir.ee/base/StructureDefinition/ee-address-notice
.... use ?!SΣ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:censusTract 0..1 string A geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
...... extension:streetName 0..1 string Street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:streetNameBase 0..1 string The base name of a roadway or artery recognized by a municipality (excluding street type and direction).
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
...... extension:houseNumber 0..1 string House number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:additionalLocator 0..1 string Additional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string Administrative or political subdivision of a state or city
Example General: Madison
.... state Σ 0..1 string Sub-unit of country
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 1..1 string Should use a 2 digit ISO 3166 code
Binding: Iso316612 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
... 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 The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name C 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
.... address C 0..1 EEBaseAddress Address for the contact person
.... 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(EEBase 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
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... 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
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(EEBase Practitioner | EEBase PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(EEBase Organization) Organization that is the custodian of the patient record
... link ?!SΣ 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(EEBase Patient | EEBase 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.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.type Base extensible Identifier Type Codes 📦5.0.0 FHIR Std.
Patient.identifier.system Base required Patient Identifier Domain 📦1.0.0 Estonian Terminology resources v1.0
Patient.name:official.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.name:nickname.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Patient.gender Base required Administrative Gender 📦1.0.0 Estonian Terminology resources v1.0
Patient.address.use Base required AddressUse 📍5.0.0 FHIR Std.
Patient.address.type Base required AddressType 📍5.0.0 FHIR Std.
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦5.0.0 FHIR Std.
Patient.maritalStatus Base extensible Marital Status Codes 📦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 EEBasePatient

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* EEBasePatient 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
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Patient Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string Patient identification code or document number.
Example General: 123456
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Patient name
Slice: Unordered, Open by value:use
.... name:official SΣ 1..1 HumanName Ametlik nimi
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Perekonnanimi
..... given SΣ 1..1 string Eesnimi
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..1 string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... period SΣ 0..1 Period Time period when name was/is in use
.... name:nickname SΣ 0..1 HumanName Tundmatu või anonüümse patsiendi nimi
..... use ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: nickname
..... text SΣ 1..1 string Tundmatu patsiendi hüüdnimi
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣC 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: Administrative Gender (required)
... birthDate SΣ 0..1 date The date of birth for the individual
.... Slices for extension Content/Rules for all slices
..... extension:birthTime S 0..1 (Complex) Sünniaeg
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] S 1..1 dateTime Value of extension
..... extension:age 0..1 Age Vanus
URL: https://fhir.ee/base/StructureDefinition/ee-patient-age
..... extension:accuracyIndicator 0..1 Coding Kuupäeva täpsuse indikaator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceased[x]All Types Content/Rules for all Types
..... Slices for extension Content/Rules for all slices
...... extension:accuracyIndicator 0..1 Coding Date accuracy indicator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* EEBaseAddress An address for the individual
.... Slices for extension Content/Rules for all slices
..... extension:adsAdrId S 0..1 Coding ADS AdrId
URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id
Binding: ADS AdrId (required)
..... extension:adsOid S 0..1 Coding ADS Oid
URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid
Binding: ADS Oid (required)
..... extension:ehak S 0..1 Coding EHAK code
URL: https://fhir.ee/base/StructureDefinition/ee-ehak
..... extension:official S 0..1 boolean Indicator of address of residency
URL: http://hl7.org/fhir/StructureDefinition/address-official
..... extension:notice S 0..* Coding Address notices and warnings
URL: https://fhir.ee/base/StructureDefinition/ee-address-notice
.... use ?!SΣ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... Slices for extension Content/Rules for all slices
...... extension:censusTract 0..1 string A geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
...... extension:streetName 0..1 string Street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:streetNameBase 0..1 string The base name of a roadway or artery recognized by a municipality (excluding street type and direction).
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
...... extension:houseNumber 0..1 string House number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:additionalLocator 0..1 string Additional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
.... country SΣ 1..1 string Should use a 2 digit ISO 3166 code
Binding: Iso316612 (required)
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... generalPractitioner S 0..* Reference(EEBase Practitioner | EEBase PractitionerRole) Patient's nominated primary care provider
... link ?!SΣ 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(EEBase Patient | EEBase 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.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.system Base required Patient Identifier Domain 📦1.0.0 Estonian Terminology resources v1.0
Patient.name:official.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.name:nickname.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Patient.gender Base required Administrative Gender 📦1.0.0 Estonian Terminology resources v1.0
Patient.address.use Base required AddressUse 📍5.0.0 FHIR Std.
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦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 EEBasePatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* EEBasePatient Information about an individual or animal receiving health care services
... name 1..* HumanName Patient name
... Slices for name Content/Rules for all slices
.... name:official 1..1 HumanName Ametlik nimi
... address
.... line S 1..1 string Street name, number, direction & P.O. Box etc.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* EEBasePatient 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Patient Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string Patient identification code or document number.
Example General: 123456
.... period Σ 0..1 Period Validity period of the identifier of identification document.
.... assigner Σ 0..1 Reference(Organization) Organization that issued the document. Can be used as a reference to an organization or as free text.
... active ?!SΣ 1..1 boolean Whether this patient's record is in active use
... Slices for name SΣ 1..* HumanName Patient name
Slice: Unordered, Open by value:use
.... name:official SΣ 1..1 HumanName Ametlik nimi
..... 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 ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official
..... text SΣ 0..1 string Text representation of the full name
..... family SΣ 1..1 string Perekonnanimi
..... given SΣ 1..1 string Eesnimi
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix SΣ 0..1 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 SΣ 0..1 Period Time period when name was/is in use
.... name:nickname SΣ 0..1 HumanName Tundmatu või anonüümse patsiendi nimi
..... 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 ?!SΣ 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: nickname
..... text SΣ 1..1 string Tundmatu patsiendi hüüdnimi
..... period Σ 0..1 Period Time period when name was/is in use
... telecom SΣ 0..* ContactPoint A contact detail for the individual
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣC 1..1 string The actual contact point details
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period SΣ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code male | female | other | unknown
Binding: Administrative Gender (required)
... birthDate SΣ 0..1 date The date of birth for the individual
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:birthTime S 0..1 (Complex) Sünniaeg
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] S 1..1 dateTime Value of extension
..... extension:age 0..1 Age Vanus
URL: https://fhir.ee/base/StructureDefinition/ee-patient-age
..... extension:accuracyIndicator 0..1 Coding Kuupäeva täpsuse indikaator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
.... value 0..1 date Primitive value for date
... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
.... deceased[x]All Types Content/Rules for all Types
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... extension:accuracyIndicator 0..1 Coding Date accuracy indicator
URL: https://fhir.ee/base/StructureDefinition/ee-date-accuracy-indicator
Binding: Date Accuracy Indicator (required): Date accuracy coding
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* EEBaseAddress An address for the individual
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:adsAdrId S 0..1 Coding ADS AdrId
URL: https://fhir.ee/base/StructureDefinition/ee-ads-adr-id
Binding: ADS AdrId (required)
..... extension:adsOid S 0..1 Coding ADS Oid
URL: https://fhir.ee/base/StructureDefinition/ee-ads-oid
Binding: ADS Oid (required)
..... extension:ehak S 0..1 Coding EHAK code
URL: https://fhir.ee/base/StructureDefinition/ee-ehak
..... extension:official S 0..1 boolean Indicator of address of residency
URL: http://hl7.org/fhir/StructureDefinition/address-official
..... extension:notice S 0..* Coding Address notices and warnings
URL: https://fhir.ee/base/StructureDefinition/ee-address-notice
.... use ?!SΣ 1..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text SΣ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 1..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:censusTract 0..1 string A geographic sub-unit delineated for demographic purposes.
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
...... extension:streetName 0..1 string Street name
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName
...... extension:streetNameBase 0..1 string The base name of a roadway or artery recognized by a municipality (excluding street type and direction).
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase
...... extension:houseNumber 0..1 string House number
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
...... extension:additionalLocator 0..1 string Additional locator
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
..... value 0..1 string Primitive value for string
Max Length:1048576
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string Administrative or political subdivision of a state or city
Example General: Madison
.... state Σ 0..1 string Sub-unit of country
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country SΣ 1..1 string Should use a 2 digit ISO 3166 code
Binding: Iso316612 (required)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: MaritalStatusCodes (extensible): The domestic partnership status of a person.
... 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 The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name C 0..1 HumanName A name associated with the contact person
.... telecom C 0..* ContactPoint A contact detail for the person
.... address C 0..1 EEBaseAddress Address for the contact person
.... 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(EEBase 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
... communication S 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... 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
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner S 0..* Reference(EEBase Practitioner | EEBase PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(EEBase Organization) Organization that is the custodian of the patient record
... link ?!SΣ 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(EEBase Patient | EEBase 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.identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Patient.identifier.type Base extensible Identifier Type Codes 📦5.0.0 FHIR Std.
Patient.identifier.system Base required Patient Identifier Domain 📦1.0.0 Estonian Terminology resources v1.0
Patient.name:official.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.name:nickname.​use Base required NameUse 📍5.0.0 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍5.0.0 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍5.0.0 FHIR Std.
Patient.gender Base required Administrative Gender 📦1.0.0 Estonian Terminology resources v1.0
Patient.address.use Base required AddressUse 📍5.0.0 FHIR Std.
Patient.address.type Base required AddressType 📍5.0.0 FHIR Std.
Patient.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦5.0.0 FHIR Std.
Patient.maritalStatus Base extensible Marital Status Codes 📦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 EEBasePatient

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron