Cancer Pathology Data Sharing
0.1.0 - STU 1 Ballot
Cancer Pathology Data Sharing
0.1.0 - STU 1 Ballot
This page is part of the Sharing eCC Data from Pathology Labs to EHR (v0.1.0: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-next-of-kin |
| Version: | 0.1.0 |
| Name: | USPathologyNextOfKin |
| Title: | US Pathology Next of Kin |
| Status: | Active as of 2021-08-12T15:45:55+00:00 |
| Publisher: | HL7 International - Orders and Observations |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-next-of-kin
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
  patient | S | 1..1 | Reference(Patient) | The patient this person is related to |
 relationship | S | 1..* | CodeableConcept | The nature of the relationship Required Pattern: At least the following |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Next-of-Kin | |
| name | S | 0..1 | HumanName | A name associated with the person |
| telecom | S | 0..* | ContactPoint | A contact detail for the person |
| address | S | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
 patient | SΣ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Next-of-Kin | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| name | SΣ | 0..1 | HumanName | A name associated with the person |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date on which the related person was born |
| address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Next-of-Kin | |
| name | Σ | 0..1 | HumanName | A name associated with the person |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person |
| address | Σ | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
This structure is derived from RelatedPerson
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| patient | S | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | S | 1..* | CodeableConcept | The nature of the relationship Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Next-of-Kin | |
| name | S | 0..1 | HumanName | A name associated with the person |
| telecom | S | 0..* | ContactPoint | A contact detail for the person |
| address | S | 0..* | Address | Address where the related person can be contacted or visited |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | Identifier | A human identifier for this person |
| active | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use |
| patient | SΣ | 1..1 | Reference(Patient) | The patient this person is related to |
| relationship | SΣ | 1..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0131 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: N | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Next-of-Kin | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| name | SΣ | 0..1 | HumanName | A name associated with the person |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the person |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | Σ | 0..1 | date | The date on which the related person was born |
| address | SΣ | 0..* | Address | Address where the related person can be contacted or visited |
| photo | 0..* | Attachment | Image of the person | |
| period | 0..1 | Period | Period of time that this relationship is considered valid | |
| communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| preferred | 0..1 | boolean | Language preference indicator | |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| RelatedPerson.language | preferred | CommonLanguages Max Binding: AllLanguages |
| RelatedPerson.relationship | preferred | Pattern: N("Next-of-Kin") |
| RelatedPerson.gender | required | AdministrativeGender |
| RelatedPerson.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Id | Path | Details | Requirements |
| dom-2 | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | RelatedPerson | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | RelatedPerson.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | RelatedPerson.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | RelatedPerson.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | RelatedPerson.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Orders and Observations. Package hl7.fhir.us.cancer-reporting#0.1.0 based on FHIR 4.0.1. Generated 2021-08-12
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change