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
| Official URL: http://onconova.github.io/fhir/StructureDefinition/onconova-cancer-patient | Version: 0.2.0 | |||
| Active as of 2026-03-18 | Computable Name: OnconovaCancerPatient | |||
A profile representing a patient with or is receiving medical treatment for a malignant growth or tumor.
It constrains the mCODE CancerPatient profile with specific extensions and constraints for the Onconova use case. Any Patient resource complying with the US Core Patient or mCODE CancerPatient profiles will also comply with this profile if the Must-Support extensions are accounted for.
Conformance:
Patient resources representing Cancer Patients in the scope of Onconova SHALL conform to this profile. Any resource intended to conform to this profile SHOULD populate meta.profile accordingly.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
SC | 0..* | CancerPatient | 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, o-pat-req-5, o-pat-req-6, o-pat-req-7 | ||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
O | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
| ||||||
![]() ![]() ![]() |
0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||||
![]() ![]() ![]() |
0..* | (Complex) | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |||||||
![]() ![]() ![]() |
SO | 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
| ||||||
![]() ![]() ![]() |
0..1 | code | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined. | |||||||
![]() ![]() ![]() |
O | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | Cancer Patient Consent status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-consent-status Binding: Consent Status Value Set (required)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | string | Cancer Patient Clinical Center URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-clinical-center
| ||||||
![]() ![]() ![]() |
O | 0..1 | Duration | Cancer Patient Overall Survival URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-overall-survival
| ||||||
![]() ![]() ![]() |
O | 0..1 | decimal | Cancer Patient Data Completion Rate URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-completion-rate
| ||||||
![]() ![]() ![]() |
O | 0..* | Reference() | Cancer Patient Data Contributors URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-contributors
| ||||||
![]() ![]() ![]() |
SO | 0..1 | date | Cancer Patient End of Records URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records
| ||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() |
SΣ | 2..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Onconova Logical Pseudoidentifier
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Accession Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: Onconova | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Clinical Identifier from Clinical Center
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Medical Record Number | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() |
SΣC | 1..* | HumanName | Not used in this profile Constraints: us-core-6 | ||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: DataAbsentReason (required) Required Pattern: masked | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | Not used in this profile | ||||||
![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||||
![]() ![]() |
SOΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
| ||||||
![]() ![]() |
SOΣ | 1..1 | date | Date of birth of the patient normalized to the first day of the month
| ||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age at Diagnosis URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age-at-diagnosis
| ||||||
![]() ![]() |
?!SOΣ | 1..1 | dateTime | Date of death of the patient, if applicable
| ||||||
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Vital status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status Binding: Vital Status Value Set (required)
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Cause of Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death Binding: Cause of Death Value Set (required)
| ||||||
![]() ![]() |
SΣ | 0..* | Address | Not used in this profile | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | ||||||
![]() ![]() |
0..1 | CodeableConcept | Not used in this profile Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() |
0..* | Attachment | Not used in this profile | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Not used in this profile Constraints: pat-1 | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() |
0..* | BackboneElement | Not used in this profile | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Not used in this profile | |||||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
Documentation for this format | ||||||||||
| 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.extension:anonymizedEntry.value[x] | Base | required | DataAbsentReason | 📦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. |
| 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 | **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()
|
| 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()
|
| o-pat-req-4 | error | Patient | The birthDate element is required and must be provided |
birthDate.exists() and birthDate.hasValue()
|
| o-pat-req-5 | error | Patient | The vital status extension is required and must be provided. |
deceased.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.exists()
|
| o-pat-req-6 | error | Patient | If the patient is deceased, the date of death and cause of death must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())
|
| o-pat-req-7 | error | Patient | If the patient vital status is unknown, the end of records must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.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
| 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()
|
| o-pat-req-4 | error | Patient | The birthDate element is required and must be provided |
birthDate.exists() and birthDate.hasValue()
|
| o-pat-req-5 | error | Patient | The vital status extension is required and must be provided. |
deceased.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.exists()
|
| o-pat-req-6 | error | Patient | If the patient is deceased, the date of death and cause of death must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())
|
| o-pat-req-7 | error | Patient | If the patient vital status is unknown, the end of records must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.hasValue()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
SC | 0..* | CancerPatient | 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, o-pat-req-5, o-pat-req-6, o-pat-req-7 | ||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
O | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
| ||||||
![]() ![]() ![]() |
0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||||
![]() ![]() ![]() |
0..* | (Complex) | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |||||||
![]() ![]() ![]() |
SO | 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
| ||||||
![]() ![]() ![]() |
0..1 | code | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined. | |||||||
![]() ![]() ![]() |
O | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | Cancer Patient Consent status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-consent-status Binding: Consent Status Value Set (required)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | string | Cancer Patient Clinical Center URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-clinical-center
| ||||||
![]() ![]() ![]() |
O | 0..1 | Duration | Cancer Patient Overall Survival URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-overall-survival
| ||||||
![]() ![]() ![]() |
O | 0..1 | decimal | Cancer Patient Data Completion Rate URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-completion-rate
| ||||||
![]() ![]() ![]() |
O | 0..* | Reference() | Cancer Patient Data Contributors URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-contributors
| ||||||
![]() ![]() ![]() |
SO | 0..1 | date | Cancer Patient End of Records URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records
| ||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() |
SΣ | 2..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Onconova Logical Pseudoidentifier
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Accession Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: Onconova | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Clinical Identifier from Clinical Center
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Medical Record Number | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() |
SΣC | 1..* | HumanName | Not used in this profile Constraints: us-core-6 | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: DataAbsentReason (required) Required Pattern: masked | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() |
Σ | 0..* | string | (USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when name was/is in use | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | Not used in this profile | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() |
SOΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
| ||||||
![]() ![]() |
SOΣ | 1..1 | date | Date of birth of the patient normalized to the first day of the month
| ||||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age at Diagnosis URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age-at-diagnosis
| ||||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||||
![]() ![]() |
?!SOΣ | 1..1 | dateTime | Date of death of the patient, if applicable
| ||||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Vital status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status Binding: Vital Status Value Set (required)
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Cause of Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death Binding: Cause of Death Value Set (required)
| ||||||
![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||||
![]() ![]() |
SΣ | 0..* | Address | Not used in this profile | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||||
![]() ![]() |
0..1 | CodeableConcept | Not used in this profile Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||||
![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() |
integer | |||||||||
![]() ![]() |
0..* | Attachment | Not used in this profile | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Not used in this profile Constraints: pat-1 | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||||
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||||
![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
![]() ![]() |
0..* | BackboneElement | Not used in this profile | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Not used in this profile | |||||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
Documentation for this format | ||||||||||
| 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.extension:anonymizedEntry.value[x] | Base | required | DataAbsentReason | 📦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. |
| 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 | **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()
|
| 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()
|
| o-pat-req-4 | error | Patient | The birthDate element is required and must be provided |
birthDate.exists() and birthDate.hasValue()
|
| o-pat-req-5 | error | Patient | The vital status extension is required and must be provided. |
deceased.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.exists()
|
| o-pat-req-6 | error | Patient | If the patient is deceased, the date of death and cause of death must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())
|
| o-pat-req-7 | error | Patient | If the patient vital status is unknown, the end of records must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.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
Summary
Mandatory: 12 elements
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
SC | 0..* | CancerPatient | 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, o-pat-req-5, o-pat-req-6, o-pat-req-7 | ||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
O | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
| ||||||
![]() ![]() ![]() |
0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||||
![]() ![]() ![]() |
0..* | (Complex) | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |||||||
![]() ![]() ![]() |
SO | 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
| ||||||
![]() ![]() ![]() |
0..1 | code | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined. | |||||||
![]() ![]() ![]() |
O | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | Cancer Patient Consent status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-consent-status Binding: Consent Status Value Set (required)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | string | Cancer Patient Clinical Center URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-clinical-center
| ||||||
![]() ![]() ![]() |
O | 0..1 | Duration | Cancer Patient Overall Survival URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-overall-survival
| ||||||
![]() ![]() ![]() |
O | 0..1 | decimal | Cancer Patient Data Completion Rate URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-completion-rate
| ||||||
![]() ![]() ![]() |
O | 0..* | Reference() | Cancer Patient Data Contributors URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-contributors
| ||||||
![]() ![]() ![]() |
SO | 0..1 | date | Cancer Patient End of Records URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records
| ||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() |
SΣ | 2..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Onconova Logical Pseudoidentifier
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Accession Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: Onconova | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Clinical Identifier from Clinical Center
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Medical Record Number | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() |
SΣC | 1..* | HumanName | Not used in this profile Constraints: us-core-6 | ||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: DataAbsentReason (required) Required Pattern: masked | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | Not used in this profile | ||||||
![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||||
![]() ![]() |
SOΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
| ||||||
![]() ![]() |
SOΣ | 1..1 | date | Date of birth of the patient normalized to the first day of the month
| ||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age at Diagnosis URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age-at-diagnosis
| ||||||
![]() ![]() |
?!SOΣ | 1..1 | dateTime | Date of death of the patient, if applicable
| ||||||
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Vital status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status Binding: Vital Status Value Set (required)
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Cause of Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death Binding: Cause of Death Value Set (required)
| ||||||
![]() ![]() |
SΣ | 0..* | Address | Not used in this profile | ||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | ||||||
![]() ![]() |
0..1 | CodeableConcept | Not used in this profile Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() |
0..* | Attachment | Not used in this profile | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Not used in this profile Constraints: pat-1 | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() |
0..* | BackboneElement | Not used in this profile | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Not used in this profile | |||||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
Documentation for this format | ||||||||||
| 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.extension:anonymizedEntry.value[x] | Base | required | DataAbsentReason | 📦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. |
| 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 | **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()
|
| 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()
|
| o-pat-req-4 | error | Patient | The birthDate element is required and must be provided |
birthDate.exists() and birthDate.hasValue()
|
| o-pat-req-5 | error | Patient | The vital status extension is required and must be provided. |
deceased.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.exists()
|
| o-pat-req-6 | error | Patient | If the patient is deceased, the date of death and cause of death must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())
|
| o-pat-req-7 | error | Patient | If the patient vital status is unknown, the end of records must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | CancerPatient | 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, o-pat-req-5, o-pat-req-6, o-pat-req-7 | ||||||
![]() ![]() |
2..* | Extension | Extension | |||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
O | 0..1 | USCoreRaceExtension | US Core Race Extension
| ||||||
![]() ![]() ![]() |
0..* | USCoreTribalAffiliationExtension | Not used in this profile | |||||||
![]() ![]() ![]() |
O | 0..1 | USCoreBirthSexExtension | Extension
| ||||||
![]() ![]() ![]() |
0..1 | USCoreSexExtension | Not used in this profile | |||||||
![]() ![]() ![]() |
O | 0..* | USCoreGenderIdentityExtension | Extension
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | Cancer Patient Consent status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-consent-status Binding: Consent Status Value Set (required)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | string | Cancer Patient Clinical Center URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-clinical-center
| ||||||
![]() ![]() ![]() |
O | 0..1 | Duration | Cancer Patient Overall Survival URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-overall-survival
| ||||||
![]() ![]() ![]() |
O | 0..1 | decimal | Cancer Patient Data Completion Rate URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-completion-rate
| ||||||
![]() ![]() ![]() |
O | 0..* | Reference() | Cancer Patient Data Contributors URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-contributors
| ||||||
![]() ![]() ![]() |
SO | 0..1 | date | Cancer Patient End of Records URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records
| ||||||
![]() ![]() |
2..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type | |||||||
![]() ![]() ![]() |
SO | 1..* | Identifier | Onconova Logical Pseudoidentifier
| ||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Accession Identifier | |||||||
![]() ![]() ![]() ![]() |
1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: Onconova | |||||||
![]() ![]() ![]() |
SO | 1..* | Identifier | Clinical Identifier from Clinical Center
| ||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Medical Record Number | |||||||
![]() ![]() |
1..* | HumanName | Not used in this profile | |||||||
![]() ![]() ![]() |
1..* | Extension | Extension | |||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
1..* | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Required Pattern: masked | |||||||
![]() ![]() |
0..* | ContactPoint | Not used in this profile | |||||||
![]() ![]() |
O | 1..1 | code | (USCDI) male | female | other | unknown
| ||||||
![]() ![]() |
O | 1..1 | date | Date of birth of the patient normalized to the first day of the month
| ||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age at Diagnosis URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age-at-diagnosis
| ||||||
![]() ![]() |
O | 1..1 | dateTime | Date of death of the patient, if applicable
| ||||||
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Vital status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status Binding: Vital Status Value Set (required)
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Cause of Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death Binding: Cause of Death Value Set (required)
| ||||||
![]() ![]() |
0..* | Address | Not used in this profile | |||||||
![]() ![]() |
0..1 | CodeableConcept | Not used in this profile | |||||||
![]() ![]() |
0..* | Attachment | Not used in this profile | |||||||
![]() ![]() |
0..* | BackboneElement | Not used in this profile | |||||||
![]() ![]() |
0..* | BackboneElement | Not used in this profile | |||||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Not used in this profile | |||||||
Documentation for this format | ||||||||||
| 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()
|
| o-pat-req-4 | error | Patient | The birthDate element is required and must be provided |
birthDate.exists() and birthDate.hasValue()
|
| o-pat-req-5 | error | Patient | The vital status extension is required and must be provided. |
deceased.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.exists()
|
| o-pat-req-6 | error | Patient | If the patient is deceased, the date of death and cause of death must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())
|
| o-pat-req-7 | error | Patient | If the patient vital status is unknown, the end of records must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.hasValue()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
SC | 0..* | CancerPatient | 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, o-pat-req-5, o-pat-req-6, o-pat-req-7 | ||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
O | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
| ||||||
![]() ![]() ![]() |
0..1 | (Complex) | (USCDI) US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||||
![]() ![]() ![]() |
0..* | (Complex) | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-tribal-affiliation | |||||||
![]() ![]() ![]() |
SO | 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
| ||||||
![]() ![]() ![]() |
0..1 | code | Not used in this profile URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-sex Binding: Sex (required): Concepts limited to Male, Female, Patient Sex Unknown, asked-declined. | |||||||
![]() ![]() ![]() |
O | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | code | Cancer Patient Consent status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-consent-status Binding: Consent Status Value Set (required)
| ||||||
![]() ![]() ![]() |
SO | 1..1 | string | Cancer Patient Clinical Center URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-clinical-center
| ||||||
![]() ![]() ![]() |
O | 0..1 | Duration | Cancer Patient Overall Survival URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-overall-survival
| ||||||
![]() ![]() ![]() |
O | 0..1 | decimal | Cancer Patient Data Completion Rate URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-completion-rate
| ||||||
![]() ![]() ![]() |
O | 0..* | Reference() | Cancer Patient Data Contributors URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-data-contributors
| ||||||
![]() ![]() ![]() |
SO | 0..1 | date | Cancer Patient End of Records URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records
| ||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
![]() ![]() |
SΣ | 2..* | Identifier | (USCDI) An identifier for this patient Slice: Unordered, Open by pattern:type | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Onconova Logical Pseudoidentifier
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Accession Identifier | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Required Pattern: Onconova | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | Identifier | Clinical Identifier from Clinical Center
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: MR | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Representation defined by the system Fixed Value: Medical Record Number | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | (USCDI) The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The value that is unique within the system. Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||||
![]() ![]() |
SΣC | 1..* | HumanName | Not used in this profile Constraints: us-core-6 | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
1..1 | (Complex) | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/data-absent-reason" | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: DataAbsentReason (required) Required Pattern: masked | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the full name | ||||||
![]() ![]() ![]() |
SΣC | 0..1 | string | (USCDI) Family name (often called 'Surname') | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() |
Σ | 0..* | string | (USCDI) Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when name was/is in use | ||||||
![]() ![]() |
Σ | 0..* | ContactPoint | Not used in this profile | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SΣC | 1..1 | code | (USCDI) phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | string | (USCDI) The actual contact point details | ||||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | (USCDI) home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||||
![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||||
![]() ![]() |
SOΣ | 1..1 | code | (USCDI) male | female | other | unknown Binding: AdministrativeGender (required)
| ||||||
![]() ![]() |
SOΣ | 1..1 | date | Date of birth of the patient normalized to the first day of the month
| ||||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age
| ||||||
![]() ![]() ![]() ![]() |
O | 0..1 | integer | Cancer Patient Age at Diagnosis URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-age-at-diagnosis
| ||||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||||
![]() ![]() |
?!SOΣ | 1..1 | dateTime | Date of death of the patient, if applicable
| ||||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||||
![]() ![]() ![]() |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Vital status URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status Binding: Vital Status Value Set (required)
| ||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | Cancer Patient Cause of Death URL: http://onconova.github.io/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death Binding: Cause of Death Value Set (required)
| ||||||
![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | |||||||
![]() ![]() |
SΣ | 0..* | Address | Not used in this profile | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | (USCDI) home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Name of city, town etc. Example General: Erewhon | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | ||||||
![]() ![]() ![]() |
SΣ | 0..1 | string | (USCDI) US Zip Codes Example General: 9132 | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||||
![]() ![]() ![]() |
Σ | 0..1 | Period | (USCDI) Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||||
![]() ![]() |
0..1 | CodeableConcept | Not used in this profile Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||
![]() ![]() |
0..1 | Whether patient is part of a multiple birth | ||||||||
![]() ![]() ![]() |
boolean | |||||||||
![]() ![]() ![]() |
integer | |||||||||
![]() ![]() |
0..* | Attachment | Not used in this profile | |||||||
![]() ![]() |
C | 0..* | BackboneElement | Not used in this profile Constraints: pat-1 | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||||
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||||
![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||
![]() ![]() |
0..* | BackboneElement | Not used in this profile | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | (USCDI) The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | ||||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Not used in this profile | |||||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | ||||||
![]() ![]() |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||||
![]() ![]() ![]() |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||||
Documentation for this format | ||||||||||
| 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.extension:anonymizedEntry.value[x] | Base | required | DataAbsentReason | 📦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. |
| 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 | **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()
|
| 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()
|
| o-pat-req-4 | error | Patient | The birthDate element is required and must be provided |
birthDate.exists() and birthDate.hasValue()
|
| o-pat-req-5 | error | Patient | The vital status extension is required and must be provided. |
deceased.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.exists()
|
| o-pat-req-6 | error | Patient | If the patient is deceased, the date of death and cause of death must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '419099009' implies (deceasedDateTime.hasValue() and deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-cause-of-death').valueCodeableConcept.exists())
|
| o-pat-req-7 | error | Patient | If the patient vital status is unknown, the end of records must be provided. |
deceasedDateTime.extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-vital-status').valueCodeableConcept.coding.code = '261665006' implies extension('http://hl7.org/fhir/StructureDefinition/onconova-ext-cancer-patient-end-of-records').valueDate.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
Summary
Mandatory: 12 elements
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron