Kids First Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: kfdrc-patient-no-phi
The official URL for this profile is:
http://fhir.kids-first.io/StructureDefinition/kfdrc-patient-no-phi
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from kfdrc-patient
This structure is derived from kfdrc-patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient | 0..* | kfdrc-patient | Information about an individual or animal receiving health care services | |
  name | 0..0 | |||
| telecom | 0..0 | |||
| birthDate | 0..0 | |||
 deceased[x] | 0..1 | boolean | Indicates if the individual is deceased or not | |
| address | 0..0 | |||
| photo | 0..0 | |||
 contact | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | kfdrc-patient | Information about an individual or animal receiving health care services |
| id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
 us-core-ethnicity | SI | 0..1 | (Complex) | US Core Ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
| us-core-race | SI | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
| species | SI | 0..1 | CodeableConcept | Species URL: http://fhir.kids-first.io/StructureDefinition/species Binding: Species (required) |
| relation | SI | 0..* | (Complex) | Related entity of the Kids First DRC Patient URL: http://fhir.kids-first.io/StructureDefinition/relation |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | An identifier for this patient |
| active | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| deceased[x] | ?!ΣI | 0..1 | boolean | Indicates if the individual is deceased or not |
| maritalStatus | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
  multipleBirth[x] | I | 0..1 | Whether patient is part of a multiple birth | |
 multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| communication | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | I | 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 |
| preferred | I | 0..1 | boolean | Language preference indicator |
 generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
| managingOrganization | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
 link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | kfdrc-patient | Information about an individual or animal receiving health care services |
| us-core-ethnicity | I | 0..1 | (Complex) | US Core Ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
| us-core-race | I | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
| species | I | 0..1 | CodeableConcept | Species URL: http://fhir.kids-first.io/StructureDefinition/species Binding: Species (required) |
| relation | I | 0..* | (Complex) | Related entity of the Kids First DRC Patient URL: http://fhir.kids-first.io/StructureDefinition/relation |
| Documentation for this format | ||||
This structure is derived from kfdrc-patient
Differential View
This structure is derived from kfdrc-patient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | kfdrc-patient | Information about an individual or animal receiving health care services | |
| name | 0..0 | |||
| telecom | 0..0 | |||
| birthDate | 0..0 | |||
| deceased[x] | 0..1 | boolean | Indicates if the individual is deceased or not | |
| address | 0..0 | |||
| photo | 0..0 | |||
| contact | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | I | 0..* | kfdrc-patient | Information about an individual or animal receiving health care services |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| us-core-ethnicity | SI | 0..1 | (Complex) | US Core Ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity |
| us-core-race | SI | 0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race |
| species | SI | 0..1 | CodeableConcept | Species URL: http://fhir.kids-first.io/StructureDefinition/species Binding: Species (required) |
| relation | SI | 0..* | (Complex) | Related entity of the Kids First DRC Patient URL: http://fhir.kids-first.io/StructureDefinition/relation |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | An identifier for this patient |
| active | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
| gender | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| deceased[x] | ?!ΣI | 0..1 | boolean | Indicates if the individual is deceased or not |
| maritalStatus | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
| multipleBirth[x] | I | 0..1 | Whether patient is part of a multiple birth | |
| multipleBirthBoolean | boolean | |||
| multipleBirthInteger | integer | |||
| communication | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| language | I | 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 |
| preferred | I | 0..1 | boolean | Language preference indicator |
| generalPractitioner | I | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider |
| managingOrganization | ΣI | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record |
| link | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| other | ΣI | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
| type | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
| Documentation for this format | ||||
Other representations of profile: 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 | Path | Details | Requirements |
| dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:us-core-ethnicity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:us-core-ethnicity | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:us-core-race | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:us-core-race | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:species | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:species | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.extension:relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.extension:relation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |