HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

- Local Development build (v0.9.0). See the Directory of published versions

Patient

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Patient

A person in the role of a patient. Sometimes, the patient is not the subject of information in a clinical statement where the Patient is the SubjectOfRecord.

SHR follows Argonaut and makes the value set binding on marital status required. SHR also adds optional extensions on communication ability to more fully characterize language skills. MaritalStatus has a required binding in Argonaut, but an extensible binding in US-Core. To be feasible under both DSTU2 Argonaut and STU3 US-Core, the required binding strength is adopted.

This profile builds on http://fhir.org/guides/argonaut/StructureDefinition/argo-patient.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Must-Support: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Patient maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-patient:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  constrain active to 0..0
  Status maps to extension
  Person.HumanName maps to name
  Person.AdministrativeGender maps to gender
  Person.PhotographicImage maps to photo
  Person.Address maps to address
  Person.ContactPoint maps to telecom
  Person.Communication.Language maps to communication.language
  Person.Communication.Preferred maps to communication.preferred
  Person.DateOfBirth maps to birthDate
  Person.MaritalStatus maps to maritalStatus
  Person.MultipleBirth maps to multipleBirth[x]
  Person.BirthSex maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex
  Person.Race maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-race
  Person.Ethnicity maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity
  Person.Deceased maps to deceased[x]

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient shr-core-Patient
... shr-core-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... valueCodeableConcept Binding: ActiveOrInactiveVS (required)
... active 0..0
... name HumanName
... deceased[x] S
... address
.... postalCode S

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*shr-core-Patient
... 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
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension S0..1?? [CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-race]]URL: http://fhir.org/guides/argonaut/StructureDefinition/argo-race
... extension S0..1?? [CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity]]URL: http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity
... extension S0..1?? [CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex]]URL: http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex
... shr-core-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: ActiveOrInactiveVS (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierAn identifier for this patient
... name S1..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender S1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S0..1dateThe date of birth for the individual
... deceased[x] ?!SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.

Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (can be ISO 3166 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: http://fhir.org/guides/argonaut/ValueSet/languages (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

Summary

Must-Support: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Patient maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-patient:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  constrain active to 0..0
  Status maps to extension
  Person.HumanName maps to name
  Person.AdministrativeGender maps to gender
  Person.PhotographicImage maps to photo
  Person.Address maps to address
  Person.ContactPoint maps to telecom
  Person.Communication.Language maps to communication.language
  Person.Communication.Preferred maps to communication.preferred
  Person.DateOfBirth maps to birthDate
  Person.MaritalStatus maps to maritalStatus
  Person.MultipleBirth maps to multipleBirth[x]
  Person.BirthSex maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex
  Person.Race maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-race
  Person.Ethnicity maps to http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity
  Person.Deceased maps to deceased[x]

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient shr-core-Patient
... shr-core-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... valueCodeableConcept Binding: ActiveOrInactiveVS (required)
... active 0..0
... name HumanName
... deceased[x] S
... address
.... postalCode S

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*shr-core-Patient
... 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
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension S0..1?? [CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-race]]URL: http://fhir.org/guides/argonaut/StructureDefinition/argo-race
... extension S0..1?? [CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity]]URL: http://fhir.org/guides/argonaut/StructureDefinition/argo-ethnicity
... extension S0..1?? [CanonicalType[http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex]]URL: http://fhir.org/guides/argonaut/StructureDefinition/argo-birthsex
... shr-core-Status-extension 0..1CodeableConceptStatus
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Status-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: ActiveOrInactiveVS (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..*IdentifierAn identifier for this patient
... name S1..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender S1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S0..1dateThe date of birth for the individual
... deceased[x] ?!SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.

Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (can be ISO 3166 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible)
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: http://fhir.org/guides/argonaut/ValueSet/languages (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
Patient.genderrequiredAdministrativeGender
Patient.communication.languagerequiredhttp://fhir.org/guides/argonaut/ValueSet/languages

 

Constraints

IdPathDetailsRequirements
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
: