HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build Czechia flag

HL7 Czech Imaging Report IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/img/ and changes regularly. See the Directory of published versions

Resource Profile: Related Person: Obligations

Official URL: https://hl7.cz/fhir/img/StructureDefinition/cz-relatedPerson-obl-img Version: 0.1.0-ballot
Standards status: Informative Maturity Level: 0 Computable Name: CZ_RelatedPersonObligationsImg

This profile defines obligations for a related person in FHIR for the purpose of this guide.

Usages:

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

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
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier OΣ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
ObligationsActor
SHALL:populate-if-known Creator-L2
SHALL:display Consumer-L2
SHALL:populate-if-known Creator-L3
SHALL:display Consumer-L3
.... identifier:RC Σ 0..1 CZ_Rodcis_Identifier Personal Number
.... identifier:CPOJ Σ 0..1 Identifier Health Insurance Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://ncez.mzcr.cz/fhir/sid/cpoj
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:PAS Σ 0..* Identifier Passport Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value Σ 1..1 string The value that is unique
Example General: 123456
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... relationship OΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... name ΣC 0..1 HumanName A name associated with the person
Constraints: cz-relPer-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family OΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... given OΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... telecom OΣ 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... address OΣ 0..* CZ_Address Address where the related person can be contacted or visited
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 CZ_RelatedPersonCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson
... identifier O 0..* Identifier A human identifier for this person
ObligationsActor
SHALL:populate-if-known Creator-L2
SHALL:display Consumer-L2
SHALL:populate-if-known Creator-L3
SHALL:display Consumer-L3
... relationship O 0..* CodeableConcept The nature of the relationship
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... name
.... family O 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... given O 1..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... address O 0..* CZ_Address Address where the related person can be contacted or visited
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson
... 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
... Slices for identifier OΣ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
ObligationsActor
SHALL:populate-if-known Creator-L2
SHALL:display Consumer-L2
SHALL:populate-if-known Creator-L3
SHALL:display Consumer-L3
.... identifier:RC Σ 0..1 CZ_Rodcis_Identifier Personal Number
.... identifier:CPOJ Σ 0..1 Identifier Health Insurance Number
..... id 0..1 string 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://ncez.mzcr.cz/fhir/sid/cpoj
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization (CZ core)) Organization that issued id (may be just text)
.... identifier:PAS Σ 0..* Identifier Passport Number
..... id 0..1 string 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 .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri Name space according to the passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166
Binding: Standard namespaces for passports (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization (CZ core)) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... relationship OΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... name ΣC 0..1 HumanName A name associated with the person
Constraints: cz-relPer-1
.... id 0..1 string 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 OΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... given OΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... 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
... telecom OΣ 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... gender Σ 0..1 code male | female | other | unknown
Binding: Gender for administrative purposes (required)
... birthDate Σ 0..1 date The date on which the related person was born
... address OΣ 0..* CZ_Address Address where the related person can be contacted or visited
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's 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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:CPOJ.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​system Base required Standard namespaces for passports 📦0.1.0 HL7 Czech Terminology Implementation Guide vnull
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required Gender for administrative purposes 📦0.1.0 HL7 Czech Terminology Implementation Guide vnull
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 CZ_RelatedPersonCore

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier OΣ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
ObligationsActor
SHALL:populate-if-known Creator-L2
SHALL:display Consumer-L2
SHALL:populate-if-known Creator-L3
SHALL:display Consumer-L3
.... identifier:RC Σ 0..1 CZ_Rodcis_Identifier Personal Number
.... identifier:CPOJ Σ 0..1 Identifier Health Insurance Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://ncez.mzcr.cz/fhir/sid/cpoj
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:PAS Σ 0..* Identifier Passport Number
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value Σ 1..1 string The value that is unique
Example General: 123456
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... relationship OΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... name ΣC 0..1 HumanName A name associated with the person
Constraints: cz-relPer-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family OΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... given OΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... telecom OΣ 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... address OΣ 0..* CZ_Address Address where the related person can be contacted or visited
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 CZ_RelatedPersonCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson
... identifier O 0..* Identifier A human identifier for this person
ObligationsActor
SHALL:populate-if-known Creator-L2
SHALL:display Consumer-L2
SHALL:populate-if-known Creator-L3
SHALL:display Consumer-L3
... relationship O 0..* CodeableConcept The nature of the relationship
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... name
.... family O 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... given O 1..* string Given names (not always 'first'). Includes middle names
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... address O 0..* CZ_Address Address where the related person can be contacted or visited
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* CZ_RelatedPersonCore Czech Related person (core profile)
This profile also imposes the profile RelatedPerson
... 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
... Slices for identifier OΣ 0..* Identifier A human identifier for this person
Slice: Unordered, Open by value:system
ObligationsActor
SHALL:populate-if-known Creator-L2
SHALL:display Consumer-L2
SHALL:populate-if-known Creator-L3
SHALL:display Consumer-L3
.... identifier:RC Σ 0..1 CZ_Rodcis_Identifier Personal Number
.... identifier:CPOJ Σ 0..1 Identifier Health Insurance Number
..... id 0..1 string 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://ncez.mzcr.cz/fhir/sid/cpoj
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization (CZ core)) Organization that issued id (may be just text)
.... identifier:PAS Σ 0..* Identifier Passport Number
..... id 0..1 string 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 .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPN
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri Name space according to the passport issuer. FHIR records namespaces for passports in the format - http://hl7.org/fhir/sid/passport-XXX, where XXX is the three-letter country code according to ISO 3166
Binding: Standard namespaces for passports (required)
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization (CZ core)) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient (CZ core)) The patient this person is related to
... relationship OΣ 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... name ΣC 0..1 HumanName A name associated with the person
Constraints: cz-relPer-1
.... id 0..1 string 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 OΣ 0..1 string Family name (often called 'Surname')
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... given OΣ 1..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
.... 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
... telecom OΣ 0..* ContactPoint A contact detail for the person
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... gender Σ 0..1 code male | female | other | unknown
Binding: Gender for administrative purposes (required)
... birthDate Σ 0..1 date The date on which the related person was born
... address OΣ 0..* CZ_Address Address where the related person can be contacted or visited
ObligationsActor
SHALL:able-to-populate Creator-L2
SHALL:display Consumer-L2
SHALL:able-to-populate Creator-L3
SHALL:display Consumer-L3
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's 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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
RelatedPerson.identifier:CPOJ.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:CPOJ.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
RelatedPerson.identifier:PAS.​system Base required Standard namespaces for passports 📦0.1.0 HL7 Czech Terminology Implementation Guide vnull
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍4.0.1 FHIR Std.
RelatedPerson.gender Base required Gender for administrative purposes 📦0.1.0 HL7 Czech Terminology Implementation Guide vnull
RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cz-relPer-1 error RelatedPerson.name RelatedPerson.name.given, RelatedPerson.name.family, RelatedPerson.name.text or data-absent-reason MUST be filled family.exists() or given.exists() or text.exists() or extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson 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 CZ_RelatedPersonCore

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron