FHIR Osiris Implementation Guide
2.1.0 - ci-build

FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Oncology Patient

Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/onco-patient Version: 2.1.0
Draft as of 2024-03-21 Computable Name: OncoPatient

Oncology patient defined by Osiris.

Usage:

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id S1..1idLocal patient identifier
... extension 1..*ExtensionExtension
... ethnicity S0..1CodeableConceptEthnicity
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/ethnicity
Binding: Race (extensible)
... gender S1..1codeSex of the patient
... birthDate S1..1dateBirthdate
... Slices for deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedDateTime S0..1dateTimeDeath date. Obligatory if vitalstatus is C1546956 (died).
... managingOrganization S1..1Reference(Cancer Organization)Identifier of the center providing the data

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id SΣ1..1idLocal patient identifier
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... origin-center S1..1Reference(Cancer Organization)Identifier of the patient's origin center
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/origin-center
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... active ?!Σ0..1booleanWhether this patient's record is in active use
... gender SΣ1..1codeSex of the patient
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateBirthdate
... Slices for deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedDateTime ?!SΣ0..1dateTimeDeath date. Obligatory if vitalstatus is C1546956 (died).
... managingOrganization SΣC1..1Reference(Cancer Organization)Identifier of the center providing the data
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id SΣ1..1idLocal patient identifier
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicity S0..1CodeableConceptEthnicity
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/ethnicity
Binding: Race (extensible)
... origin-center S1..1Reference(Cancer Organization)Identifier of the patient's origin center
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/origin-center
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*IdentifierAn identifier for this patient
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom ΣC0..*ContactPointA contact detail for the individual
cpt-2: A system is required if a value is provided.
... gender SΣ1..1codeSex of the patient
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateBirthdate
... Slices for deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedDateTime ?!SΣ0..1dateTimeDeath date. Obligatory if vitalstatus is C1546956 (died).
... address Σ0..*AddressAn address for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo C0..*AttachmentImage of the patient
att-1: If the Attachment has data, it SHALL have a contentType
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom C0..*ContactPointA contact detail for the person
cpt-2: A system is required if a value is provided.
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
ref-1: SHALL have a contained resource if a local reference is provided
.... period C0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
per-1: If present, start SHALL have a lower value than end
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner C0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
ref-1: SHALL have a contained resource if a local reference is provided
... managingOrganization SΣC1..1Reference(Cancer Organization)Identifier of the center providing the data
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from Patient

Summary

Mandatory: 6 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.deceased[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id S1..1idLocal patient identifier
... extension 1..*ExtensionExtension
... ethnicity S0..1CodeableConceptEthnicity
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/ethnicity
Binding: Race (extensible)
... gender S1..1codeSex of the patient
... birthDate S1..1dateBirthdate
... Slices for deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceased[x]:deceasedDateTime S0..1dateTimeDeath date. Obligatory if vitalstatus is C1546956 (died).
... managingOrganization S1..1Reference(Cancer Organization)Identifier of the center providing the data

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id SΣ1..1idLocal patient identifier
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... origin-center S1..1Reference(Cancer Organization)Identifier of the patient's origin center
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/origin-center
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... active ?!Σ0..1booleanWhether this patient's record is in active use
... gender SΣ1..1codeSex of the patient
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateBirthdate
... Slices for deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedDateTime ?!SΣ0..1dateTimeDeath date. Obligatory if vitalstatus is C1546956 (died).
... managingOrganization SΣC1..1Reference(Cancer Organization)Identifier of the center providing the data
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id SΣ1..1idLocal patient identifier
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicity S0..1CodeableConceptEthnicity
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/ethnicity
Binding: Race (extensible)
... origin-center S1..1Reference(Cancer Organization)Identifier of the patient's origin center
URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/origin-center
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*IdentifierAn identifier for this patient
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ0..*HumanNameA name associated with the patient
... telecom ΣC0..*ContactPointA contact detail for the individual
cpt-2: A system is required if a value is provided.
... gender SΣ1..1codeSex of the patient
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ1..1dateBirthdate
... Slices for deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
Slice: Unordered, Open by type:$this
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
.... deceased[x]:deceasedDateTime ?!SΣ0..1dateTimeDeath date. Obligatory if vitalstatus is C1546956 (died).
... address Σ0..*AddressAn address for the individual
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo C0..*AttachmentImage of the patient
att-1: If the Attachment has data, it SHALL have a contentType
... contact C0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom C0..*ContactPointA contact detail for the person
cpt-2: A system is required if a value is provided.
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
ref-1: SHALL have a contained resource if a local reference is provided
.... period C0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
per-1: If present, start SHALL have a lower value than end
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner C0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
ref-1: SHALL have a contained resource if a local reference is provided
... managingOrganization SΣC1..1Reference(Cancer Organization)Identifier of the center providing the data
ref-1: SHALL have a contained resource if a local reference is provided
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other ΣC1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
ref-1: SHALL have a contained resource if a local reference is provided
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

This structure is derived from Patient

Summary

Mandatory: 6 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Patient.deceased[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron