FHIR Osiris Implementation Guide
1.1.0 - trial-implementation
FHIR Osiris Implementation Guide
1.1.0 - trial-implementation
This page is part of the OSIRIS FHIR Implementation Guide (v1.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/onco-patient | Version: 1.1.0 | |||
| Draft as of 2025-04-03 | Computable Name: OncoPatient | |||
Oncology patient defined by Osiris.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
  Patient |
0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  id |
SΣ | 1..1 | id | Local patient identifier |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices pour extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   extension:ethnicity |
S | 0..1 | CodeableConcept | Ethnicity URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/ethnicity Binding: Race (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 extension:origin-center |
S | 1..1 | Reference(Cancer Organization) | Identifier of the patient's origin center URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/origin-center ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
| gender |
SΣ | 1..1 | code | Sex of the patient Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
| birthDate |
SΣ | 1..1 | date | Birthdate ele-1: All FHIR elements must have a @value or children |
 Slices pour deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| deceased[x]:deceasedDateTime |
?!SΣ | 0..1 | dateTime | Death date. Obligatory if vitalstatus is C1546956 (died). ele-1: All FHIR elements must have a @value or children |
 managingOrganization |
SΣ | 1..1 | Reference(Cancer Organization) | Identifier of the center providing the data ele-1: All FHIR elements must have a @value or children |
  link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children |
 type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformité | ValueSet | URI |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
This structure is derived from Patient
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |
 id |
S | 1..1 | id | Local patient identifier |
| Slices pour extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ethnicity |
S | 0..1 | CodeableConcept | Ethnicity URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/ethnicity Binding: Race (extensible) |
| extension:origin-center |
S | 1..1 | Reference(Cancer Organization) | Identifier of the patient's origin center URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/origin-center |
| gender |
S | 1..1 | code | Sex of the patient |
| birthDate |
S | 1..1 | date | Birthdate |
| Slices pour deceased[x] |
0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
| deceased[x]:deceasedDateTime |
S | 0..1 | dateTime | Death date. Obligatory if vitalstatus is C1546956 (died). |
| managingOrganization |
S | 1..1 | Reference(Cancer Organization) | Identifier of the center providing the data |
| Documentation for this format | ||||
| Nom | Drapeaux | Card. | Type | Description et contraintes | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id |
SΣ | 1..1 | id | Local patient identifier | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices pour extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ethnicity |
S | 0..1 | CodeableConcept | Ethnicity URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/ethnicity Binding: Race (extensible) | ||||
| extension:origin-center |
S | 1..1 | Reference(Cancer Organization) | Identifier of the patient's origin center URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/origin-center | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | An identifier for this patient | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
Σ | 0..* | HumanName | A name associated with the patient | ||||
| telecom |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender |
SΣ | 1..1 | code | Sex of the patient Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
SΣ | 1..1 | date | Birthdate | ||||
| Slices pour deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| deceased[x]:deceasedDateTime |
?!SΣ | 0..1 | dateTime | Death date. Obligatory if vitalstatus is C1546956 (died). | ||||
| address |
Σ | 0..* | Address | An address for the individual | ||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
 multipleBirth[x] |
0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean |
boolean | |||||||
| multipleBirthInteger |
integer | |||||||
| photo |
0..* | Attachment | Image of the patient | |||||
| contact |
C | 0..* | BackboneElement | A 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..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||
| telecom |
0..* | ContactPoint | A contact detail for the person | |||||
| address |
0..1 | Address | Address for the contact person | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization |
SΣ | 1..1 | Reference(Cancer Organization) | Identifier of the center providing the data | ||||
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformité | ValueSet | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
This structure is derived from Patient
Résumé
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:
Key Elements View
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| id |
SΣ | 1..1 | id | Local patient identifier |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices pour extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension:ethnicity |
S | 0..1 | CodeableConcept | Ethnicity URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/ethnicity Binding: Race (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| extension:origin-center |
S | 1..1 | Reference(Cancer Organization) | Identifier of the patient's origin center URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/origin-center ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children |
| gender |
SΣ | 1..1 | code | Sex of the patient Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. ele-1: All FHIR elements must have a @value or children |
| birthDate |
SΣ | 1..1 | date | Birthdate ele-1: All FHIR elements must have a @value or children |
| Slices pour deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
| deceasedBoolean |
boolean | |||
| deceasedDateTime |
dateTime | |||
| deceased[x]:deceasedDateTime |
?!SΣ | 0..1 | dateTime | Death date. Obligatory if vitalstatus is C1546956 (died). ele-1: All FHIR elements must have a @value or children |
| managingOrganization |
SΣ | 1..1 | Reference(Cancer Organization) | Identifier of the center providing the data ele-1: All FHIR elements must have a @value or children |
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children |
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformité | ValueSet | URI |
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | |
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
Differential View
This structure is derived from Patient
| Nom | Drapeaux | Card. | Type | Description et contraintes |
|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |
| id |
S | 1..1 | id | Local patient identifier |
| Slices pour extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ethnicity |
S | 0..1 | CodeableConcept | Ethnicity URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/ethnicity Binding: Race (extensible) |
| extension:origin-center |
S | 1..1 | Reference(Cancer Organization) | Identifier of the patient's origin center URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/origin-center |
| gender |
S | 1..1 | code | Sex of the patient |
| birthDate |
S | 1..1 | date | Birthdate |
| Slices pour deceased[x] |
0..1 | boolean, dateTime | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |
| deceased[x]:deceasedDateTime |
S | 0..1 | dateTime | Death date. Obligatory if vitalstatus is C1546956 (died). |
| managingOrganization |
S | 1..1 | Reference(Cancer Organization) | Identifier of the center providing the data |
| Documentation for this format | ||||
Snapshot View
| Nom | Drapeaux | Card. | Type | Description et contraintes | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
0..* | Patient | Information about an individual or animal receiving health care services | |||||
| id |
SΣ | 1..1 | id | Local patient identifier | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices pour extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ethnicity |
S | 0..1 | CodeableConcept | Ethnicity URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/ethnicity Binding: Race (extensible) | ||||
| extension:origin-center |
S | 1..1 | Reference(Cancer Organization) | Identifier of the patient's origin center URL: https://ig-osiris.cancer.fr/ig/osiris/StructureDefinition/origin-center | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | An identifier for this patient | ||||
| active |
?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
| name |
Σ | 0..* | HumanName | A name associated with the patient | ||||
| telecom |
Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
| gender |
SΣ | 1..1 | code | Sex of the patient Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
SΣ | 1..1 | date | Birthdate | ||||
| Slices pour deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| deceased[x]:deceasedDateTime |
?!SΣ | 0..1 | dateTime | Death date. Obligatory if vitalstatus is C1546956 (died). | ||||
| address |
Σ | 0..* | Address | An address for the individual | ||||
| maritalStatus |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
| multipleBirth[x] |
0..1 | Whether patient is part of a multiple birth | ||||||
| multipleBirthBoolean |
boolean | |||||||
| multipleBirthInteger |
integer | |||||||
| photo |
0..* | Attachment | Image of the patient | |||||
| contact |
C | 0..* | BackboneElement | A 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..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| relationship |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
| name |
0..1 | HumanName | A name associated with the contact person | |||||
| telecom |
0..* | ContactPoint | A contact detail for the person | |||||
| address |
0..1 | Address | Address for the contact person | |||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
| organization |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
| period |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language.
| |||||
| preferred |
0..1 | boolean | Language preference indicator | |||||
| generalPractitioner |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
| managingOrganization |
SΣ | 1..1 | Reference(Cancer Organization) | Identifier of the center providing the data | ||||
| link |
?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| other |
Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
| type |
Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
| Documentation for this format | ||||||||
| Path | Conformité | ValueSet | URI | |||
| Patient.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
This structure is derived from Patient
Résumé
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:
Other representations of profile: CSV, Excel, Schematron