OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build

OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: OpenMRS Patient

Defining URL:http://fhir.openmrs.org/fhir/StructureDefinition/omrs-patient
Version:0.1.0
Name:OMRSPatient
Title:OpenMRS Patient
Status:Active as of 2022-11-29 05:06:49+0000
Definition:

A FHIR Patient as understood by OpenMRS

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://fhir.openmrs.org/fhir/StructureDefinition/omrs-patient

Formal Views of Profile Content

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

This structure is derived from Patient

Summary

Mandatory: 5 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of value:system

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id 0..1idLogical id of this artifact
... identifier 1..*OMRSPatientIdentifierAn identifier intended for computation
Slice: Unordered, Open by value:system
... active 1..1booleanWhether this patient's record is in active use
Required Pattern: true
... telecom 0..*ContactPointA contact detail for the individual
... gender 1..1codemale | female | other | unknown
... birthDate 1..1dateThe date of birth for the individual
... deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address for the individual
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication 0..0
... generalPractitioner 0..0
... managingOrganization 0..0
... link 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*OMRSPatientIdentifierAn identifier intended for computation
Slice: Unordered, Open by value:system
... active ?!Σ1..1booleanWhether this patient's record is in active use
Required Pattern: true
... name Σ1..1HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ1..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAn address for the individual

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services

doco Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 5 elements
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Patient.identifier is sliced based on the value of value:system

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id 0..1idLogical id of this artifact
... identifier 1..*OMRSPatientIdentifierAn identifier intended for computation
Slice: Unordered, Open by value:system
... active 1..1booleanWhether this patient's record is in active use
Required Pattern: true
... telecom 0..*ContactPointA contact detail for the individual
... gender 1..1codemale | female | other | unknown
... birthDate 1..1dateThe date of birth for the individual
... deceased[x] 0..1boolean, dateTimeIndicates if the individual is deceased or not
... address 0..*AddressAn address for the individual
... maritalStatus 0..0
... multipleBirth[x] 0..0
... photo 0..0
... contact 0..0
... communication 0..0
... generalPractitioner 0..0
... managingOrganization 0..0
... link 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*OMRSPatientIdentifierAn identifier intended for computation
Slice: Unordered, Open by value:system
... active ?!Σ1..1booleanWhether this patient's record is in active use
Required Pattern: true
... name Σ1..1HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ1..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAn address for the individual

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.genderrequiredAdministrativeGender
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.link.typerequiredLinkType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()