OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Official URL: http://fhir.openmrs.org/core/StructureDefinition/omrs-person | Version: 0.1.0 | |||
| Active as of 2023-06-23 | Computable Name: OMRSPerson | |||
A FHIR Person as understood by OpenMRS
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Person
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Person | 0..* | Person | A generic person record | |
  id | 1..1 | id | Logical id of this artifact | |
| identifier | 0..* | Identifier | A human identifier for this person | |
| name | 1..* | HumanName | A name associated with the person | |
| telecom | 0..* | ContactPoint | A contact detail for the person | |
| gender | 1..1 | code | male | female | other | unknown | |
| birthDate | 1..1 | date | The date on which the person was born | |
| address | 0..* | Address | One or more addresses for the person | |
| active | 1..1 | boolean | This person's record is in active use Required Pattern: true | |
 link | 0..* | BackboneElement | Link to a resource that concerns the same actual person | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person | 0..* | Person | A generic person record | |
 id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | 0..* | Identifier | A human identifier for this person | |
| name | Σ | 1..* | HumanName | A name associated with the person |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person |
| 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 on which the person was born |
| address | 0..* | Address | One or more addresses for the person | |
| active | ?!Σ | 1..1 | boolean | This person's record is in active use Required Pattern: true |
 link | 0..* | BackboneElement | Link to a resource that concerns the same actual person | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 target | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Person.gender | required | AdministrativeGender |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Person | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Person | 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 | Person | 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 | Person | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Person | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Person | 0..* | Person | A generic person record | |||||
| id | Σ | 1..1 | id | 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.
| |||||
| 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 | |||||
| name | Σ | 1..* | HumanName | A name associated with the person | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person | ||||
| 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 on which the person was born | ||||
| address | 0..* | Address | One or more addresses for the person | |||||
| photo | 0..1 | Attachment | Image of the person | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | The organization that is the custodian of the person record | ||||
| active | ?!Σ | 1..1 | boolean | This person's record is in active use Required Pattern: true | ||||
| link | 0..* | BackboneElement | Link to a 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 | ||||
| target | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | |||||
| assurance | 0..1 | code | level1 | level2 | level3 | level4 Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Person.language | preferred | CommonLanguages
| ||||
| Person.gender | required | AdministrativeGender | ||||
| Person.link.assurance | required | IdentityAssuranceLevel |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Person
Differential View
This structure is derived from Person
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person | 0..* | Person | A generic person record | |
| id | 1..1 | id | Logical id of this artifact | |
| identifier | 0..* | Identifier | A human identifier for this person | |
| name | 1..* | HumanName | A name associated with the person | |
| telecom | 0..* | ContactPoint | A contact detail for the person | |
| gender | 1..1 | code | male | female | other | unknown | |
| birthDate | 1..1 | date | The date on which the person was born | |
| address | 0..* | Address | One or more addresses for the person | |
| active | 1..1 | boolean | This person's record is in active use Required Pattern: true | |
| link | 0..* | BackboneElement | Link to a resource that concerns the same actual person | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person | 0..* | Person | A generic person record | |
| id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | A human identifier for this person | |
| name | Σ | 1..* | HumanName | A name associated with the person |
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person |
| 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 on which the person was born |
| address | 0..* | Address | One or more addresses for the person | |
| active | ?!Σ | 1..1 | boolean | This person's record is in active use Required Pattern: true |
| link | 0..* | BackboneElement | Link to a resource that concerns the same actual person | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| target | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Person.gender | required | AdministrativeGender |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Person | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Person | 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 | Person | 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 | Person | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Person | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Person | 0..* | Person | A generic person record | |||||
| id | Σ | 1..1 | id | 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.
| |||||
| 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 | |||||
| name | Σ | 1..* | HumanName | A name associated with the person | ||||
| telecom | Σ | 0..* | ContactPoint | A contact detail for the person | ||||
| 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 on which the person was born | ||||
| address | 0..* | Address | One or more addresses for the person | |||||
| photo | 0..1 | Attachment | Image of the person | |||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | The organization that is the custodian of the person record | ||||
| active | ?!Σ | 1..1 | boolean | This person's record is in active use Required Pattern: true | ||||
| link | 0..* | BackboneElement | Link to a 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 | ||||
| target | 1..1 | Reference(Patient | Practitioner | RelatedPerson | Person) | The resource to which this actual person is associated | |||||
| assurance | 0..1 | code | level1 | level2 | level3 | level4 Binding: IdentityAssuranceLevel (required): The level of confidence that this link represents the same actual person, based on NIST Authentication Levels. | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Person.language | preferred | CommonLanguages
| ||||
| Person.gender | required | AdministrativeGender | ||||
| Person.link.assurance | required | IdentityAssuranceLevel |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Person
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ . Package openmrs.fhir.core#0.1.0 based on FHIR 4.0.1. Generated 2023-06-23
Links: Table of Contents |
QA Report |
Version History |
|