Intelisoft FHIR TRAINING IG
0.1.0 - ci-build

Intelisoft FHIR TRAINING IG - Local Development build (v0.1.0). See the Directory of published versions

## Resource Profile: Fhir Training Patient Profile

Official URL: https://intellisoft-consulting.github.io/FHIR-training-ig-template/StructureDefinition/fhir-training-patient | Version: 0.1.0
Active as of 2022-05-17 | Responsible: Intelisoft | Computable Name: FhirTrainingPatient

Fhir Training Patient Profile

Usage:

- Examples for this Resource Profile: Patient/329f09da-0fc9-419d-9575-ace68954426A

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from Patient

Summary

Mandatory: 3 elements

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
active |  | 1..1 | boolean | Whether this patient's record is in active use
gender |  | 1..1 | code | male | female | other | unknown
birthDate |  | 1..1 | date | The date of birth for the individual
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | An identifier for this patient
active | ?!Σ | 1..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 | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 1..1 | date | The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
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 | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
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 | I | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 3 elements

Differential View

This structure is derived from Patient

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
active |  | 1..1 | boolean | Whether this patient's record is in active use
gender |  | 1..1 | code | male | female | other | unknown
birthDate |  | 1..1 | date | The date of birth for the individual
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Patient |  | 0..* | Patient | Information about an individual or animal receiving health care services
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | An identifier for this patient
active | ?!Σ | 1..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 | Σ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate | Σ | 1..1 | date | The date of birth for the individual
deceased[x] | ?!Σ | 0..1 |  | Indicates if the individual is deceased or not
deceasedBoolean |  |  | boolean |
deceasedDateTime |  |  | dateTime |
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 | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient
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 | I | 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.
Additional Bindings | Purpose
AllLanguages | Max Binding
preferred |  | 0..1 | boolean | Language preference indicator
generalPractitioner |  | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider
managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
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

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
Patient.language | preferred | CommonLanguages Max Binding: AllLanguages
Patient.gender | required | AdministrativeGender
Patient.maritalStatus | extensible | Marital Status Codes
Patient.contact.relationship | extensible | PatientContactRelationship
Patient.contact.gender | required | AdministrativeGender
Patient.communication.language | preferred | CommonLanguages Max Binding: AllLanguages
Patient.link.type | required | LinkType

#### Constraints

Id | Grade | Path | Details | Requirements
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | Best Practice | Patient | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
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() |
ele-1 | error | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |