HL7中国FHIR Connectathon测试实施指南
2024.5.5 - release

本指南适用于HL7中国的FHIR Connectathon测试。

Resource Profile: 患者信息结构定义

Defining URL:http://hl7.org.cn/fhir/StructureDefinition/core-patient
Version:2024.5.5
Name:CorePatient
Title:患者信息结构定义
Status:Active as of 2024-05-05 21:11:47+0800
Definition:

患者资源本地化定义。

Publisher:HL7中国. HL7中国,
Source Resource:XML / JSON / Turtle

本定义的正式URL为: 

http://hl7.org.cn/fhir/StructureDefinition/core-patient

定义内容的视图

关于定义、差异、快照以及如何解读这些表示法。

这种结构源自 Patient

Summary

Mandatory: 10 elements (1 nested mandatory element)
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

这种结构源自 Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... EthnicGroup 0..1Coding民族
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-ethnicGroup
Binding: 民族类别代码表 (required)
... Slices for identifier 2..*Identifier患者业务标识符。例如：身份证、健康卡、社保卡等
Slice: Unordered, Open by value:system
.... identifier:IDC S1..1Identifier身份证
..... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.1
.... identifier:SIN S1..1Identifier社保卡
..... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.2
... name 1..*HumanName患者名称
... telecom 0..*ContactPoint患者的联系方式
... gender 1..1codemale | female | other | unknown
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Gender 1..1Coding国标性别代码
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-gender
Binding: 生理性别代码表 (required)
... birthDate 1..1date患者的出生日期
... address 0..*Address患者的地址
... maritalStatus 0..1CodeableConcept婚姻状态
Binding: 婚姻状况代码表 (required)
... contact 0..*BackboneElement患者的联系人
.... relationship 0..*CodeableConcept患者与联系人之间的关系
Binding: 家庭关系代码表 (required)
.... name 1..1HumanName联系人的姓名
.... telecom 0..*ContactPoint联系人的联系方式
.... address 0..1Address联系人的地址
... link 0..*BackboneElement连接到另一个患者资源
.... other 1..1Reference(Patient | RelatedPerson)指向其它患者资源的引用
.... type 1..1code连接的类型

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... EthnicGroup 0..1Coding民族
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-ethnicGroup
Binding: 民族类别代码表 (required)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ2..*Identifier患者业务标识符。例如：身份证、健康卡、社保卡等
Slice: Unordered, Open by value:system
.... identifier:IDC SΣ1..1Identifier身份证
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.1
..... value ΣC0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SIN SΣ1..1Identifier社保卡
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.2
..... value ΣC0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ1..1boolean患者状态，默认取值为true。
... name Σ1..*HumanName患者名称
... telecom Σ0..*ContactPoint患者的联系方式
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Gender 1..1Coding国标性别代码
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-gender
Binding: 生理性别代码表 (required)
.... value 0..1codePrimitive value for code
... birthDate Σ1..1date患者的出生日期
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*Address患者的地址
... maritalStatus 0..1CodeableConcept婚姻状态
Binding: 婚姻状况代码表 (required)
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElement患者的联系人
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConcept患者与联系人之间的关系
Binding: 家庭关系代码表 (required)
.... name C1..1HumanName联系人的姓名
.... telecom C0..*ContactPoint联系人的联系方式
.... address C0..1Address联系人的地址
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..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 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElement连接到另一个患者资源
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)指向其它患者资源的引用
.... type Σ1..1code连接的类型
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... identifier:IDC Σ1..1Identifier身份证
... identifier:SIN Σ1..1Identifier社保卡

doco Documentation for this format

这种结构源自 Patient

Summary

Mandatory: 10 elements (1 nested mandatory element)
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

差异视图

这种结构源自 Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... EthnicGroup 0..1Coding民族
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-ethnicGroup
Binding: 民族类别代码表 (required)
... Slices for identifier 2..*Identifier患者业务标识符。例如：身份证、健康卡、社保卡等
Slice: Unordered, Open by value:system
.... identifier:IDC S1..1Identifier身份证
..... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.1
.... identifier:SIN S1..1Identifier社保卡
..... system 1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.2
... name 1..*HumanName患者名称
... telecom 0..*ContactPoint患者的联系方式
... gender 1..1codemale | female | other | unknown
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Gender 1..1Coding国标性别代码
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-gender
Binding: 生理性别代码表 (required)
... birthDate 1..1date患者的出生日期
... address 0..*Address患者的地址
... maritalStatus 0..1CodeableConcept婚姻状态
Binding: 婚姻状况代码表 (required)
... contact 0..*BackboneElement患者的联系人
.... relationship 0..*CodeableConcept患者与联系人之间的关系
Binding: 家庭关系代码表 (required)
.... name 1..1HumanName联系人的姓名
.... telecom 0..*ContactPoint联系人的联系方式
.... address 0..1Address联系人的地址
... link 0..*BackboneElement连接到另一个患者资源
.... other 1..1Reference(Patient | RelatedPerson)指向其它患者资源的引用
.... type 1..1code连接的类型

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... EthnicGroup 0..1Coding民族
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-ethnicGroup
Binding: 民族类别代码表 (required)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ2..*Identifier患者业务标识符。例如：身份证、健康卡、社保卡等
Slice: Unordered, Open by value:system
.... identifier:IDC SΣ1..1Identifier身份证
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.1
..... value ΣC0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SIN SΣ1..1Identifier社保卡
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Required Pattern: urn:oid:2.16.840.1.113883.2.23.1.19.2
..... value ΣC0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ1..1boolean患者状态，默认取值为true。
... name Σ1..*HumanName患者名称
... telecom Σ0..*ContactPoint患者的联系方式
... gender Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... Gender 1..1Coding国标性别代码
URL: http://hl7.org.cn/fhir/StructureDefinition/ext-person-gender
Binding: 生理性别代码表 (required)
.... value 0..1codePrimitive value for code
... birthDate Σ1..1date患者的出生日期
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*Address患者的地址
... maritalStatus 0..1CodeableConcept婚姻状态
Binding: 婚姻状况代码表 (required)
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElement患者的联系人
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConcept患者与联系人之间的关系
Binding: 家庭关系代码表 (required)
.... name C1..1HumanName联系人的姓名
.... telecom C0..*ContactPoint联系人的联系方式
.... address C0..1Address联系人的地址
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..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 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElement连接到另一个患者资源
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)指向其它患者资源的引用
.... type Σ1..1code连接的类型
Binding: LinkType (required): The type of link between this patient resource and another Patient resource, or Patient/RelatedPerson when using the seealso code


doco Documentation for this format

 

本定义的其它表示法: Schematron

Terminology Bindings

PathConformanceValueSetURI
Patient.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.identifier:IDC.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:IDC.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.identifier:SIN.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Patient.identifier:SIN.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.maritalStatusrequiredGB2261_2 (a valid code from 婚姻状况代码表)
http://hl7.org.cn/fhir/ValueSet/gb2261-2
from this IG
Patient.contact.relationshiprequiredGB4761 (a valid code from 家庭关系代码表)
http://hl7.org.cn/fhir/ValueSet/gb4761
from this IG
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0
from the FHIR Standard
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf 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-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
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()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()