Onconova Implementation Guide
0.2.0 - ci-build

Onconova Implementation Guide - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Cancer Patient Profile

Official URL: http://onconova.github.io/fhir/StructureDefinition/onconova-cancer-patient Version: 0.2.0
Active as of 2025-10-17 Computable Name: OnconovaCancerPatient

A profile representing a cancer patient with specific extensions and constraints for the Onconova use case.

It constrains the mCODE CancerPatient profile to ensure anonymity of the patient information and to introduce additional Onconova-specific case information. Any Patient resource complying with the US Core Patient or mCODE CancerPatient profiles will also comply with this profile.

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 SC 0..* CancerPatient(4.0.0) Information about an individual or animal receiving health care services
Constraints: o-pat-req-1, o-pat-req-2, o-pat-req-3, o-pat-req-4
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: ext-1
.... extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Constraints: ext-1
.... extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Constraints: ext-1
.... extension:birthsex S 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Constraints: ext-1
.... extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex . (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Constraints: ext-1
.... extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
Constraints: ext-1
.... extension:overallSurvival 0..1 decimal Overall Survival
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-overall-survival
Constraints: ext-1
.... extension:age 0..1 integer Age
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age
Constraints: ext-1
.... extension:ageAtDiagnosis 0..1 integer Age at Diagnosis
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age-at-diagnosis
Constraints: ext-1
.... extension:dataCompletionRate 0..1 decimal Data Completion Rate
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-data-completion-rate
Constraints: ext-1
.... extension:contributors 0..* Reference() Contributors
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-contributors
Constraints: ext-1
.... extension:causeOfDeath 0..1 CodeableConcept Cause of Death
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cause-of-death
Binding: CausesOfDeath (0.2.0) (required)
Constraints: ext-1
.... extension:endOfRecords 0..1 date End of Records
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-end-of-records
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... identifier:All Slices Content/Rules for all slices
..... 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 (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
.... identifier:onconovaIdentifier SΣ 1..* Identifier Onconova Logical Pseudoidentifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: ACSN
....... display 1..1 string Representation defined by the system
Fixed Value: Accession Identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: Onconova
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
.... identifier:clinicalIdentifier SΣ 1..* Identifier Clinical Identifier from Clinical Center
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri Clinical center or institution assigning the identifier
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI) A name associated with the patient
Constraints: us-core-6
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:anonymizedEntry 1..* code Anonymized Entry
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-anonymized-entry
Constraints: ext-1
.... use ?!Σ 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣC 0..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ 0..* ContactPoint Not used in this profile
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date (USCDI) The date of birth for the individual
... deceased[x] ?!SΣ 0..1 dateTime (USCDI) Indicates if the individual is deceased or not
... address SΣ 0..* Address Not used in this profile
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string (USCDI) 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
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
... maritalStatus 0..1 CodeableConcept Not used in this profile
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... photo 0..* Attachment Not used in this profile
... contact C 0..* BackboneElement Not used in this profile
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
... communication 0..* BackboneElement Not used in this profile
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Not used in this profile
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 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().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 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 Patient.implicitRules, Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.identifier, Patient.identifier.use, Patient.identifier.system, Patient.identifier.value, Patient.identifier:onconovaIdentifier, Patient.identifier:onconovaIdentifier.use, Patient.identifier:onconovaIdentifier.type, Patient.identifier:onconovaIdentifier.system, Patient.identifier:onconovaIdentifier.value, Patient.identifier:clinicalIdentifier, Patient.identifier:clinicalIdentifier.use, Patient.identifier:clinicalIdentifier.type, Patient.identifier:clinicalIdentifier.system, Patient.identifier:clinicalIdentifier.value, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.name.use, Patient.name.family, Patient.name.given, Patient.telecom, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.use, Patient.address.line, Patient.address.city, Patient.address.state, Patient.address.postalCode, Patient.maritalStatus, Patient.photo, Patient.contact, Patient.contact.modifierExtension, Patient.communication, Patient.communication.modifierExtension, Patient.communication.language, Patient.generalPractitioner, Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.contact.modifierExtension, Patient.communication.modifierExtension, Patient.link.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-pat-req-1 error Patient The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice. identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()
o-pat-req-2 error Patient The identifier element must contain the identifier for the clinical center's patient identifier slice. identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())
o-pat-req-3 error Patient The gender element is required and must be provided gender.exists() and gender.coding.exists()
o-pat-req-4 error Patient The birthDate element is required and must be provided birthDate.exists() and birthDate.hasValue()
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()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from CancerPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* CancerPatient(4.0.0) Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:overallSurvival 0..1 decimal Overall Survival
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-overall-survival
.... extension:age 0..1 integer Age
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age
.... extension:ageAtDiagnosis 0..1 integer Age at Diagnosis
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age-at-diagnosis
.... extension:dataCompletionRate 0..1 decimal Data Completion Rate
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-data-completion-rate
.... extension:contributors 0..* Reference() Contributors
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-contributors
.... extension:causeOfDeath 0..1 CodeableConcept Cause of Death
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cause-of-death
Binding: CausesOfDeath (0.2.0) (required)
.... extension:endOfRecords 0..1 date End of Records
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-end-of-records
... Slices for identifier 2..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:onconovaIdentifier 1..* Identifier Onconova Logical Pseudoidentifier
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
....... display 1..1 string Representation defined by the system
Fixed Value: Accession Identifier
..... system 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: Onconova
.... identifier:clinicalIdentifier 1..* Identifier Clinical Identifier from Clinical Center
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
..... system 1..1 uri Clinical center or institution assigning the identifier
... name
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:anonymizedEntry 1..* code Anonymized Entry
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-anonymized-entry
... birthDate 1..1 date (USCDI) The date of birth for the individual
... deceased[x] 0..1 dateTime (USCDI) Indicates if the individual is deceased or not
... address 0..* Address Not used in this profile
... maritalStatus 0..1 CodeableConcept Not used in this profile
... photo 0..* Attachment Not used in this profile
... contact 0..* BackboneElement Not used in this profile
... communication 0..* BackboneElement Not used in this profile
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Not used in this profile

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
o-pat-req-1 error Patient The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice. identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()
o-pat-req-2 error Patient The identifier element must contain the identifier for the clinical center's patient identifier slice. identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())
o-pat-req-3 error Patient The gender element is required and must be provided gender.exists() and gender.coding.exists()
o-pat-req-4 error Patient The birthDate element is required and must be provided birthDate.exists() and birthDate.hasValue()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient SC 0..* CancerPatient(4.0.0) Information about an individual or animal receiving health care services
Constraints: o-pat-req-1, o-pat-req-2, o-pat-req-3, o-pat-req-4
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: ext-1
.... extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Constraints: ext-1
.... extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Constraints: ext-1
.... extension:birthsex S 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Constraints: ext-1
.... extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex . (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Constraints: ext-1
.... extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
Constraints: ext-1
.... extension:overallSurvival 0..1 decimal Overall Survival
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-overall-survival
Constraints: ext-1
.... extension:age 0..1 integer Age
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age
Constraints: ext-1
.... extension:ageAtDiagnosis 0..1 integer Age at Diagnosis
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age-at-diagnosis
Constraints: ext-1
.... extension:dataCompletionRate 0..1 decimal Data Completion Rate
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-data-completion-rate
Constraints: ext-1
.... extension:contributors 0..* Reference() Contributors
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-contributors
Constraints: ext-1
.... extension:causeOfDeath 0..1 CodeableConcept Cause of Death
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cause-of-death
Binding: CausesOfDeath (0.2.0) (required)
Constraints: ext-1
.... extension:endOfRecords 0..1 date End of Records
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-end-of-records
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... Slices for identifier SΣ 2..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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 SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:onconovaIdentifier SΣ 1..* Identifier Onconova Logical Pseudoidentifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: ACSN
....... display 1..1 string Representation defined by the system
Fixed Value: Accession Identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: Onconova
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:clinicalIdentifier SΣ 1..* Identifier Clinical Identifier from Clinical Center
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri Clinical center or institution assigning the identifier
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI) A name associated with the patient
Constraints: us-core-6
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:anonymizedEntry 1..* code Anonymized Entry
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-anonymized-entry
Constraints: ext-1
.... use ?!Σ 0..1 code (USCDI) 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 SΣC 0..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI) Time period when name was/is in use
... telecom Σ 0..* ContactPoint Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date (USCDI) The date of birth for the individual
... deceased[x] ?!SΣ 0..1 dateTime (USCDI) Indicates if the individual is deceased or not
... address SΣ 0..* Address Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string (USCDI) 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
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Not used in this profile
Binding: Marital Status Codes (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 Not used in this profile
... contact C 0..* BackboneElement Not used in this profile
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address 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(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 0..* BackboneElement Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Not used in this profile
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 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().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 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 Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.identifier, Patient.identifier.extension, Patient.identifier.use, Patient.identifier.type, Patient.identifier.system, Patient.identifier.value, Patient.identifier.period, Patient.identifier.assigner, Patient.identifier:onconovaIdentifier, Patient.identifier:onconovaIdentifier.extension, Patient.identifier:onconovaIdentifier.use, Patient.identifier:onconovaIdentifier.type, Patient.identifier:onconovaIdentifier.system, Patient.identifier:onconovaIdentifier.value, Patient.identifier:onconovaIdentifier.period, Patient.identifier:onconovaIdentifier.assigner, Patient.identifier:clinicalIdentifier, Patient.identifier:clinicalIdentifier.extension, Patient.identifier:clinicalIdentifier.use, Patient.identifier:clinicalIdentifier.type, Patient.identifier:clinicalIdentifier.system, Patient.identifier:clinicalIdentifier.value, Patient.identifier:clinicalIdentifier.period, Patient.identifier:clinicalIdentifier.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.period, Patient.maritalStatus, Patient.multipleBirth[x], Patient.photo, Patient.contact, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.telecom, Patient.contact.address, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension, Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.identifier.extension, Patient.identifier:onconovaIdentifier.extension, Patient.identifier:clinicalIdentifier.extension, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.telecom.extension, Patient.address.extension, Patient.contact.extension, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-pat-req-1 error Patient The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice. identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()
o-pat-req-2 error Patient The identifier element must contain the identifier for the clinical center's patient identifier slice. identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())
o-pat-req-3 error Patient The gender element is required and must be provided gender.exists() and gender.coding.exists()
o-pat-req-4 error Patient The birthDate element is required and must be provided birthDate.exists() and birthDate.hasValue()
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()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient SC 0..* CancerPatient(4.0.0) Information about an individual or animal receiving health care services
Constraints: o-pat-req-1, o-pat-req-2, o-pat-req-3, o-pat-req-4
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: ext-1
.... extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Constraints: ext-1
.... extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Constraints: ext-1
.... extension:birthsex S 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Constraints: ext-1
.... extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex . (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Constraints: ext-1
.... extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
Constraints: ext-1
.... extension:overallSurvival 0..1 decimal Overall Survival
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-overall-survival
Constraints: ext-1
.... extension:age 0..1 integer Age
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age
Constraints: ext-1
.... extension:ageAtDiagnosis 0..1 integer Age at Diagnosis
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age-at-diagnosis
Constraints: ext-1
.... extension:dataCompletionRate 0..1 decimal Data Completion Rate
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-data-completion-rate
Constraints: ext-1
.... extension:contributors 0..* Reference() Contributors
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-contributors
Constraints: ext-1
.... extension:causeOfDeath 0..1 CodeableConcept Cause of Death
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cause-of-death
Binding: CausesOfDeath (0.2.0) (required)
Constraints: ext-1
.... extension:endOfRecords 0..1 date End of Records
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-end-of-records
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... identifier:All Slices Content/Rules for all slices
..... 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 (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
.... identifier:onconovaIdentifier SΣ 1..* Identifier Onconova Logical Pseudoidentifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: ACSN
....... display 1..1 string Representation defined by the system
Fixed Value: Accession Identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: Onconova
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
.... identifier:clinicalIdentifier SΣ 1..* Identifier Clinical Identifier from Clinical Center
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri Clinical center or institution assigning the identifier
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI) A name associated with the patient
Constraints: us-core-6
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:anonymizedEntry 1..* code Anonymized Entry
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-anonymized-entry
Constraints: ext-1
.... use ?!Σ 0..1 code (USCDI) usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... family SΣC 0..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ 0..* ContactPoint Not used in this profile
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date (USCDI) The date of birth for the individual
... deceased[x] ?!SΣ 0..1 dateTime (USCDI) Indicates if the individual is deceased or not
... address SΣ 0..* Address Not used in this profile
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... line SΣ 0..* string (USCDI) 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
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
... maritalStatus 0..1 CodeableConcept Not used in this profile
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... photo 0..* Attachment Not used in this profile
... contact C 0..* BackboneElement Not used in this profile
Constraints: pat-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
... communication 0..* BackboneElement Not used in this profile
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Not used in this profile
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 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().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 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 Patient.implicitRules, Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.identifier, Patient.identifier.use, Patient.identifier.system, Patient.identifier.value, Patient.identifier:onconovaIdentifier, Patient.identifier:onconovaIdentifier.use, Patient.identifier:onconovaIdentifier.type, Patient.identifier:onconovaIdentifier.system, Patient.identifier:onconovaIdentifier.value, Patient.identifier:clinicalIdentifier, Patient.identifier:clinicalIdentifier.use, Patient.identifier:clinicalIdentifier.type, Patient.identifier:clinicalIdentifier.system, Patient.identifier:clinicalIdentifier.value, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.name.use, Patient.name.family, Patient.name.given, Patient.telecom, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.use, Patient.address.line, Patient.address.city, Patient.address.state, Patient.address.postalCode, Patient.maritalStatus, Patient.photo, Patient.contact, Patient.contact.modifierExtension, Patient.communication, Patient.communication.modifierExtension, Patient.communication.language, Patient.generalPractitioner, Patient.link, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.contact.modifierExtension, Patient.communication.modifierExtension, Patient.link.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-pat-req-1 error Patient The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice. identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()
o-pat-req-2 error Patient The identifier element must contain the identifier for the clinical center's patient identifier slice. identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())
o-pat-req-3 error Patient The gender element is required and must be provided gender.exists() and gender.coding.exists()
o-pat-req-4 error Patient The birthDate element is required and must be provided birthDate.exists() and birthDate.hasValue()
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()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from CancerPatient

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient C 0..* CancerPatient(4.0.0) Information about an individual or animal receiving health care services
... Slices for extension Content/Rules for all slices
.... extension:overallSurvival 0..1 decimal Overall Survival
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-overall-survival
.... extension:age 0..1 integer Age
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age
.... extension:ageAtDiagnosis 0..1 integer Age at Diagnosis
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age-at-diagnosis
.... extension:dataCompletionRate 0..1 decimal Data Completion Rate
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-data-completion-rate
.... extension:contributors 0..* Reference() Contributors
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-contributors
.... extension:causeOfDeath 0..1 CodeableConcept Cause of Death
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cause-of-death
Binding: CausesOfDeath (0.2.0) (required)
.... extension:endOfRecords 0..1 date End of Records
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-end-of-records
... Slices for identifier 2..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:onconovaIdentifier 1..* Identifier Onconova Logical Pseudoidentifier
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ACSN
....... display 1..1 string Representation defined by the system
Fixed Value: Accession Identifier
..... system 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: Onconova
.... identifier:clinicalIdentifier 1..* Identifier Clinical Identifier from Clinical Center
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
..... system 1..1 uri Clinical center or institution assigning the identifier
... name
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... extension:anonymizedEntry 1..* code Anonymized Entry
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-anonymized-entry
... birthDate 1..1 date (USCDI) The date of birth for the individual
... deceased[x] 0..1 dateTime (USCDI) Indicates if the individual is deceased or not
... address 0..* Address Not used in this profile
... maritalStatus 0..1 CodeableConcept Not used in this profile
... photo 0..* Attachment Not used in this profile
... contact 0..* BackboneElement Not used in this profile
... communication 0..* BackboneElement Not used in this profile
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Not used in this profile

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
o-pat-req-1 error Patient The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice. identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()
o-pat-req-2 error Patient The identifier element must contain the identifier for the clinical center's patient identifier slice. identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())
o-pat-req-3 error Patient The gender element is required and must be provided gender.exists() and gender.coding.exists()
o-pat-req-4 error Patient The birthDate element is required and must be provided birthDate.exists() and birthDate.hasValue()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient SC 0..* CancerPatient(4.0.0) Information about an individual or animal receiving health care services
Constraints: o-pat-req-1, o-pat-req-2, o-pat-req-3, o-pat-req-4
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:race 0..1 (Complex) (USCDI) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Constraints: ext-1
.... extension:ethnicity 0..1 (Complex) (USCDI) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Constraints: ext-1
.... extension:tribalAffiliation 0..* (Complex) (USCDI) Tribal Affiliation Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation
Constraints: ext-1
.... extension:birthsex S 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Constraints: ext-1
.... extension:sex 0..1 code (USCDI) Sex Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex
Binding: Sex . (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined.
Constraints: ext-1
.... extension:genderIdentity 0..* CodeableConcept (USCDI) The individual's gender identity
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity . (extensible)
Constraints: ext-1
.... extension:overallSurvival 0..1 decimal Overall Survival
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-overall-survival
Constraints: ext-1
.... extension:age 0..1 integer Age
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age
Constraints: ext-1
.... extension:ageAtDiagnosis 0..1 integer Age at Diagnosis
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-age-at-diagnosis
Constraints: ext-1
.... extension:dataCompletionRate 0..1 decimal Data Completion Rate
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-data-completion-rate
Constraints: ext-1
.... extension:contributors 0..* Reference() Contributors
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-contributors
Constraints: ext-1
.... extension:causeOfDeath 0..1 CodeableConcept Cause of Death
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cause-of-death
Binding: CausesOfDeath (0.2.0) (required)
Constraints: ext-1
.... extension:endOfRecords 0..1 date End of Records
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-end-of-records
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... Slices for identifier SΣ 2..* Identifier (USCDI) An identifier for this patient
Slice: Unordered, Open by pattern:type
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... 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 SΣ 1..1 uri (USCDI) The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:onconovaIdentifier SΣ 1..* Identifier Onconova Logical Pseudoidentifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: ACSN
....... display 1..1 string Representation defined by the system
Fixed Value: Accession Identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri (USCDI) The namespace for the identifier value
Required Pattern: Onconova
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:clinicalIdentifier SΣ 1..* Identifier Clinical Identifier from Clinical Center
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..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: MR
....... display 1..1 string Representation defined by the system
Fixed Value: Medical Record Number
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri Clinical center or institution assigning the identifier
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string (USCDI) The value that is unique within the system.
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name SΣC 1..* HumanName (USCDI) A name associated with the patient
Constraints: us-core-6
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:anonymizedEntry 1..* code Anonymized Entry
URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-anonymized-entry
Constraints: ext-1
.... use ?!Σ 0..1 code (USCDI) 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 SΣC 0..1 string (USCDI) Family name (often called 'Surname')
.... given SΣC 0..* string (USCDI) Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string (USCDI) Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period (USCDI) Time period when name was/is in use
... telecom Σ 0..* ContactPoint Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... system SΣC 1..1 code (USCDI) phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
.... value SΣ 1..1 string (USCDI) The actual contact point details
.... use ?!SΣ 0..1 code (USCDI) home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 1..1 code (USCDI) male | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ 1..1 date (USCDI) The date of birth for the individual
... deceased[x] ?!SΣ 0..1 dateTime (USCDI) Indicates if the individual is deceased or not
... address SΣ 0..* Address Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
.... use ?!Σ 0..1 code (USCDI) home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ 0..* string (USCDI) 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
.... city SΣ 0..1 string (USCDI) Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state SΣ 0..1 string (USCDI) Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two Letter USPS alphabetic codes.
.... postalCode SΣ 0..1 string (USCDI) US Zip Codes
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period (USCDI) Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Not used in this profile
Binding: Marital Status Codes (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 Not used in this profile
... contact C 0..* BackboneElement Not used in this profile
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address 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(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 0..* BackboneElement Not used in this profile
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language S 1..1 CodeableConcept (USCDI) The language which can be used to communicate with the patient about his or her health
Binding: LanguageCodesWithLanguageAndOptionallyARegionModifier (6.1.0) (extensible)
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Not used in this profile
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:onconovaIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:clinicalIdentifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base extensible USPS Two Letter Alphabetic Codes 📍6.1.0 US Core v6.1
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📍6.1.0 US Core v6.1
Patient.link.type Base required LinkType 📍4.0.1 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().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 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 Patient.meta, Patient.implicitRules, Patient.language, Patient.text, Patient.extension, Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.identifier, Patient.identifier.extension, Patient.identifier.use, Patient.identifier.type, Patient.identifier.system, Patient.identifier.value, Patient.identifier.period, Patient.identifier.assigner, Patient.identifier:onconovaIdentifier, Patient.identifier:onconovaIdentifier.extension, Patient.identifier:onconovaIdentifier.use, Patient.identifier:onconovaIdentifier.type, Patient.identifier:onconovaIdentifier.system, Patient.identifier:onconovaIdentifier.value, Patient.identifier:onconovaIdentifier.period, Patient.identifier:onconovaIdentifier.assigner, Patient.identifier:clinicalIdentifier, Patient.identifier:clinicalIdentifier.extension, Patient.identifier:clinicalIdentifier.use, Patient.identifier:clinicalIdentifier.type, Patient.identifier:clinicalIdentifier.system, Patient.identifier:clinicalIdentifier.value, Patient.identifier:clinicalIdentifier.period, Patient.identifier:clinicalIdentifier.assigner, Patient.active, Patient.name, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.name.use, Patient.name.text, Patient.name.family, Patient.name.given, Patient.name.prefix, Patient.name.suffix, Patient.name.period, Patient.telecom, Patient.telecom.extension, Patient.telecom.system, Patient.telecom.value, Patient.telecom.use, Patient.telecom.rank, Patient.telecom.period, Patient.gender, Patient.birthDate, Patient.deceased[x], Patient.address, Patient.address.extension, Patient.address.use, Patient.address.type, Patient.address.text, Patient.address.line, Patient.address.city, Patient.address.district, Patient.address.state, Patient.address.postalCode, Patient.address.country, Patient.address.period, Patient.maritalStatus, Patient.multipleBirth[x], Patient.photo, Patient.contact, Patient.contact.extension, Patient.contact.modifierExtension, Patient.contact.relationship, Patient.contact.name, Patient.contact.telecom, Patient.contact.address, Patient.contact.gender, Patient.contact.organization, Patient.contact.period, Patient.communication, Patient.communication.extension, Patient.communication.modifierExtension, Patient.communication.language, Patient.communication.preferred, Patient.generalPractitioner, Patient.managingOrganization, Patient.link, Patient.link.extension, Patient.link.modifierExtension, Patient.link.other, Patient.link.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Patient.extension, Patient.extension:race, Patient.extension:ethnicity, Patient.extension:tribalAffiliation, Patient.extension:birthsex, Patient.extension:sex, Patient.extension:genderIdentity, Patient.extension:overallSurvival, Patient.extension:age, Patient.extension:ageAtDiagnosis, Patient.extension:dataCompletionRate, Patient.extension:contributors, Patient.extension:causeOfDeath, Patient.extension:endOfRecords, Patient.modifierExtension, Patient.identifier.extension, Patient.identifier:onconovaIdentifier.extension, Patient.identifier:clinicalIdentifier.extension, Patient.name.extension, Patient.name.extension:anonymizedEntry, Patient.telecom.extension, Patient.address.extension, Patient.contact.extension, Patient.contact.modifierExtension, Patient.communication.extension, Patient.communication.modifierExtension, Patient.link.extension, Patient.link.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
o-pat-req-1 error Patient The identifier element must contain the identifier for the Onconova logical pseudoidentifier slice. identifier.where(type.coding.code = 'ACSN' and system = 'Onconova').exists()
o-pat-req-2 error Patient The identifier element must contain the identifier for the clinical center's patient identifier slice. identifier.where(type.coding.code = 'MR').exists(system.exists() and value.exists())
o-pat-req-3 error Patient The gender element is required and must be provided gender.exists() and gender.coding.exists()
o-pat-req-4 error Patient The birthDate element is required and must be provided birthDate.exists() and birthDate.hasValue()
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()
us-core-6 error Patient.name At least name.given and/or name.family are present or, if neither is available, the Data Absent Reason Extension is present. (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

 

Other representations of profile: CSV, Excel, Schematron