The official URL for this profile is:
http://hl7.org/fhir/us/sw/StructureDefinition/shr-entity-Person
This profile builds on Patient.
This profile was published on Fri Aug 17 00:00:00 EDT 2018 as a draft by HL7 Patient Care and Clinical Information Modeling Initiative Work Groups.
View the corresponding PersonModel logical model.
Summary
Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
SW Mapping Source
This structure represents the following SW mapping definition:
shr.entity.Person maps to Patient:
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | SW Person Profile | |
id | Σ | 0..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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 2..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
shr-base-FindingStatus-extension | 1..1 | code | SW FindingStatus Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingStatus-extension Binding: ObservationStatus (required) | |
shr-base-RelevantTime-extension | 0..1 | dateTime, Period | SW RelevantTime Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-RelevantTime-extension | |
shr-base-FindingMethod-extension | 0..1 | CodeableConcept | SW FindingMethod Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingMethod-extension | |
shr-base-PresentOrAbsent-extension | 1..1 | CodeableConcept | SW PresentOrAbsent Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-PresentOrAbsent-extension Binding: SW PresentAbsentVS ValueSet (required) | |
shr-base-Subject-extension | 0..1 | Reference(DomainResource) | SW Subject Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Subject-extension | |
shr-base-ObjectTypeCode-extension | 0..1 | CodeableConcept | SW ObjectTypeCode Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-ObjectTypeCode-extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-ObjectTypeCode-extension" | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
coding | Σ | 1..1 | Coding | Person (person) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 125676002 |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
shr-base-ObjectIdentifier-extension | 0..1 | string | SW ObjectIdentifier Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-ObjectIdentifier-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | An identifier for this patient |
active | ?!Σ | 0..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 | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | Σ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | Σ | 0..* | Address | Addresses for the individual |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible) | |
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) | |
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 | |
animal | ?!ΣI | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example) |
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example) |
communication | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider | |
managingOrganization | Σ | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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 - type of link Binding: LinkType (required) |
Documentation for this format |
Summary
Mandatory: 0 element (4 nested mandatory elements)
Fixed Value: 2 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
SW Mapping Source
This structure represents the following SW mapping definition:
shr.entity.Person maps to Patient:
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | I | 0..* | SW Person Profile | |
id | Σ | 0..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: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 2..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
shr-base-FindingStatus-extension | 1..1 | code | SW FindingStatus Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingStatus-extension Binding: ObservationStatus (required) | |
shr-base-RelevantTime-extension | 0..1 | dateTime, Period | SW RelevantTime Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-RelevantTime-extension | |
shr-base-FindingMethod-extension | 0..1 | CodeableConcept | SW FindingMethod Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-FindingMethod-extension | |
shr-base-PresentOrAbsent-extension | 1..1 | CodeableConcept | SW PresentOrAbsent Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-PresentOrAbsent-extension Binding: SW PresentAbsentVS ValueSet (required) | |
shr-base-Subject-extension | 0..1 | Reference(DomainResource) | SW Subject Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-Subject-extension | |
shr-base-ObjectTypeCode-extension | 0..1 | CodeableConcept | SW ObjectTypeCode Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-ObjectTypeCode-extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-ObjectTypeCode-extension" | |
valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
coding | Σ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:code | |
coding | Σ | 1..1 | Coding | Person (person) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
system | Σ | 0..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system Fixed Value: 125676002 |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
shr-base-ObjectIdentifier-extension | 0..1 | string | SW ObjectIdentifier Extension URL: http://hl7.org/fhir/us/sw/StructureDefinition/shr-base-ObjectIdentifier-extension | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | An identifier for this patient |
active | ?!Σ | 0..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 | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
birthDate | Σ | 0..1 | date | The date of birth for the individual |
deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not |
address | Σ | 0..* | Address | Addresses for the individual |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) | |
multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |
photo | 0..* | Attachment | Image of the patient | |
contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible) | |
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) | |
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 | |
animal | ?!ΣI | 0..1 | BackboneElement | This patient is known to be an animal (non-human) |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
species | Σ | 1..1 | CodeableConcept | E.g. Dog, Cow Binding: AnimalSpecies (example) |
breed | Σ | 0..1 | CodeableConcept | E.g. Poodle, Angus Binding: AnimalBreeds (example) |
genderStatus | Σ | 0..1 | CodeableConcept | E.g. Neutered, Intact Binding: GenderStatus (example) |
communication | I | 0..* | BackboneElement | A list of Languages which may be used to communicate with the patient about his or her health |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Common Languages (extensible) | |
preferred | 0..1 | boolean | Language preference indicator | |
generalPractitioner | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider | |
managingOrganization | Σ | 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 | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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 - type of link Binding: LinkType (required) |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Name | Conformance | ValueSet |
Patient.language | Common Languages | extensible | Common Languages |
Patient.gender | AdministrativeGender | required | AdministrativeGender |
Patient.maritalStatus | Marital Status Codes | extensible | Marital Status Codes |
Patient.contact.relationship | v2 Contact Role | extensible | v2 Contact Role |
Patient.contact.gender | AdministrativeGender | required | AdministrativeGender |
Patient.animal.species | AnimalSpecies | example | AnimalSpecies |
Patient.animal.breed | AnimalBreeds | example | AnimalBreeds |
Patient.animal.genderStatus | GenderStatus | example | GenderStatus |
Patient.communication.language | Common Languages | extensible | Common Languages |
Patient.link.type | LinkType | required | LinkType |
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-1 | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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-3 | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | Patient.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
pat-1 | 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 | Patient.animal | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | Patient.link | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |